REST API 概述
最近更新:2022-10-27

REST API 概述

特别提示:建议不要在客户端直接调用 Rest API。容易因此将 JVerification 私密信息暴露给他人,若得到 Appkey 和 MasterSecret 信息的人恶意的调用,后果将无法预估。


建议:将调用 JVerification Rest API 的代码放在开发者应用服务器上。开发者应用服务器对自己的客户端提供接口,开发者服务器收到来自客户端的请求后再调极光的 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}
          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" ...
             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==
             > POST /v1/web/verify HTTP/1.1
   > Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

        
此代码块在浮窗中显示

API 资源列表

名称 平台 请求方式 请求地址
号码认证 API Web POST https://api.verification.jpush.cn/v1/web/h5/verify
Android、iOS POST https://api.verification.jpush.cn/v1/web/verify
一键登录 API Web POST https://api.verification.jpush.cn/v1/web/h5/loginTokenVerify
Android、iOS POST https://api.verification.jpush.cn/v1/web/loginTokenVerify
查询业务风险 API Android、iOS、Web POST https://api.verification.jpush.cn/v2/web/queryBusinessRisk
号码认证 API(业务风险) Web POST https://api.verification.jpush.cn/v2/web/h5/verify
Android、iOS POST https://api.verification.jpush.cn/v2/web/verify
一键登录 API(业务风险) Web POST https://api.verification.jpush.cn/v2/web/h5/loginTokenVerify
Android、iOS POST https://api.verification.jpush.cn/v2/web/loginTokenVerify
行为验证 API Android、iOS、Web POST https://api.verification.jpush.cn/action/check 应用管理 API Android、iOS、Web POST https://admin.verification.jpush.cn/
文档内容是否对您有帮助?

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

在文档中心打开