应用管理 API
最近更新:2022-10-27
展开全部

应用管理 API

开发者可以调用 JVerification Admin API,开通一键登录功能。
这类 API 地址统一为: https://admin.verification.jpush.cn/

注:Admin API 目前尚未完全开放,如需使用该功能,请 联系我们

调用验证

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

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

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

        
此代码块在浮窗中显示

即上述 base64_auth_string 的生成算法为:base64(dev_key:dev_secret)

  • Header 名称是 "Authorization",值是 base64 转换过的 "username:password" 对(中间有个冒号)。
  • 在 Admin API 的场景里,username 是 dev_key,password 是 dev_secret。这二者可以在控制台-账户信息-开发者中获取。

申请开通一键登录

功能说明

为开发者账户下的 appKey 开通一键登录功能,并同时开通号码认证。

调用地址

POST https://admin.verification.jpush.cn/v1/admin/open

请求示例

curl -X POST https://admin.verification.jpush.cn/v1/admin/open \ -u 'c4a614b54b23fb654b9d98e0:063f0a07f558f75388698512' \ -H 'Content-Type: application/json' \ -d '{ "app_key" : "bbd30f38e858211953e8424a", "platform" : "a", "app_sign" : "20f46148b72d8e5e5ca23d37a4f41492", "rsa_pubkey" : "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCeMnBOsLq4rWic4ez/FHUhppbnyd2Jjvqpw6Cc+YIvZFO988KR04H2BFRBnST+JkIh6lAJGe9tjOnHTYNO7+DUKuodv31DJiNWhI6u7KtGX6Humajls1+9XkA2qzSTfrjZoSzlQWFUMC3WP+nXT+pd0291GF+BSDT0Yuu3dxx/1QIDA111", "callback_url" : "https://www.jiguang.cn/callback", "package_name" : "jiguang", "app_intro" : "jiguang test demo introduction", "app_type" : "1" }'
          curl -X POST  https://admin.verification.jpush.cn/v1/admin/open \
  -u 'c4a614b54b23fb654b9d98e0:063f0a07f558f75388698512' \
  -H 'Content-Type: application/json' \
  -d '{
    "app_key" : "bbd30f38e858211953e8424a",
    "platform" : "a",
    "app_sign" : "20f46148b72d8e5e5ca23d37a4f41492",
    "rsa_pubkey" : "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCeMnBOsLq4rWic4ez/FHUhppbnyd2Jjvqpw6Cc+YIvZFO988KR04H2BFRBnST+JkIh6lAJGe9tjOnHTYNO7+DUKuodv31DJiNWhI6u7KtGX6Humajls1+9XkA2qzSTfrjZoSzlQWFUMC3WP+nXT+pd0291GF+BSDT0Yuu3dxx/1QIDA111",
    "callback_url" : "https://www.jiguang.cn/callback",
    "package_name" : "jiguang",
    "app_intro" : "jiguang test demo introduction",
    "app_type" : "1"
}'

        
此代码块在浮窗中显示

请求参数

关键字 选项 含义
app_key Y 极光 appKey
platform Y 开通平台,Andoird:a、iOS:i
package _name Y Android 包名或者 iOS 的 Bundle ID,包名需要以点号隔开,如 com.xxx
app_sign N 应用签名,当 paltform 为 a 时必填,区分大小写,用于对应用进行二次身份校验,通常由 32 个小写字母和数字组成
app_type Y 应用类型,1:游戏、2:应用
app_intro Y 应用简介(60-1200 字符,一个汉字计算为 2 个字符)
rsa_pubkey Y RSA 加密公钥,1024 位,密钥格式:PKCS#8
callback_url Y 接收开通结果的回调地址

响应示例

请求成功

{ "code": 9200 }
          {
    "code": 9200
}

        
此代码块在浮窗中显示

请求失败

{ "code": 9012, "content": "parameter invalid" }
          {
    "code": 9012,
    "content": "parameter invalid"
} 

        
此代码块在浮窗中显示

响应参数

关键字 含义
code 返回码
content 返回码说明

开通结果回调

提交申请开通一键登录成功之后,极光会向 callbackUrl 发送 post 回调请求, 反馈开通结果。content-type 是 application/json, 请求体:

{ "app_key": "bbd30f38e858211953e84a4a", "platform": "i", "code": "9200", }
          {
    "app_key": "bbd30f38e858211953e84a4a",
    "platform": "i",
    "code": "9200",   
}

        
此代码块在浮窗中显示

查询一键登录开通状态

功能说明

查询 appKey 一键登录的开通状态。

调用地址

POST https://admin.verification.jpush.cn/v1/admin/query

请求示例

curl -X POST https://admin.verification.jpush.cn/v1/admin/query \ -u 'c4a614b54b23fb654b9d98e3:063f0a01f558f7538869851c' \ -H 'Content-Type: application/json' \ -d '{ "app_key" : "bbd30f38e858211953e84a1a", "platform" : "i" }'
          curl -X POST  https://admin.verification.jpush.cn/v1/admin/query \
  -u 'c4a614b54b23fb654b9d98e3:063f0a01f558f7538869851c' \
  -H 'Content-Type: application/json' \
  -d '{
    "app_key" : "bbd30f38e858211953e84a1a",
    "platform" : "i"
}'

        
此代码块在浮窗中显示

请求参数

关键字 选项 含义
app_key Y 极光 appKey
paltform Y 开通平台,Andoird:a、iOS:i

响应示例

请求成功

{ "status": "PASS" }
          {
    "status": "PASS"
}

        
此代码块在浮窗中显示

请求失败

{ "code": 9012, "content": "parameter invalid" }
          {
    "code": 9012,
    "content": "parameter invalid"
} 

        
此代码块在浮窗中显示

响应参数

关键字 含义
code 返回码
content 返回码说明
status 开通状态,NONE:未开通、PASS:开通成功、NO_PASS:开通失败

返回码

请参考返回码说明文档:返回码说明

文档内容是否对您有帮助?

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

在文档中心打开