API Preparation¶
To integrate with our API, you'll need to prepare the following credentials and configurations. width: default title: visible: true description: visible: true tableOfContents: visible: true outline: visible: true pagination: visible: true metadata: visible: true tags: visible: true actions: visible: true
Account Setup¶
Your company needs to provide a fixed IP address and an email address to our custody team for the creation of your test account.
API Credentials¶
The custody team will provide you with the following essential credentials:
| Credential | Description | Usage & Notes |
|---|---|---|
| ukey | A type of hardware authentication device. The ukey will be bound to your user account during the setup process. | Used for operations such as login and order approval. How to obtain:
|
| apikey | Used to authenticate and access our API interfaces. | This is your API key for API calls. |
| akid | Used for signature verification and authentication of your API requests. | How to obtain: 1. Log in as Administrator on our webpage. 2. Click on the Users Management Tab. 3. Click on the ≡ and select the option API PUBLIC KEY . 4. Upload your generated public key file in PEM format. Click to see the steps to generate your public key file. 5. The corresponding user will receive the akid via email. |
| wallet_code | Wallet ID: Unique identifier for your wallet. | Config Path: Administrator Login → Business Lines Management → Configuration. Only Administrators can apply for and configure wallets. |
| b_id | Business Line ID: Identifies your business line within our system. | Retrieval Path: Administrator Login → Business Lines Management. |
Network Configuration¶
IP whitelisting¶
For security purposes, only whitelisted IP addresses can access our test system.
- Requirement: A fixed public IP address is required.
- Alternative: If a fixed IP is not available, a proxy can be used to access the system.
- Check your IP: You can verify your current public IP address by visiting https://checkip.amazonaws.com/.
Callback Configuration¶
Callback URL¶
The callback_url is used for receiving notifications regarding deposit and withdrawal transactions.
- Configuration: You must upload your callback_url through our page.
- Configuration Path: Administrator Login > Business Lines Management > Manage API > Insert Callback URL.