Authentication Token

Authentication

All transactions are authenticated using a Bearer token generated through the OAuth 2.0 protocol. To obtain a token, clients must send a request to the authentication endpoint using their client_id and client_secret (click here to see how to generate your credentials). To authenticate this request, you must pass the Base64-encoded string of client_id:client_secret in the Authorization header. The generated access token must be included in the Authorization header of each API request, ensuring secure and controlled access to the API.

Usage

Once the token is obtained, include it in the Authorization header of your API requests as follows:
Authorization: Bearer {access_token}

Token Expiration & Renewal
- The token is valid for the duration specified in expires_in (usually 3599 seconds or ~1 hour).
- When the token expires, you must request a new one using the same authentication process.

v20250823.0859

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200

application/json

Access token generated successfully.

Bodyapplication/json

示例

{
    "access_token": "ZmVhLTQwMjctNGQxNS1iNWQwLTFjOWYwMmIzMGE3ZC00MjQ0NSIsInN1Ym5hbWUiOiJzYnhfOWYzNDNlYzMtNzM2Mi00ZjZiLTk3ZTItMjNjYWIyMDUzYjc0IiwiaXNzIjoiaHR0cHM6Ly9hcGkucHJlLmdsb2JhbGdldG5ldC5jb20vb2F1dGgyL3NhbmRib3giLCJ0b2tlbk5hbWUiOiJhY2Nlc3NfdG9rZW4iLCJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiYXV0aEdyYW50SWQiOiIycUVETGtvR3Jjdzh2eE13WThtUmxIemF0SEkiLCJhdWQiOiJzYnhfOWYzNDNlYzMtNzM2Mi00ZjZiLTk3ZTItMjNjYWIyMDUzYjc0IiwibmJmIjoxNzU1MDk1MDc1LCJncmFudF90eXBlIjoiY2xpZW50X2NyZWRlbnRpYWxzIiwic2NvcGUiOlsiZGlnaXRhbC1wbGF0Zm9ybS1zYng6Z2F0ZXdheS1hcGkiXSwiYXV0aF90aW1lIjoxNzU1MDk1MDc1LCJyZWFsbSI6Ii9zYW5kYm94IiwiZXhwIjoxNzU1MDk4Njc1LCJpYXQiOjE3NTUwOTUwNzUsImV4cGlyZXNfaW4iOjM2MDAsImp0aSI6ImlQT0pMZlBqbUhKWXg4SzBWSnlwVE5kZEoybyIsImNvdW50cnkiOiJDTCIsInNlbGxlcklkIjoiNTRmODhlNjgtNzc2NC00ZTg3LTg4MzAtNzU2YjFlMmMwMmY4IiwibWVyY2hhbnRJZCI6IjM2YjExMmE4LTllNTQtNDE2NS04Mzg3LTg2ZGRhMWYyNDQzNyIsIm5hbWUiOiJIZWl0b3IgVGVzc2FybyIsImRlc2NyaXB0aW9uIjoiVGVzc2FybyIsInVzZXJOYW1lIjoidml0b3Jjb21wOTUrdHJhYmFsaG9AZ21haWwuY29tIiwidGVuYW50IjoiU2FudGFuZGVyIn0.BxMYBiGHWU8r2pzD_GFFjXI3EduBrJdkxSo6aF-726_s3VWa0UH2QDQy5aVsrbF8spS0M7l6T6tsNVk-vt5jkAtIpUv1exNKk4VbPk_TXn9fVHJKEqZh_6xPHNKtmaF85uOpS2Rgnv9rulKHHWXLG3GTElqeiXBX0z5fSAWiCuFRrgIWUYib_ifXwMpu8r-J9c088ltdQrwvltjs5UskTycSR62-UPIQV2a1qXG30rddTA5eHm5EAGvpDNc9LqyrgKvG4SEkf0l0aLv-fpKJuqQk6CKGtEV6DQ92bK5OwJdTY07WZBsVtLPf_fgl4LYa5RWz-9qNE0ZUzQIcH-O4-A",
    "scope": "digital-platform:gateway-api",
    "token_type": "Bearer",
    "expires_in": 3599
}

🟠401

请求参数

请求示例代码

返回响应