申请 API Key
为了安全考虑,开发者请勿将access_token返回给前端,需要开发者保存在后台,所有访问企业微信api的请求由后台发起
申请 API Key 是调用伙伴云 API 接口的第一步,相当于创建了一个访问凭证,调用 API 接口时都需要通过 API Key 来鉴别调用者身份,以及可以调用的数据范围。
申请 API Key
创建企业
如已经拥有企业,则可跳过此步骤
1、登录伙伴云( https://app.huoban.com/v5 ),点击左上角“全部企业”,在弹出的企业列表底部中选择“创建新企业”。
2、填写企业创建向导,选择版本时,购买时长推荐选择“试用15天”,其他任意,则可获得企业付费版本的免费体验期。
创建 API Key
仅当前拥有有效付费版本的企业,可创建 API Key,可进入企业后台的“企业账户”查询
1、从企业空间左下角进入“企业设置 → 企业后台”(需要为企业管理员)。
2、在企业后台进入“接口授权”,点击“创建 API Key”即可,每个企业最多可创建 50 个。
3、可点击已创建的 API Key,在右侧栏中为其添加“备注”,用来记录每个 API Key 的用途。
API Key 的安全设置
授权范围
API Key 创建后,默认授权可以调用企业下“全部工作区”内的数据,可以通过修改“授权范围”来授权只可以调用部分工作区下的数据,以此来保证不同用途的 API Key 可以有不同的授权范围,保证数据安全。
可信 IP
API Key 创建后,默认可以被任意 IP 地址进行使用,可以通过设置“可信 IP”来限定仅在指定的 IP 地址下可以调用,用来防止 API Key 泄露而导致的数据外泄风险,保证数据安全。
更换 API Key
如发现 API Key 已经泄露,可以立即“更换 API Key”,更换后只会重新分配 API Key ,之前设置的授权范围、可信 IP、备注等都会保留。
API Key 的使用
在调用任何接口时,在 Header 中添加 Open-Authorization
参数,值为 Bearer {{API_KEY}}
。