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.

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

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: