Skip to content

获取授权令牌 ​

调用 Cookie Plus 开放接口前,需要先通过此接口获取授权令牌(token)。后续所有接口请求都需要在请求头中携带该令牌。

使用说明 ​

token 是开放接口的全局唯一接口调用凭证,调用其他各接口时都需要使用。开发者需要妥善保存,注意以下事项:

  1. 用户需要提前在 Cookie Plus 平台获取自己的 accessKey 和 secretKey。
  2. token 有效期为 7200 秒(2 小时),过期后需重新获取。重复获取将导致上次获取的 token 失效。
  3. 建议使用中控服务器统一获取和刷新 token,其他业务逻辑服务器所使用的 token 均来自该中控服务器,避免各自刷新导致 token 相互覆盖。
  4. 中控服务器需根据返回的 expiresIn 有效时间提前刷新 token,同时提供被动刷新接口,便于在 token 超时时触发刷新流程。

安全提示

accessKey 和 secretKey 属于敏感凭证,请勿在客户端代码或公开仓库中暴露。

获取 API Token ​

通过 accessKey 和 secretKey 换取授权令牌。

  • URL: /api/common/openApi/getAccessKey
  • 方法: POST
  • Content-Type: application/json

请求参数 ​

参数类型必填说明
accessKeystring是访问令牌(在平台获取)
secretKeystring是用户密钥(在平台获取)

请求示例 ​

bash
curl -X POST https://cookieplus.perk-net.com/api/common/openApi/getAccessKey \
  -H "Content-Type: application/json" \
  -d '{
    "accessKey": "pk_d0******c20",
    "secretKey": "qLc******gdk"
  }'

响应示例 ​

json
{
  "code": 200,
  "msg": "请求成功",
  "data": {
    "token": "d7b******62f",
    "expiresIn": 7200,
    "nickName": "用户昵称"
  }
}

响应字段 ​

字段类型说明
tokenstring授权令牌,后续请求需加到请求头中
expiresIninteger过期时间(秒),过期后需重新获取
nickNamestring用户昵称

使用 Token ​

获取到 Token 后,在后续所有接口请求的请求头中携带:

http
token: d7b******62f

示例:

bash
curl "https://cookieplus.perk-net.com/api/open/domainData/domainList" \
  -H "token: d7b******62f"

提示

当接口返回 token 过期或无效的错误时,请重新调用获取令牌接口刷新 token。

Cookie Plus - 浏览器 Cookie 云同步插件