User Manual & Precautions
Call Methods
- API URL
- https://
{API_Address}
/apiRequest.do
- https://
- JDB will provide the HTTP URI in the "JDB API Environment Setting.pdf" document for Operator's use.
- HTTP Call Example
POST /apiRequest.do HTTP/1.1 Host: {API_Address} Content-Type: application/json { "dc": "your domain", "x": "yWBxl0rtQ872ouQWz34cdNTX_QTW5Dm4_RmABEIkdJq_dljffhH0fMEoSNIRejPWBWkO09mq3FzdFmavh7E0kw", "parent": "if you have own iv, key different from your parent" }
- HTTP Body Parameters Explanation
Parameter | Value |
---|---|
dc | Customer Domain Name |
x | 1. Refer to Chapter Functions to decide the function to call up |
2. Convert the parameters required according to the function into JSON String | |
3. Encrypt this JSON String with AES-CBC-128 bit then using Base64 URL encode. | |
4. For encrypt steps, please refer to the Sample Codes . | |
parent | This is not needed by default, contact JDB service if needed. |
Encrypt with independent iv, key, and call API with this parameter which content is parent's accouont you provided when setting. |
Connection Description
- For the information about API address and encryption keys, please refer to "JDB API Environment Setting.pdf".
- To use this system, customers should provide the IP of the connected server.
Return Format
- JSON format only
HTTP Compression
: User can choose whether to compress the return messages. If compression is needed, “Accept-Encoding”:gzip setting should be added to the header of “Http Request”.
AES Encryption Notes
- Encrypted data is valid for 30 seconds. The data will expire if it is not sent in 30
seconds.
If the data expired, you will receive an error code of 9005. Please correct the system time.
- The AES encryption process is a conversion supporting by fixed block size; therefore, in order to complete encryption successfully, the size of the data must be rounded up to a multiple of 16 bytes. If the size is insufficient, please fill up with blank space to the right.