Introduction to Testinvite's API

API is the acronym for Application Programming Interface, which is a software intermediary that allows two applications to talk to each other.

Testinvite provides an API so that other applications can communicate with Testinvite.

In order to consume Testinvite's API, there needs to be another application that knows how to communicate with the Testinvite's API. That's why we offer detailed documentation about how our API works. If you are a developer, you can read the documentation and start writing a custom application that consumes Testinvite's API and automate some tasks.

Below are some of the basic questions & answers to make it more clear:

Is API for me?

If you are a developer, or you have a developer in your team and you want to integrate one of your applications with Testinvite, the API service is for you. If there is not any developer on your team, the API will not help you.

What are some common use cases?

• You have a custom website and you can develop custom code in your backend.
• You use an Applicant Tracking System (ATS) for recruitment and you can customize the backend.
• You use a Learning Management System (LMS) and you can customize the backend.

Which accounts can use the API?

All accounts can enable the API service. 

How much does enabling the API service cost?

The API service can be activated for free for 2 months. In this trial period, you have access to the API hence you can develop your custom code and ensure that API will work for your use case. After the free trial, you can continue using the API service for $950 per year.

If you have a subscription with Testinvite, API service is included in Advanced plans and higher. For lower tier subscribers, API service can be purchased as an add-on.

What are the main services offered through the API?

The API makes it possible to administer an assessment process without using the Testinvite web interface. Actions you can do with the API include:

• Creating and inviting test-takers into one of your Tasks so that they can get access to your Tests inside your Task.
• Fetching the results of the tests that have been terminated.
• Fetching the proctoring materials of a test session. The proctoring materials can be photos and videos that have been recorded during the test session.

Besides the services mentioned above, you can set up Webhooks to receive information when specific actions occur. For instance, by registering for the Test Results Webhook, the Testinvite system will automatically send test results to your system whenever a test session is completed.