Test Routes

​

Overview

• API authentication
• Request signing
• Replay protection
• Error handling behavior
• JSON body hashing and parsing

​

Authentication

​

GET /v1/test/ping

​

Description

• API connectivity
• Signature correctness
• Authentication configuration

​

Request

GET /v1/test/ping

X-API-Key: <your_api_key>
X-Timestamp: <unix_timestamp>
X-Nonce: <uuid>
X-Signature: v1=<signature>

​

Successful Response

{
  "code": 0,
  "payload": {
    "pong": "ok"
  },
  "error": null,
  "request_id": "req_xxxxx"
}

​

Response Fields

​

Possible Errors

​

GET /v1/test/fail

​

Description

​

Request

GET /v1/test/fail

X-API-Key: <your_api_key>
X-Timestamp: <unix_timestamp>
X-Nonce: <uuid>
X-Signature: v1=<signature>

​

Error Response

{
  "code": 10001,
  "payload": null,
  "error": {
    "message": "Validation error",
    "details": {}
  },
  "request_id": "req_xxxxx"
}

​

Error Code

​

POST /v1/test/post

​

Description

• Request signing
• Body hashing
• JSON parsing
• Response format

​

Request

POST /v1/test/post

X-API-Key: <your_api_key>
X-Timestamp: <unix_timestamp>
X-Nonce: <uuid>
X-Signature: v1=<signature>
Content-Type: application/json

{
  "everything": "is_fine"
}

​

Successful Response

{
  "code": 0,
  "payload": {
    "your_request_body": {
      "everything": "is_fine"
    }
  },
  "error": null,
  "request_id": "req_xxxxx"
}

​

Notes

• The request body may include any valid JSON object.
• The response returns the request body under payload.your_request_body.

​

Possible Errors

​

Usage Recommendations

• Use /v1/test/ping to verify authentication setup
• Use /v1/test/post to verify body signing (hashing) and JSON parsing
• Use /v1/test/fail to test error parsing
• Always log request_id for debugging
• Ensure timestamps are in UTC
• Never reuse nonces

​

Notes

• All test endpoints require valid authentication
• Requests are subject to replay protection
• Responses follow the standard API response format