鉴权API

鉴权API

简述

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

接口定义

  • 接口描述: 获取鉴权token
  • 接口地址: $BaseUrl/auth
  • 请求方式: POST
  • content-type:application/json;charset=utf-8
注:鉴权接口每分钟最大调用量为1000次,建议开发者妥善管理token,以免达到限制,影响接口调用

接口说明:

  • URL字段定义
名称 描述
serverUrl 运营工具开放API接口前缀
appId 用户创建应用时生成的应用唯一标识

Request请求说明:

  • 入参字段定义
名称 类型 是否必须 默认值 描述
appkey String 创建应用时生成的appkey(个推分配)
sign String 鉴权时的签名。
生成 sign 值:将 appkey、timestamp、mastersecret 对应的字符串按此固定顺序拼接后,使用 SHA256 算法加密。
示例 java 代码格式: String sign = sha256(appkey+timestamp+mastersecret)
timestamp Long 毫秒时间戳(13位),请使用当前毫秒时间戳,误差太大可能出错
  • 入参示例
{
    "appkey":"YZkTKbz91l84HyM0TGlb38",
    "sign":"b66307af63a46d843aadfe1af5b05bc714074c9f9df45c0050e18d6176869769",
    "timestamp":1608172111917,
}

Response响应说明:

名称 类型 描述
token String 接口调用凭据
expire_time String token过期时间,ms时间戳
  • 正常响应出参示例
{
    "data": {
        "token": "deae177e7822dfb9e7fed7ebad058d4b",
        "expire_time": "1608172111917"
    },
    "msg": "成功",            // 响应code码
    "code": 0                // 响应信息
}

请求示例

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

IP白名单控制

出于安全考虑,用户运营支持对OPEN API进行IP白名单配置(默认不开启),配置开启后会针对请求的接口做IP校验,保障数据安全性,建议配置。

IP白名单控制流程如下:

1、登陆个推账号进入用户运营用户解决方案
img.png
2、点击应用配置->IP白名单进入IP白名单控制页面
img.png
2、打开IP白名单开关,并填写相应的IP信息
img.png

文档中心搜索

技术
咨询

微信扫一扫

随时联系技术支持

在线
咨询