Introduction
Purpose
It covers the API interfaces’ capabilities, usage, and implementation details to ensure a seamless integration process for:
Document Scope
It includes details on:
Glossary of Terms
Abbreviation
| Abbreviation | Full Term | Description |
|---|---|---|
| M | Mandatory | The parameter must be provided in every request. |
| C | Conditional | The parameter is needed only if certain conditions are met. |
| O | Optional | The parameter can be provided, but it's not necessary. |
Terminologies
| Term | Description |
|---|---|
| appId | Globally unique product ID, representing the product authorized to the client. It is used to obtain the client’s public key and restrict operations. |
| Redirect URL | The URL where the response from an API request will be sent. |
| Encryption | The process of converting data into a coded format to prevent unauthorized access. In this document, it refers to the encryption of API request data. |
| Decryption | The process of converting encrypted data back into its original format. In this document, it refers to the decryption of API response data. |
| Endpoint | A specific URL where an API can be accessed by a client application to perform operations. |
| Sandbox Environment | A testing environment that mimics the production environment, allowing developers to simulate API calls without affecting real-world data. |
| Production Environment | The live environment where the API is available for real-world use, with real data and operational systems. |
| API Version | Indicates the version of the API being used, allowing for version control and backward compatibility. |
| requestData | The data sent by the client to the server when making an API call. |
| responseData | The data returned by the server to the client in response to an API call. |
Modified at 2025-09-09 08:00:09