Overview

Welcome to the Glossary!

Please read the following to understand the ADVANCE API system, for a smooth integration. We will explain all the basics you need to know about our API.

Status Code

Our API responses will contain a Status Code indicating the result of the API call, whether it was successful, or an error occurred during the process
Each API will also have its own unique Status Codes that can only be found in the responses of the API
Your API usage will be charged based on the response Status Code. Each Status Code listed in our API document will have either a free or pay tag with it
free means you will not be charged and pay means that you will be charged
pay means you will be charged if the API response contains the said status code
Below are the commonly used Status Codes. These status codes could appear in all our API responses, so please remember to add a handler for these Status Codes

Notes:

Please use ‘Status Code’ in your strategy instead of ‘Message’, as 'Message’ is a detailed explanation for developer’s reference and may update without ADVANCE Notice.

Status Code	Message
SUCCESS	`pay` OK
ERROR	`free` Server error
EMPTY_PARAMETER_ERROR	`free` Parameter should not be empty
INSUFFICIENT_BALANCE	`free` Insufficient balance, please top up or contact your sales manager for help
SERVICE_BUSY	`free` Messages may look like: Rate limit is exceeded, please retry after the suggested time in HTTP Header. Retry-After :10s p.s. Please also note that this code may migrate to HTTP 429 Too Many Requests in the future. Quota exceeded: You have exceeded the daily quota for free queries, please contact out tech support for help
IAM_FAILED	`free` Access denied. Messages may look like: You are not authorized by the Identity and Access Management system Access Key not found Token not found or expired Access Key not found or expired Account not authorized for this country Account not authorized for this domain Account is expired. Please contact your sales manager for help Account is disabled. Please contact your sales manager for help Access denied: Token not found or expired
PARAMETER_ERROR	`free` The message is detailed error description, may includes: Parameter should not be empty Invalid phone number, please check your phone number format etc. p.s. Mobile number format should be country code + phone number(without leading 0 or dash or space e.g. +xx12345678); fixed-line number should be country code + area code + number(without leading 0)
OVER_QUERY_LIMIT	`free` Messages may look like: Quota exceeded. you have exceeded free query quota, please contact your sales manager for help Quota exceeded: You have exceeded free query quota for test account, please contact your sales manager for help
CLIENT_ERROR	`free` HTTP client error. Messages may look like: HTTP 400 - Bad Request HTTP 404 - Not Found HTTP 405 - Method Not Allowed etc. If you get this error, please check the API document or contact our tech support for help.
RETRY_LATER	`free` Query failed, please retry after the suggested time in HTTP Header. Retry-After :10s

Notes:

If the Status Code is SUCCESS, it may not be charged. Please check the code returned by each interface

Request URL & Parameters

Request URL can be found at each API document along with the request method (POST or GET or other request method) and Content Type (application/json or other content type)
Some parameters will have optional tags on them. This means the parameter is not mandatory for the request and they can be empty. However, adding them might produce more accurate results. For example : Company check, zip code is an optional parameter, but adding zip code parameter will return all the companies around that said zip code instead of all around Indonesia.
If a parameter does not have an optional tag, it means the parameter is mandatory and making requests without them will return EMPTY_PARAMETER_ERROR response
Every parameter has a data type such as string, integer and file. Please double check the parameter data type before making any request
Here’s an example of parameter explanation that can be found on each API document

Parameter	Description
requestString	`string` String value for API request
requestFile	`file` Request file for API request
requestInteger	integer Number value for API request

Response

ADVANCE API responds in JSON format
ADVANCE API response consists of 4 fields:
- code the Status Code;
- message detailed explanation of the Status Code;
- extra exception message (should be empty most of the time);
- data the response content from ADVANCE;
Each service has its own data format, outlined in the API document
If the response format is very complicated (multiple different JSON objects, nested JSON object), please refer to the Breakdown section of the Response Explanation
transactionId: It is strongly recommended to save the transactionId.
The following is an example of Response Explanation found in each API document:

Parameter	Description
code	API Status Code
message	Status Code Explanation
data	`field1`: explanation of the first information that will be returned from ADVANCE
	`field2`: explanation of the second information that will be returned from ADVANCE
extra	Extra response info (Exception Message)