请求方式

通常接口为 REST 接口,以接口提供者和 Swagger 文档为准。

令牌机制

在用户操作的登录流程成功时,接口会返回两个令牌给前端调用者,分别为 SessionToken 和 UserToken ,调用者需要在本地保存这两个令牌。

SessionToken

短效会话令牌,用于当前会话内请求需要用户登录后才能访问的请求。
SessionToken 不会 自动续期,在发起请求时如果收到 SessionToken 已超期的响应,需要在调用流程内部(用户不可感知)通过持有的 UserToken 发起 Renew 操作,得到新的令牌。

UserToken

由用户手工登录成功行为获得的长效用户令牌,用于维持 APP 等的长登录机制。
在 Renew 操作时需要使用此令牌,发起请求时如果收到 UserToken 已超期的响应,需要给出提示并跳转到登陆界面。

令牌传输

调用者在请求不同接口时按需通过同一请求头传递 SessionToken 或者 UserToken:

  1. Authorization: Bearer Session-Token-or-User-Token

传输客户端信息

传输方式

在 HTTP 请求头中以 QueryString (key1=value1&key2=value2) 形式传递,value值如有需要自行 encode(参考 Javascript 的 encodeURIComponent)。

传输头 X-NXCloud-Client

X-NXCloud-Client: deviceId=123456