服务端 REST API 概述

与此同时，为方便开发者使用 JMLink API，还提供多种常用编程语言的开发包（SDK）。

VIP 功能

JMLink 为 VIP 提供专属的 REST API 功能，如需体验，请联系商务 。

REST API 基本约束

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

API 资源列表

鉴权方式

极光 REST API 采用 HTTP 基本认证 的验证方式。

基本做法为，HTTP Header（头）里加 Authorization：

          Authorization: Basic ${base64_auth_string}

        

Header 名称是 "Authorization"，值是 base64 转换过的 "username:password" 对（中间有个冒号）。在JMLink API 的场景里，username 是 appKey，密码是 masterSecret。这二者可以在 JMLink Web 控制台应用设置中查看。 即，上述 base64_auth_string 的生成算法为：base64(appKey:masterSecret)

鉴权举例

你的 appKey 是 "7d431e42dfa6a6d693ac2d04", masterSecret 是 "5e987ac6d2e04d95a9d8f0d1"，则调用 短链查询 时，使用 curl 命令的话，是这样写：

          curl --insecure -X GET -v https://api.jpush.cn/v1/links?page_index=1&page_size=20
-u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1"

        

HTTP 请求发出的请求是：

          > GET /v1/links HTTP/1.1
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

        

API 频率控制

JMLink API 对访问次数，具有频率控制。即一定的时间窗口内，API 允许调用的次数是有限制的。

频率定义

一个时间窗口内，当前定义为：1 分钟。每个 AppKey 的 API 调用数量。

各 API 频率如下表：

返回码

若请求失败，API 会返回如下 JSON 格式的返回码及说明

          {
    "error": {
        "code": *****,
        "message": "*****"
    }
}

        

REST API 返回码汇总

如果您的应用被加入黑名单，请发邮件到 support@jiguang.cn 以进一步沟通协调。