开发前必读

更新时间:2019-3-7

开发文档阅读说明

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

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

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

接口说明格式如下:
请求地址:GET/POST/PUT/DELETE https://openapi.yideamobile.com
参数说明:
...
返回结果:
...

表示API版本的地址前缀

为了在日后系统维护升级时能够方便用户区分不同版本的API并对已经集成现有API的用户提供稳定持续的服务,易点在API的路由地址中加入了表示API版本的前缀。如组织结构模块中获取公司列表的接口:

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

其中,v1即为表示API版本的前缀。

在当前开放平台API服务中,如无特别说明所有接口都需要指定使用版本为v1的接口。

关于频率限制

出于系统保护的考虑,我们对接口的调用做了频率限制。

所有接口每秒钟被调用的次数都不能超过一定限制,当超过此限制时,调用接口会收到相应的错误信息。比如每分钟调用次数不能超过5000次,5000次是针对单个企业并不针对接口。如果1个企业在一分钟内对任意接口的调用次数达到了5000次,那么这个企业在这一分钟内再次调用任意接口,就会收到状态码为429的HTTP错误信息。同时,可以在Response中得到名为Retry-After的Header,标识下次允许调用的时间。(单位:秒)

注:一个企业超过单位时间内允许的调用次数,不会对其他企业对服务的调用产生影响