服务端 REST API 概述

特别提示:建议不要在客户端直接调用 Rest API。JAnalytics 私密信息容易因此暴露给他人,得到 Appkey 和 MasterSecret 信息的人可能进行恶意的推送。

建议的使用方式是:调用 JAnalytics Rest API 的代码放在开发者应用服务器上。开发者应用服务器对自己的客户端提供接口,开发者服务器收到来自客户端的请求后再调极光的 API 。

JAnalytics 提供遵从 REST 规范的 HTTP API,以供开发者远程调用 JAnalytics 提供的服务。

REST API 基本约束

  • API 被设计为符合 HTTP, REST 规范。例如:查询请求使用 Get 方法,提交请求使用 Post 方法。如果一个请求不是相应的 HTTP 方法,将返回错误。
  • 如无特殊说明,调用参数值应转码为:UTF-8, URL编码

鉴权方式

极光 REST API采用 HTTP 基本认证的验证方式。基本做法为,HTTP Header 中加 Authorization:

   Authorization: Basic ${base64_auth_string} 

Header 名称是 "Authorization", 值是 base64转换过的 "appKey:masterSecret"(中间有个冒号)。这两者可以在极光开发者服务的Web控制台[应用设置]-[应用信息]中查看。

API 资源列表

名称 资源
用户卸载 API GET https://api.analytics.jpush.cn/v1/stat/uninstall

Copyright 2011-2019, jiguang.cn, All Rights Reserved.
粤ICP备12056275号-13 深圳市和讯华谷信息技术有限公司

Documentation built with MkDocs.