Prerequisite
Environment Setup
Domain Access
For general usage, whether in development, testing, user acceptance testing (UAT), or production stages, please utilize the same domain:
To distinguish between different stages, we will provide different APPID and APPSECRET pairs.
Retrieve OpenAPI App Information
To initiate your integration, kindly reach out to your designated Customer Success Manager (CSM) to obtain the necessary OpenAPI app information. i.e. That's APPID and APPSECRET pair.
APPID and APPSECRET serve as the exclusive and unique credentials for interacting with the OpenAPI system. It is crucial to maintain their confidentiality and refrain from disclosing them to third parties.
Additionally, ensure that APPSECRET is securely stored exclusively on the server side and is not retained on the app side.
Signature and Authentication
For detailed information on API signature and authentication, please refer to the documents in the authentication section.
Samples for OpenAPI Clients
To expedite your development for integration, we offer sample codes written in several popular programming languages. For more details, please refer to the Sample Codes section.
Limits and Quotas
Typically, we enforce diverse API request limits and quotas tailored to different clients and contracts. Generally, the maximum limit for each API is set at 5 QPS. For more detailed information, please feel free to reach out to us.
API availability
This document outlines the general APIs offered by Clobotics Retail Cloud. However, please be aware that not all documents mentioned in the OpenAPI section on this site may be accessible to you. The availability of APIs in your OpenAPI application may vary based on different contracts and scenarios.