What is it?
An API (Application Programming Interface) is an interface that allows two applications to communicate with each other. This is done by sending requests to another system or service, after which a response is received with the required data or confirmation of an action performed. An API establishes clear rules for how these requests should be made, what data is required, and how the responses should be returned.
APIs are available for Paragin products that allow you to automate certain processes, such as adding participants and users, retrieving test results, or managing user groups. These APIs are free to use, and documentation is available, so you can get started with the implementation yourself.
How do you implement an API?
To implement an API, it's important to first create a design that determines which data needs to be exchanged between which systems. Then, a developer must set up the API endpoints, implement the necessary logic, and integrate them into their own applications.
When integrating a REST API, basic knowledge of HTTP methods (such as GET and POST), status codes, and JSON is essential, as this is the format used for data exchange. Tools like Postman (for testing API requests) and cURL (for command-line requests) are helpful, as is knowledge of API authentication (for example, with API keys). The process involves reading the API documentation, testing endpoints, writing code to send requests, processing responses, and troubleshooting any issues. Consuming an API and automating data processing is typically handled by a software developer.
How do I set up the API for an environment?
Depending on the set permissions in an environment, you can add an API link to the environment yourself.
- In Remindo you can do this in the administration environment via the menu Settings -> Manage general settings, tab API or in the purchase environment via the menu Administration -> Settings, tab API.
- In MyPortfolio, this can be done via the menu button Settings -> API (oauth). At these locations, API documentation and sample code can also be downloaded.
Don't see these menu options, but want to set up an API? If so, first contact an administrator of this particular environment. If that fails, submit a ticket and mention in which environment you want to set up the API.
Note!
If it concerns an environment that is delivered through an Exam supplier, please contact the Exam supplier in question to discuss the possibilities.
After an API connection has been added to the environment, the organization itself can start implementing our API. We do not guide this implementation, someone with sufficient technical knowledge should be able to establish this link using our documentation.
Should there be any questions about the documentation and/or functionalities, these can of course be addressed through submitting a ticket.
Disclaimer: This text was automatically translated from the Dutch version.