Open API – Get Started

bg-line

Get Started

Introduction

On this site, you can learn how to use the API to access and manage your data, starting with user authentication.

The first thing you need to do to use the Open API is to generate a secret key.

oa-keyinfo-2
You can generate a secret key from the ETC menu on the left side of the Admin Tool.

This key is very important for security and should never be made public. If you accidentally disclose your secret key, regenerate it immediately.

Sending requests using “Secret Key”

All Open APIs are formatted as shown below and must include a secret key.

Request Address

The table below provides information about the test environment.

Server Addresshttp://35.223.63.239:12000/
IDcpapi
Password**********
Agent-Id1000
SecretKeyThis key is available after the contract is finalized.

Request Type

Request MethodPOST
Request Body SchemaJSON

Request Headers

Authorizationbearer Sha256({secretKey}.{bodyJson}).ToBase64()
ex) bearer B4S78sRSqYIpGg1lS0KuvyhWmHpyl7JWrdeF1zumd1o=
Content-Typeapplication/json
Agent-IdValue
ex) 1001

Example code

oa-auth

The response for all APIs is shown below.

{
    "status":0,  // 0 : suceed, 1: failed
    "code":0,    // error code
    "message":"" // error message
}