开发指南

介绍

我们为具备编程能力的用户提供了一个简单的方法来整合简道云数据与任何外部数据。主要提供了以下接口:

规则

  • API的统一访问地址为:https://api.jiandaoyun.com/api/v1
  • 所有API请求都必须通过HTTPS进行身份验证和发起
  • 统一采用POST请求的形式
  • 数据传输编码为UTF-8
  • 所有数据均为JSON格式

频率限制

最多接受请求:5次/秒

鉴权方式

简道云使用基于简单令牌的身份验证 (在「账户中心」生成或管理您的APIKey) ,APIKkey默认未生成,需要点击创建APIKey去生成。 生成方式:账户中心 >> 账号设置 >> API Key

对于生成的APIKey 还可以进行重置和删除。

APIKey右侧的「API文档」是专门根据当前表单的配置生成的,可以点开查看详细的说明。

通过 HTTP Headers 设置 Authorization 的值为 "Bearer YOUR_APIKEY" 来进行安全性验证,

示例如下:

$ curl -i https://jiandaoyun.com/api/v1/callback \
  -H "Authorization: Bearer YOUR_APIKEY"

错误对照表

所有API使用 状态码+错误码 的响应方式来表示错误原因。接口正确统一返回HTTP状态码为 2xx 的正确响应。接口错误统一返回HTTP状态码为 400 的错误响应,同时响应内容会返回错误码(code)错误信息(message)

HTTP/1.1 400
Content-Type: application/json

{
  "code": 8303,
  "message": "超出请求频率限制",
}

状态返回码对照表如下:

状态返回码 说明
2xx 响应成功
400 响应失败

当状态返回码为400时,服务器会返回具体的错误码(code)和错误信息(message),对照表如下:

错误码 说明
3005 接口参数不正确
4000 数据提交失败
4001 数据不存在
8301 签名校验失败
8302 没有接口请求权限
8303 超出请求频率限制
6002 部门不存在
1010 用户不存在
Peach是此帮助页面的作者。如果您对此页面的内容有任何意见,请在下方给她反馈。如需获取即时帮助,请联系技术支持。
本文是否对您有帮助?