开发指南
简介
我们为具备编程能力的用户提供了一个简单的方法来整合系统数据与任何外部数据。
主要提供了以下接口:
域名规则
API的统一访问地址获取路径:
- 登录应用主页
工作台
,点击右上方个人头像
,选择账户中心
。- 在
账户中心
页面左侧面板找到会员管理
→版本信息
,在WebAPI
分类中点击API文档
。- 在
API文档
页面中点开任意一个应用,即可在开头介绍
分页中看到API的统一访问地址。
如图所示: |
---|
- 所有API请求都必须通过HTTPS进行身份验证和发起;
- 统一采用POST请求的形式;
- 数据传输编码为UTF-8;
- 所有数据均为JSON格式;
频率限制
最多接受请求:5次/秒;
请求认证
系统使用基于简单令牌的身份验证(在 「系统管理」生成或管理您的API Key),API Key默认未生成,需要点击创建API Key生成。
请注意:API Key与您的账户拥有相同的权限,请务必保密。
-
API Key生成方式:【账户中心】——【版本信息】 ——【API Key】
-
对于生成的APIKey 还可以进行重置和删除。
-
APIKey右侧的「API文档」是专门根据当前表单的配置生成的,可以点开查看详细的说明。
【点击API文档】-【选择应用】-【进入API文档】
- 通过 HTTP Headers 设置
Authorization
的值为"Bearer YOUR_APIKEY"
来进行安全性验证。
示例如下:
$ curl -i API统一访问地址/callback \
-H "Authorization: Bearer YOUR_APIKEY"
错误对照表
所有API使用【状态码+错误码】的响应方式来表示错误原因。
接口正确统一返回HTTP状态码为 2xx
的正确响应。
接口错误统一返回HTTP状态码为 400
的错误响应,同时响应内容会返回错误码(code)和错误信息(message)。如:
HTTP/1.1 400
Content-Type: application/json
{ "code": 4004,
"message": "超出请求频率限制",
}
- 状态返回码对照表如下:
状态返回码 | 说明 |
2xx | 响应成功 |
400 | 响应失败 |
- 当状态返回码为400时,服务器会返回具体的错误码(code)和错误信息(message),对照表如下: