REST API 概述

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

基本约束

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

鉴权方式

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

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

          Authorization: Basic ${base64_auth_string}

        

即上述 base64_auth_string 的生成算法为：base64(appKey:masterSecret)

• Header 名称是 "Authorization"，值是 base64 转换过的 "username:password" 对（中间有个冒号）。
• 在 Verification API 的场景里，username 是 appKey，password 是 masterSecret。这二者可以在【极光工作台】-【应用管理】-【设置&密钥】中查看。

鉴权举例

你的 appKey 是 "7d431e42dfa6a6d693ac2d04", masterSecret 是 "5e987ac6d2e04d95a9d8f0d1"，则调用 Verification API v1 时，使用 curl 命令调用如下：

             curl --insecure -X POST -v https://api.verification.jpush.cn/v1/web/verify
   -H "Content-Type: application/json"
   -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1"
   ...

        

HTTP 请求是：

             > POST /v1/web/verify HTTP/1.1
   > Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

        

API 资源列表