This documentation serves as a guide for client systems integrating with the API. For details on accessible endpoints, please refer to the External section.Before using the endpoints, please ensure you have obtained your public and private keys from our support team.
Server#
| Environment | Base URL |
|---|
| Staging | - |
| Production | - |
General Request#
x-app-key#
| Request On | Mandatory | Type | Default |
|---|
| Header | Yes | String | |
x-app-key refers to the public key provided to you, and is used to identify the client system initiating the API request.x-request-id#
| Request On | Mandatory | Type | Default |
|---|
| Header | Yes | String | |
As the identity of each API request. The value should be unique.x-language#
| Request On | Mandatory | Type | Default |
|---|
| Header | No | String | id |
The language used in the messages received in the API response will be based in the value of x-language.| Value | Desc |
|---|
| id | Bahasa Indonesia |
| en | English |
x-user-token#
| Request On | Mandatory | Type | Default |
|---|
| Header | Conditional | String | |
x-user-token is issued upon successful user authentication. Include this token in requests to endpoints that access data specific to the authenticated user.Authorization#
| Request On | Mandatory | Type | Default |
|---|
| Header | Yes | Bearer | |
Authorization Header DescriptionThe Authorization header is used to securely transmit the necessary credentials for authenticating API requests using the Bearer token scheme. The standard format is:Authorization: Bearer <token>Depending on the operation, the token used varies:Access Token: Use the access token (obtained after a successful authentication) to authenticate regular API requests.
Example: Authorization: Bearer <access_token>
New Access Token Request: To obtain a new access token, provide the refresh token in the Bearer format.
Example: Authorization: Bearer <refresh_token>
New Refresh Token Request: To request a new refresh token, include the x-user-token in the Bearer format.
Example: Authorization: Bearer <x-user-token>
This clear distinction ensures that the appropriate token is utilized for each respective operation during the authentication and token renewal processes.