Using the platform APIs to extract information

Using the platform APIs to extract information An API, or Application Programming Interface, is a program that allows two separate applications to communicate with each other and exchange data. Our APIs are here to bridge the gap between your existing data in the platform and any third-party application of your choice capable of receiving that data. Our APIs are private (enterprise APIs). They are secured and have an identification key (access_token), provided by an authentication and authorization service (oauth/token). Our communication protocol is based on REST (Representational State Transfer) in order to be compatible with various mobile platforms, whether it is a Windows, Apple, or Android application. We recommend using the POSTMAN interface if you wish to test the formulation of your requests to the APIs.

The data you can extract via GET CATEGORIES

• list of categories
• category details PRODUCTS
• list of products
• product details CUSTOMERS
• list of customers
• customer details by ID
• customer details by email POINTS OF SALE
• list of points of sale
• details of a point of sale by ID
• location details by point of sale ID
• stock details by point of sale ID
• transaction details by point of sale ID LOCATIONS
• list of locations
• location details EXPORTS
• export of in-store payments
• export of online payments The data you can inject via POST
• create a customer
• create a location

Generate your token in Outils

Clés API Click on Créer des identifiants. Choose the name to associate with your credentials, and click SAUVEGARDER at the bottom right. Your client ID and your secret key will be automatically generated by the platform. A green notification is displayed in the top right corner of the window when your keys have been successfully created. Copy your client ID and your secret key — you will need them in step 6, as this pair of credentials constitutes your token. Accessing your platform's APIs For security reasons, access to the API documentation is not possible from the back office. If you need to use the Rental API documentation, please open a support ticket in order to request your access.

Once you have access to your API documentation, configure your access_token via /openapi/V1/ Click on the "AUTHORIZE" button. And paste the token obtained into the global authorization pop-in that appears. Replace the pre-filled client_ID and client_secret with the keys generated in step 4. You are now logged in and your token will be automatically sent to authorize each of your calls.

Example of a call to the list of categories Open the GET/categories menu by clicking on the arrow at the far right, then click EXECUTE. The response from the Category List API is displayed below. You can if needed download the server response in JSON format. At the bottom of the response, click DOWNLOAD to download the file.

Response formats You will find details of the response formats, and in particular any error responses, at the bottom of the documentation under "SCHEMAS". If you wish to use Postman in parallel, also authenticate in your application with the same access token. Option 1: Authenticate with a bearer token in the header. And finally test the call. For example, for the list of categories. Please note: a limit of one call per second is in place in order to avoid server overloads.

When adding your API, you can see its expiration date.