OpenAPI 接口文档
OpenAPI 接口文档

请求规范

基本请求头

请求头 必填 说明
X-API-Key API Key;只能出现一次
Accept 建议使用 application/json
Content-Type POST/PATCH 请求是 使用 application/json
X-LANG 失败文案和可翻译数据的语言
X-TRACE-ID 调用方提供的追踪编号;响应会返回最终采用的值

语言

X-LANG 支持以下值:

  • en_US
  • es_ES
  • pt_BR
  • ru_RU
  • vi_VN
  • zh_CN

省略或传入不支持的值时使用 en_US

成功响应的 msg 固定为 success,不随 X-LANG 变化。失败响应的 msg,以及地区名称等可翻译的 data 字段,会使用指定语言;无法提供对应翻译时可能使用默认语言。

追踪编号

调用方可以发送 X-TRACE-ID,长度不能超过 128 个字符,且不能包含换行。响应头会返回最终追踪编号;未提供或格式不符合要求时会生成新的编号。

参数规则

  • JSON 字段和 Query 参数均使用 snake_case
  • 每个 Query 参数只能出现一次。
  • 未在接口文章中列出的 Query 参数和 JSON 字段会被拒绝。
  • JSON 字符串、整数和布尔值必须使用正确的 JSON 类型,不会自动把数字转换为字符串,或把字符串转换为整数、布尔值。
  • 枚举值区分大小写,必须使用文档列出的大写值。
  • 路径编号按字符串传递。
  • order_no 是不透明字符串,只能原样保存和传递;不得依赖其前缀、长度或生成规则。

调用频率

当前 Open API 暂未设置调用频率限制。

缓存

所有响应均包含:

Cache-Control: private, no-store

调用方不应缓存包含余额、账号、订单、资源或连接凭据的响应。

On this page

请求规范