跳到主要内容

获取OpenAPI accessToken

获取accessToken是调用轻流openAPI接口的第一步,相当于创建了一个登录凭证,其它的API接口,都需要依赖于accessToken来鉴权调用者身份。


权限说明

通过关联每个子管理员对应的权限,可以生成相应权限的secret。获取到的accessToken只能调用权限范围内的接口。

请求

**请求方式:**GET

**请求地址:**https://api.qingflow.com/accessToken(公有云版本)

钉钉版本:https://api.ding.qingflow.com/accessToken

专有轻流:http(s)://xxx.xx(自有域名)/openApi/accessToken

2.1 参数说明(查询参数):

参数必须说明
wsId工作区ID,获取方式参考:基本概念介绍——wsId
wsSecret工作区权限组的凭证密钥,获取方式参考:基本概念介绍-wsSecret

返回

3.1 返回体

参数必含类型说明
errCodeint错误码,非0表示失败
errMsgstring错误描述
questionRelations关联的设置,这里没用
resultobject返回结果
accessTokenstring权限组accesstoken
expireTimeint过期时间

3.2 返回体示例

{
"errCode": 0,
"errMsg": null,
"questionRelations": [],
"result": {
"accessToken": "742de39a-e2a6-42ce-xxxz-cfd499289161",
"expireTime": 7200
}
}

注意事项

开发者需要缓存accessToken,用于后续接口的调用(注意:不能频繁调用accessToken接口,否则会受到频率拦截)。当accessToken失效或过期时,需要重新获取。

accessToken的有效期通过返回的expireTime来传达,正常情况下为7200秒(2小时)。每一次请求都会获取新的结果,并重新开始计时。且之前的accessToken会失效。同时在前台重置secret也会导致accessToken失效。