第三方应用开发 服务端API 开发指南 开发前必读
开发前必读

目录

  • 开发文档阅读说明
  • 区分三种类型access_token
  • 开发文档阅读说明

    1. 所有的接口需使用HTTPS协议、JSON数据格式、UTF8编码。接口说明格式如下:
      请求方式:GET/POSTHTTPS
      请求地址:https://qyapi.weixin.qq.com/cgi-bin/gettoken?corpid=ID&corpsecret=SECRET
      请求包体:
      ...
      参数说明:
      ...
      权限说明:
      ...
      返回结果:
      ...
      参数说明:
      ...

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

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

    区分三种类型access_token

    在第三方应用开发提供的接口中,会涉及到三种类型的access_token。下面表格对这三类token的定义及使用场景进行说明,开发者应在不同场景中选择对应的token:

    类型说明适用场景
    服务商的token以corpid(服务商CorpID)、provider_secret(服务商密钥)换取provider_access_token,代表的是服务商的身份用于服务商级别的接口调用,比如登录授权、推广二维码等。说明文档参考 获取服务商凭证
    第三方应用的token以suite_id(第三方应用ID)、suite_secret(第三方应用密钥)换取suite_access_token,代表第三方应用的身份用于获取第三方应用的预授权码,获取授权企业信息等。说明文档参考 获取第三方应用凭证
    授权企业的token企业安装第三方应用后,第三方服务商以企业的corpid、永久授权码来获取access_token用于操作授权企业相关接口,如通讯录管理,消息推送等。说明文档参考 获取企业凭证
    下一篇
    基本概念介绍