Sha256: 8c0eb29f44e2a8c849e8243dc5c3971cb85794551c4bf0dd8b47c0c2a12037c6
Contents?: true
Size: 1.95 KB
Versions: 8
Compression:
Stored size: 1.95 KB
Contents
# Copyleaks Ruby SDK Copyleaks SDK is a simple framework that allows you to scan text for plagiarism and detect content distribution online, using the Copyleaks plagiarism checker cloud. Using Copyleaks SDK you can check for plagiarism in: * Online content and webpages * Local and cloud files (see [supported files](https://api.copyleaks.com/documentation/specifications#2-supported-file-types)) * Free text * OCR (Optical Character Recognition) - scanning pictures with textual content (see [supported files](https://api.copyleaks.com/documentation/specifications#6-supported-image-types-ocr)) ## Installation Install using [RubyGems](https://rubygems.org/gems/plagiarism-checker) ```bash gem install plagiarism-checker ``` ## Register and Get Your API Key To use the Copyleaks API you need to first be a registered user. The registration to Copyleaks takes a minute and is free of charge. [Signup](https://api.copyleaks.com/?register=true) and make sure to confirm your account. As a signed user you can generate your personal API key. Do so on your [dashboard home](https://api.copyleaks.com/dashboard) under 'API Access Credentials'. For more information check out our [API guide](https://api.copyleaks.com/documentation/v3). ## Usage ```rb require 'copyleaks' copyleaks = Copyleaks::API.new res = copyleaks.login(<your email>,<your api key>) puts res.to_json ``` * (Option) To change the Identity server URI (default:"https://id.copyleaks.com"): ```rb Copyleaks::Config.identity_server_uri = "<your identity server uri>" ``` * (Option) To change the API server URI (default:"https://api.copyleaks.com"): ```rb Copyleaks::Config.api_server_uri = "<your api server uri>" ``` ## Demo See [demo.rb](./demo/demo.rb) under demo folder for an example. ## Read More * [API Homepage](https://api.copyleaks.com/) * [API Documentation](https://api.copyleaks.com/documentation) * [Plagiarism Report](https://github.com/Copyleaks/plagiarism-report)
Version data entries
8 entries across 8 versions & 1 rubygems