企业微信中获取 access_token 是调用企业微信 API 接口的第一步,相当于创建了一个 token 登录凭证,其它的业务 API 接口都需要依赖于 access_token 来鉴权调用者身份。企业微信 API 在线地址为:https://qiyeweixin.apifox.cn/,这个在线地址的项目你可以克隆到 Apifox,以方便调试。
企业微信的 access_token 基本信息
开始之前需要注意的是,开发者应该将 access_token 保存在后台服务器,不应将其返回给前端。获取的 access_token 应该在后台发起对企业微信 API 的请求时进行鉴权。在使用业务接口之前,要明确 access_token 的颁发方式,并确保使用正确的 access_token。
API 端点
- 基本 URL:
https://qyapi.weixin.qq.com
- 路径:
/cgi-bin/gettoken
- HTTP 方法: GET
- 参数:
参数名 | 必填 | 类型 | 描述 |
corpid | 是 | string | 企业微信的CorpID,可在企业微信管理后台获取。 |
corpsecret | 是 | string | 应用的Secret,也可在企业微信管理后台获取。 |
请求示例
企业微信 API 在线地址为:https://qiyeweixin.apifox.cn/,这个在线地址的项目你可以克隆到 Apifox,以方便调试。
GET https://qyapi.weixin.qq.com/cgi-bin/gettoken?corpid=YOUR_CORPID&corpsecret=YOUR_CORPSECRET
响应示例
成功时,企业微信将返回如下 JSON 响应:
{
"errcode": 0,
"errmsg": "ok",
"access_token": "YOUR_ACCESS_TOKEN",
"expires_in": 7200
}
错误处理
如果出现错误,企业微信将返回相应的错误信息。常见的错误码包括:
40013
:不合法的corpid
40001
:不合法的corpsecret
注意事项
在使用企业微信获取 access_token
功能时,需要注意以下事项:
1. 安全性: 请确保 corpsecret
的安全性,不要泄露给不信任的人员。如果 corpsecret
泄露,及时重新生成。
2.access_token
有效期: access_token
有效期为7200秒(2小时),过期后需要重新获取。因此,在开发过程中,建议定时刷新 access_token
。
3.频率限制: 获取 access_token
的接口有一定的调用频率限制,不要频繁请求,否则可能会被限制访问。
4.CorpID 和 CorpSecret 管理: CorpID 和 CorpSecret 是企业微信的核心凭证,务必妥善管理,不要公开在代码中或配置文件中。
使用 Apifox 调试、管理接口
Apifox 是一个比 Postman 更强大的接口测试工具,Apifox = Postman + Swagger + Mock + JMeter,Apifox 支持调试 http(s)、WebSocket、Socket、gRPC、Dubbo 等协议的接口,并且集成了 IDEA 插件。在开发完接口后,可以通过 Apifox 的 IDEA 插件一键生成接口文档,多端同步,非常方便测试和维护。
知识扩展: