Get started
Welcome to the ColibriSM API. This guide will help you use our API to access ColibriSM API endpoints, therefore, we recommend that you use this particular documentation and contact us for assistance in case of unclear questions. vayart.help@gmail.com
Important terminology
Please understand the terminology of our API before you start using it.
Basic definitions
| Title | Value | Remarks |
|---|---|---|
| API Access URL | [YOUR-SITE-URL]/mobile_api/[ENDPOINT_TYPE] | URL address for access to API Must be as shown in the example. E.g. https://venuzswing.com/s/mobile_api/login |
| Auth token | https://venuzswing.com/s/mobile_api?session_id=[YOUR-SESSION-ID] | Most of the user's actions require his authorization, for example, like, or determine whether the user follows some kind of profile, etc. Therefore, we recommend that you always send a user's session on a get request if the user is logged in. |
| API Access key | https://venuzswing.com/s/mobile_api?api_key=[YOUR-API-KEY] | To access the API, the most important point is a unique API key that is specific to each instance of this script. |
| Response data type | {...} | The server response to your API request will be in JSON format |