开发前必读

[TOC]

开发文档阅读说明

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

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

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

    请求方式:GET/POST(HTTPS)
    请求地址:https://qyapi.weixin.qq.com/cgi-bin/gettoken?corpid=ID&corpsecret=SECRET
    请求包体:
    ...
    参数说明:
    ...
    权限说明:
    ...
    返回结果:
    ...
    参数说明:
    ...
    

    1) 请求方式,标明接口调用的HTTP方法,区分HttpGet/HttpPost请求。所有的请求都为https协议。
    2) 请求地址,参数中标注大写的单词,表示为需要替换的变量。在上面的例子中 ID 及 SECRET 为需要替换的变量,根据实际获取值更新。假如,这里我们获取到的ID=wwabcddzxdkrsdv,SECRET=vQT_03RDVA3uE6JDASDASDAiXUvccqV8mDgLdLI,那么上述的请求在发送时为:

    https://qyapi.weixin.qq.com/cgi-bin/gettoken?corpid=wwabcddzxdkrsdv&corpsecret=vQT_03RDVA3uE6JDASDASDAiXUvccqV8mDgLdLI
    

    3) 请求包体/参数说明,标明请求参数示例及说明,参数说明包括字段含义、取值范围,开发者在设计数据结构时,应参考该定义范围。
    4) 权限说明,标明接口的使用范围,开发者应特别留意调用场景。比如,同步通讯录的接口必须要用通讯录同步助手的access_token,发送消息指定的范围必须是应用可见范围内的结点等。
    5) 返回结果/参数说明,标明返回参数示例及说明。特别留意,所有接口在调用失败时返回包里都有errcode、errmsg(部分接口在调用成功时没有返回errcode和errmsg)。开发者需根据errcode存在且不为0判断为失败,否则为成功(errcode意义请见全局错误码)。而errmsg仅作参考,后续可能会有变动,因此不可作为是否调用成功的判据。

接口调用流程



  1. 获取access_token,参考 文档说明
  2. 缓存和刷新access_token。
    开发者需要缓存access_token,用于后续接口的调用(注意:不能频繁调用gettoken接口,否则会受到频率拦截)。当access_token失效或过期时,需要重新获取。
  3. 调用具体的业务接口

基本调试方法

企业微信提供了开发者工具,可以借助工具排查问题原因。参考说明:工具与资源 - 开发者工具

调用频率限制

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

© 1998 - 2020 Tencent Inc. All Rights Reserved