认证鉴权
DocZip开放API提供的所有接口都需要通过认证之后才可以访问。认证方式为:通过认证接口获取access_token,在请求消息头上设置"Authorization"携带access_token进行鉴权。
Token在计算机系统中代表令牌(临时)的意思,拥有Token代表拥有某种权限。Token认证是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。
认证流程
1. 应用配置:租户管理员在DocZip控制台中新建应用,并按要求进行身份提供商配置。
2. 获取Token:集成方后端使用 client_id(appid)和 client_secret(appsecret)完成客户端认证,通过Token Exchange接口获取 access_token。详见申请令牌。
3. 携带Token调用API:在请求消息头中添加 Authorization 字段,格式为 Bearer {access_token}。
4. Token刷新:access_token 过期前,使用 refresh_token 刷新获取新的 access_token。详见刷新令牌。
5. Token撤销:如果想要撤销已经颁发的用户Token,可以将access_token 、refresh_token置失效。详见撤销令牌。
6. H5会话建立:如果您的应用需要集成H5页面,需要使用access_token换取一次性Ticket,由DocZip建立用户Session会话。详见签发一次性会话 ticket。
请求消息头示例:
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9...
注意事项
● access_token 默认有效期为2小时,过期后需使用 refresh_token 刷新。
● refresh_token 默认有效期为30天,过期后需重新进行Token Exchange获取新的凭证。
● access_token 和 refresh_token 须妥善保管,避免泄露。
● 集成方后端负责管理Token的生命周期,建议在 access_token 过期前主动刷新,避免业务中断。