How can we help?

Home > Turnitin Core API v0.1 Beta Program Overview

Turnitin Core API v0.1 Beta Program Overview

 

bluecog.png The Turnitin Core API has been developed around supporting more flexible options for integrating Turnitin-powered services and applications into other platforms.


Who is the beta program best suited to?

 

 ►

Education technology providers

 ►

Manuscript tracking systems

 ►

Providers who develop software that supports the review and assessment of student work and whose customers require a similarity check/plagiarism review solution

 ►

Providers who also already have customers with whom Turnitin has an existing relationship

 ►

Providers for whom a strategic partnership would make mutual business sense

Calendar_Teal.png The Turnitin Core API beta program will commence in late Q4 of 2017 and run until Q3 of 2018.


What does the Turnitin Core API offer?

 

The Turnitin Core API supports the generation of Turnitin Similarity Reports for submitted documents. Turnitin Similarity Reports are generated using a proprietary algorithm to find and present information on matches to content from a variety of sources; these sources include the Internet, published works, open source repositories, and submitted works.

 

Turnitin’s powerful API allows partners to easily implement similarity checking within their application so that partners can provide more value to their users.

 

What can partners do?

 

 ►

Connect to Turnitin and submit documents

 ►

Configure Similarity Report settings

 ►

Generate Similarity Reports

 ►

View Similarity Report results in the Turnitin document viewer 


Quick steps to getting started

1

Register your customers

 

Partners must set up Turnitin accounts for each mutual customer. You can request accounts to be created for each customer by filling in a customer registration form. You must also request a specific URL on behalf of the customer.

 

Partners must specify the main partner administrator who will have access to each customer’s account for integration setup.

2

Access your environment 

 

After approval, Turnitin will grant you access to a sandbox testing environment. Once development is complete, you'll then gain access to a production environment; partners cannot connect live data until the application is certified by Turnitin. 

 

Sandbox is almost identical to our production environment; however, the data in the environment is not in real time. The sandbox environment should be used to test the integration and allow you to familiarize yourself with Turnitin. 

Your sandbox account is not linked to your production account, and the data in your sandbox, including integration scopes and API keys, will not be automatically transferred to your production account.

3

Create authentication credentials

 

Once you have registered a customer, the partner administrator specified in the form will receive a welcome email. From this welcome email, the partner administrator should select the ‘set up your account’ button to create authentication credentials for the customer’s Turnitin console. 

 

As each customer account is completely separate, the partner administrator may use the same authentication credentials across multiple customer accounts; this will make the integration setup process across multiple customer accounts as smooth as possible.

4

Set up your integration

 

Use your authentication credentials to log in to your customer’s Turnitin console, then select ‘Integrations’ from the left-hand sidebar to move to the integration console.

 

Start setting up your integration by creating an integration scope and API key for your application.


An integration allows Turnitin to identify requests from a particular integration. Integration scopes can be created from the integration setup screen and should have a descriptive and unique name per scope. After creating an integration, you’ll be prompted to add an API key.

If you have multiple versions of your application, we recommend you include the version number in the integration scope name.

5

Add an API key

 

API keys allow Turnitin to identify the origin of a request and the permissions that are tied to each key. API keys can be generated within the context of an integration scope from the integration setup screen.

 

You can specify a descriptive and unique short name per API Key, which will help you to remember the purpose of the key.  When creating an API key, the API client will compute an API key for you which you can directly copy from the integration setup screen and use.

API keys contain sensitive data and should not be shared openly. If you have any reason to believe that one or more of your API keys have been compromised, you can disable your API key from your integration scope’s API keys list; this will immediately revoke the old key and any calls using the old key will no longer work. 
 

Coming soon

 

API keys will allow you to monitor your application’s API usage in the Turnitin integration console.

 

Last modified

Tags

This page has no custom tags.

Classifications

(not set)