接口的认证方式可以从导出的接口文档中查看。如果是动态Token,接口的认证方式中会标明是动态Token,并且提供获取Token接口的请求参数示例,如图-1所示。
同时导出的接口文档中会提供获取Token接口的介绍,包括使用说明、请求路径、请求方式、输入参数说明以及输出参数说明等,如图-2所示。
图-2 token接口使用说明
动态认证的接口在访问时需要先获取动态Token,然后携带动态Token进行访问认证。
请求方式:POST(HTTPS)
请求地址:https://vip:33027/api/token/getToken
请求参数:
表-1 请求参数
|
参数名称 |
数据类型 |
是否必填 |
说明 |
参数位置 |
|
appId |
String |
是 |
工作空间ID/应用ID |
Body/json |
|
code |
int |
是 |
接口ID |
Body/json |
请求参数示例:
|
{ "code": 411, "appId": "testworkspace" } |
返回结果:
|
{ "code": 200, "success": true, "data": { "expire": 1800, "token": "Ov7xNU9qIbWWI++1pakSqVkiHmKncgQPCPCaFYZlYEJ1LMPvqVJE5FaJ2Sc1SsufypwA9il+YW+kYV2cgSFSwvFyZ8Pkfedm67z4me6m9ki9YWZY8WjQl+6A4rEiOILFxo3ntW+6FiDtGmpxfF5s/b2uhwAT3ULXrUZ2FF74f5E=.e643f185b525b4d1155283366a2fac8a" }, "msg": "操作成功" } |
返回参数说明
表-2 返回参数说明
|
参数名称 |
说明 |
|
|
code |
返回状态码,200表示成功,非200表示调用失败 |
|
|
success |
返回是否成功,true表示成功,false表示失败 |
|
|
msg |
返回提示语 |
|
|
data |
expire |
token的有效时间(秒) |
|
token |
获取到的token凭证 |
|
|
开发者需要缓存token,用于后续接口的调用(注意:不要频繁调用获取token的接口,否则会影响访问效率)。当token失效或过期时,需要重新获取。token的有效期通过返回的expire来传达,默认情况为1800秒(30分钟),有效期内重复调用接口,返回的token值会刷新,这时候未过期旧token和新token可同时有效,只不过附加的有效截止时间不同,旧token会比新token提前过期。 |
用户根据接口认证方式中提供的认证参数示例去调用获取token的接口,不同的接口认证参数示例也是不同的,用户需要根据接口文档中实际情况进行调用。通过postman调用获取token的接口,结果如图-3所示。
图-3 通过postman调用获取token的接口