服务端 REST API 概述

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转换过的 "ProductKey:ProductSecret"(中间有个冒号)。这两者可以在极光 IoT 服务的Web控制台[产品设置]中查看。

鉴权举例

你的 appKey 是 "7d431e42dfa6a6d693ac2d04", masterSecret 是 "5e987ac6d2e04d95a9d8f0d1",则调用 Push API v3 时,使用 curl 命令的话,是这样写:

curl --insecure -X POST -v https://api.jpush.cn/v3/push -H "Content-Type: application/json"
-u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1"
-d  '{"platform":"all","audience":"all","notification":{"alert":"Hi,JPush!"}}'

HTTP 请求发出的请求是:

> POST /v3/push HTTP/1.1
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

文档参考


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

Documentation built with MkDocs.