# 开发必读

  • 开发文档说明
  • 接口调用流程
  • 基本调试方法
  • 调用频率限制

# 开发文档说明

服务端API开放了丰富的能力接口,开发者可以借助接口能力,实现企业服务及企业微信的集成。支持的能力,通过目录导航可以快速预览, 目录树按功能块聚合归类,如通讯录管理、消息推送等。

文档的阅读次序,建议先阅读一遍开发指南,以及接口 access_token 获取。然后就可以独立查看各个功能块文档说明。

所有的接口需使用 HTTPS 协议、JSON 数据格式、UTF8 编码。接口说明格式如下:

请求方式:POST(HTTPS)
接口说明:
...
请求地址:
...
请求包体:
...
参数说明:
...
权限说明:
...
返回结果:
...
参数说明:
...
  1. 请求方式,标明接口调用的 HTTP 方法,区分 GET/POST 请求。所有的请求都为 https 协议。
  2. 请求地址,注意大小写。
  3. 请求包体/参数说明,标明请求参数示例及说明,参数说明包括字段含义、取值范围,开发者在设计数据结构时,应参考该定义范围。
  4. 权限说明,标明接口的使用范围,默认只能看当前账户下的数据,暂时没有开发者特别留意调用场景。
  5. 返回结果/参数说明,标明返回参数示例及说明。特别留意,所有接口在调用失败时返回包里都有 code、message(部分接口在调用 成功时没有返回 code 和 message)。 开发者需根据 code 存在且不为 200 判断为失败,否则为成功(code意义请见全局错误码)。 而 message 仅作参考,后续可能会有变动,因此不可作为是否调用成功的判据。

# 接口调用流程

img.png

获取 access_token,参考说明:文档说明

  1. 缓存和刷新 access_token。
  2. 开发者需要缓存 access_token,用于后续接口的调用。当 access_token 失效或过期时,需要重新获取。
  3. 调用具体的业务接口

# 基本调试方法

可以借助工具排查问题原因。参考说明:文档说明

# 调用频率限制

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