REST API 概述
最近更新:2023-02-21

REST API 概述

特别提示:建议不要在客户端直接调用 Rest API。私密信息容易因此暴露给他人,得到 Appkey 和 MasterSecret 信息的人可能进行恶意的调用。 建议的使用方式是:调用 Rest API 的代码放在开发者应用服务器上。开发者应用服务器对自己的客户端提供接口,开发者服务器收到来自客户端的请求后再调极光的 API 。

编码

如无特殊说明,调用参数值应转码为:UTF-8

鉴权

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

基本做法为,HTTP Header(头)里加 Authorization:

Authorization: Basic ${base64_auth_string}
          Authorization: Basic ${base64_auth_string}

        
此代码块在浮窗中显示

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

  • Header 名称是 "Authorization",值是 base64 转换过的 "username:password" 对(中间有个冒号)。
  • 在 JPortrait API 的场景里,username 是 appKey,password 是 masterSecret。这二者可以在控制台应用设置中查看。

鉴权举例

你的 appKey 是 "7d431e42dfa6a6d693ac2d04", masterSecret 是 "5e987ac6d2e04d95a9d8f0d1",则调用 Push API v3 时,使用 curl 命令调用如下:

curl --insecure -X POST -v https://portrait-api.jiguang.cn/iaudience/open -H "Content-Type: application/json" -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1" -d '{...}'
          curl --insecure -X POST -v https://portrait-api.jiguang.cn/iaudience/open -H "Content-Type: application/json"
-u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1"
-d  '{...}'

        
此代码块在浮窗中显示

HTTP 请求发出的请求是:

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

        
此代码块在浮窗中显示

域名

https://portrait-api.jiguang.cn/iaudience/open

返回的数据结构

KEY TYPE DESCRIPTION
code string 业务码,业务码详情见业务码对照表
message string 对业务码的辅助提示信息
requestId string 极光生成的全局唯一请求ID
data - 本次请求的结果数据,不同API的返回数据结构不一样

返回数据结构示例如下:

{ "code": "2000", "message": "success", "requestId": "021011361482", "data": { "HADI_SHOPPING_MALL": "1.0000", "HAGI_SHOPPING_ALL": "0.7354", "HAGI_SHOPPING_MALL": "0.6763" } }
          {
  "code": "2000",
  "message": "success",
  "requestId": "021011361482",
  "data": {
        "HADI_SHOPPING_MALL": "1.0000",
        "HAGI_SHOPPING_ALL": "0.7354",
        "HAGI_SHOPPING_MALL": "0.6763"
  }
}

        
此代码块在浮窗中显示

业务码对照表

CODE HTTP CODE MESSAGE DESCRIPTION
2000 200 success 查询成功
2001 200 data not found 数据未查得
2002 200 biz error 业务异常
4000 400 params invalid 参数无效
5000 500 internal Server Error 系统异常
6002 401 authorization invalid API鉴权失败
文档内容是否对您有帮助?

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

在文档中心打开