...
In this course, we will deal mostly with this use case. Other use cases can be found in full documentation to this API ( https://data.aliveplatform.com/download/API/Individual-Online-Orders-API-Integration-Manual.pdf).
📦 WORKFLOW
Introduction When talking about APIs, terms „request“ and „response“ will be frequently used. A request is usually triggered through a customer’s action. The „response“ is the answer from the server. In our example, in the mobile app created by TestPartner, when a customer fills in all his personal data into a form and confirms the form, the request POST /cardOrders is triggered. If everyting in OK, the response confirming that the card order was created will be sent back to the app. Following examples will be shown in software Insomnia for API’s testing. Within this software, you can simulate the requests and responses. For test purpose, any other REST client can be used. In all cases, we are going to test the API against test environment of the ALIVE Platform (with URL https://cz-online.test.aliveplatform.com/api/1.0). Note: To find out all possible values for API variables, feel free to use Swagger documentation, which can be found at https://cz-online.test.aliveplatform.com/api/1.0/doc. 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. Settings for Online Ordering Affiliate Partner and its User in NCDB As a first step, Online Ordering Affiliate Partner TestPartner from our usecase has to be set up in NCDB.
...