| Tip |
|---|
COURSE DESCRIPTION This course describes REST API for placing NCDB Orders. This API can be used instead of importing the items of an order through an excel sheet or instead of creating the NCDB Order manually from GUI. You will learn basic specification of the API, which users can access the API and which requests can be sent through it. You will see an use case of the usage of the API. You will understand which main benefits the API can bring to your business. |
...
Let’s have a look at following example: The school wants to integrate the API for NCDB Orders into its information system. Through the API, the school wants to create new card holders and order ISIC cards for them. The photos of the students should be uploaded as well. In the following sections, only this use case will be described in detail. For more possibilities, please have a look into full documentation (https://data.aliveplatform.com/download/API/NCDB-Orders-API-Integration-Manual-[REST2].pdf).
🔎 WORKFLOW
Basic description of the workflow: Through the API, regarding the use case described in previous section, the following steps will be performed: 1/ Create empty Card Order 2/ Create Card Holders 3/ Add photos for Card Holders 4/ Order cards for chosen Card Holders (add order entries into the Card Order) 5/ Finish Card Order Following examples will be shown in software Insomnia for REST API’s testing. Within this software, you can simulate the requests and responses. For test purpose, any other REST client can be also used. In all cases, we are going to test the API against test environment of the ALIVE Platform (with URL https://ncdb.test.aliveplatform.com/rest/2.0).
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
Note: To find out all possible values for API variables, feel free to use Swagger documentation, which can be found at https://ncdb.test.aliveplatform.com/rest/2.0/swagger-ui.html. Within Swagger, you can also play around in an integrated sandbox to test the requests with different variables. Into Swagger, you can log in using your credentials for test environment of the ALIVE Platform. |
...