导航|地址|刷新
鉴权API-个推文档中心









文档中心开发者中心

，欢迎您！

您的优惠服务将于到期。





基本资料



安全设置



应用管理




退出登录
登录/注册SDK下载个推学堂请选择产品
消息推送

用户运营

OneID服务

AI应用工坊

统计分析

用户分析

标签管理

模型管理

短信服务

数字人外呼

一键认证

合规检测

点击提升







体验更多产品服务


欢迎登录开发者中心

立即登录

本月不再提醒





产品简介

产品使用手册
生命周期
概览

价值用户挖掘

沉默用户促活

流失用户预测

卸载原因分析


埋点行为数据采集和管理

数据统计分析和洞察

用户分层打标和群体扩量

场景模板
场景运营介绍


运营计划

用户群管理

数据管理

权限管理

流程画布

AI助手
ChatBI智能问数


Webhook
业务介绍

技术对接说明



应用场景
埋点应用场景案例


服务端
RestAPI
开发须知

接口调用规范

鉴权API

标签API

用户API

统计API

公共参数

返回码说明



客户端
Android
集成文档

API文档

使用文档

SDK集成视频


iOS
集成文档

API文档

使用文档

隐私清单说明


HarmonyOS
集成文档

API接口

使用文档


H5&小程序
集成文档

API文档


客户端插件

SDK更新日志


常见问题




当前位置：用户运营 > 服务端 > RestAPI > 鉴权API



鉴权API


鉴权API

简述

token是个推开放平台全局唯一接口调用凭据，访问所有接口都需要此凭据，开发者需要妥善保管。

token的有效期截止时间通过接口返回参数expireTime来标识，目前是接口调用时间+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响应说明:

http code: 200(http code码说明)

出参data字段定义

名称	类型	描述
token	String	接口调用凭据
expireTime	String	token过期时间，ms时间戳

正常响应出参示例
{ "data": { "token": "deae177e7822dfb9e7fed7ebad058d4b", "expireTime": "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、登陆个推账号进入用户运营用户解决方案

2、点击应用配置->IP白名单进入IP白名单控制页面

2、打开IP白名单开关，并填写相应的IP信息





以上文档对您是否有帮助？
有帮助没帮助



您的改进建议

是否遇到以下问题

问题类型


1、内容与功能不一致；

2、文章描述不清晰；

3、图片和视频难理解；

4、对产品功能不满意；

5、不是我想要的内容；

6、其他:


问题类型不能为空



反馈建议



联系方式



取 消提 交





反馈成功

非常感谢您的反馈，我们会继续努力做到更好！
确定






在这篇文章中：简述接口定义请求示例IP白名单控制







文档中心搜索

搜 索















------
导航页 打开网址