介绍

接口使用 RESTful 格式，在请求时需要注意正确的 HTTP 方法。

认证

关于头部参数和 URI 参数

• URI 参数是指将参数按照 url-encode 编码的形式放入请求 url
• 头部参数是指在请求头部信息中放入参数数据, 这里我们用于认证的参数名是 Authorization

登录成功后，可以在请求参数中携带身份验证信息（即在请求参数中传、auth_token、device），也可以将身份信息放到请求头的 Authorization 里，即在每个请求头中都加入如下参数：
Authorization: Bearer token=”{user_token}”, device=”{device}”

除某些特定接口外，所有接口调用都要携带身份验证信息。用户身份信息包括 auth_token、device。
可以通过HTTP请求参数带入，也可以将身份信息放到请求头的Authorization里，即在每个请求头中都加入如下参数：

Authorization: Token token="{{auth_token}}", device="{{device}}"

示例：

curl -X GET \
  /apaas/api/v2/custom_fields \
  -H 'Authorization: Token token=9b986abc0ff282823992f7c9f2c9bcc4, device=open_api\
  -H 'Content-Type: application/json;charset=utf-8'

验证信息参数解释

device 参数列表

HTTP 状态码

• 200 - 成功（业务内异常由响应body中的 code 来说明）
• 500 - 服务器异常

Rate Limit 访问频率限制

IP 限制, 100 次/10秒

接口返回值说明:

正确结果示例:

API 返回统一格式

{ "code": 0, "data": {}, "message": "", "remark": "" }

错误结果示例:

   { "code": 10000, "message": "", "remark": ""  }

返回值说明