Get started
Welcome to our API documentation. This guide shows you how to connect to our API endpoints. We suggest you review this documentation carefully and reach out if you need help. contact
Important terminology
Before you begin, make sure you understand these key terms.
Basic definitions
| Title | Value | Remarks |
|---|---|---|
| API Access URL | [YOUR-SITE-URL]/mobile_api/[ENDPOINT_TYPE] | The URL used to access our API. Use the format shown in this example: https://komico.edubrazeal.com/mobile_api/login |
| Auth token | https://komico.edubrazeal.com/mobile_api?session_id=[YOUR-SESSION-ID] | Many user actions need authorization. Examples include liking content or checking if a user follows a profile. We recommend sending the user's session ID in your request when the user is logged in. |
| API Access key | https://komico.edubrazeal.com/mobile_api?api_key=[YOUR-API-KEY] | Every installation has its own unique API key. This key is required to access the API. |
| Response data type | {...} | All responses from the server are returned in JSON format. |