"> 鉴权API-个推文档中心

鉴权API

鉴权API

  • token是个推开放平台全局唯一接口调用凭据,访问所有接口都需要此凭据,开发者需要妥善保管。
  • token的有效期截止时间通过接口返回参数expire_time来标识,目前是接口调用时间+1天的毫秒时间戳。
  • token过期后无法使用,开发者需要定时刷新。为保证高可用,建议开发者在定时刷新的同时做被动刷新,即当调用业务接口返回错误码10001时调用获取token被动刷新

获取鉴权token

  • 接口地址: BaseUrl/auth
  • 请求方式: POST

Request请求说明:

body参数说明

  • content-type:application/json;charset=utf-8

  • 参数示例

{
    "sign": "",
    "timestamp": "",
    "appkey": ""
}
  • 请求参数说明
名称 类型 是否必须 默认值 描述
sign String 签名,加密算法: SHA256,格式: sha256(appkey+timestamp+mastersecret)
timestamp String 毫秒时间戳,请使用当前毫秒时间戳,误差太大可能出错
appkey String 创建应用时生成的appkey

Response响应说明

成功响应数据格式:

  • content-type:application/json;charset=utf-8

  • 返回值示例

{
    "code": 0,
    "msg": "",
    "data": {
        "expire_time": "",
        "token": ""
    }
}
名称 类型 描述
expire_time String token过期时间,ms时间戳
token String 接口调用凭据

请求示例

curl $BaseUrl/auth -X POST -H "Content-Type: application/json;charset=utf-8" -d '{"sign": "","timestamp": "","appkey": ""}'

删除鉴权token

为防止token被滥用或泄露,开发者可以调用此接口主动使token失效

  • 接口地址: BaseUrl/auth/$token
  • 请求方式: DELETE

Request请求说明:

路径参数说明(路径中$开头的参数)

名称 类型 是否必须 默认值 说明
token String 接口调用凭证token

Response响应说明

成功响应数据格式:

  • content-type:application/json;charset=utf-8

  • 返回值示例

{
    "code": 0,
    "msg": ""
}

请求示例

curl $BaseUrl/auth/$token -X DELETE
在这篇文章中: 获取鉴权token 删除鉴权token
开发者中心 SDK 下载

文档中心搜索