Skip to content

开发指南 ​

简介 ​

易点易动开放了丰富的服务端接口能力,开发者可以借助这些接口能力,实现企业系统与易点易动平台的集成。

调用易点易动接口时,需使用HTTPS协议、JSON数据格式、UTF8编码,访问域名为https://api.yideamobile.com。

接口仅支持JSON数据格式的请求和返回,请求的HTTP Header中无需再指定Content-Type:application/json

接口说明格式如下: ​

请求地址:GET/POST/PUT/DELETE https://api.yideamobile.com

参数说明:

...

返回结果:

...

地址前缀 ​

为便于后续系统迭代维护,同时保障存量集成用户的服务稳定性,易点易动在 API 路由路径中增设版本标识前缀,用于区分多版本接口。示例(组织架构 - 获取公司列表接口):

https://api.yideamobile.com/v1/company

路径中的 v1 为接口版本标识前缀。当前开放平台全部 API 默认使用 v1 版本,若无特殊说明,调用接口时均需指定该版本。

频率限制 ​

为保障系统稳定运行,平台对所有接口调用实施租户级流量管控。

全局最多接受请求:5000 次/分钟

该限制为租户全接口总配额,不区分单个接口。

若同一租户一分钟内任意接口累计调用达到 5000 次,该租户本周期内后续所有请求均会被拦截,服务端返回 HTTP 429 Too Many Requests 状态码;响应头中携带 Retry-After 字段,单位为秒,代表需等待多久后可重新发起调用。

补充说明:企业租户之间限流配额相互隔离,单家企业超限不会影响其他企业正常调用接口。

状态码 ​

状态返回码说明
2xx响应成功
400参数错误、业务校验失败、统一接口错误
401未认证、Token 缺失或非法
402需要付费、套餐/数量/额度限制
403无权限、未购买、非法访问、重复提交
404数据不存在、资源不存在
406业务状态不可接受,例如余额不足、供应商已存在
409数据冲突
410链接、Token 或资源已失效
412前置条件失败,例如审批状态已变化
417业务预期失败,例如不是当前审批人、流程创建失败
423资源锁定,例如导出任务正在执行
424依赖失败,例如组件版本检查失败
429请求频率/并发超限
500服务端异常
502网关或下游任务异常