Admin API

JVerification Admin API 提供给开发者进行开通极光认证一键登录功能。
这类 API 地址统一为: https://admin.verification.jpush.cn/

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

请求头定义:

  • HTTP Header Authorization 的值:Basic base64_auth_string;
  • base64_auth_string 生成规则是:base64(dev_key:dev_secret), dev_key 及 dev_secret 请登录官网在开发者帐号页面获取;
  • 留意 dev_key 与 dev_secret 中间使用 ":" 冒号隔开。

请参考相关规范文档:HTTP基本认证

申请开通一键登录

功能说明

为开发者账户下的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"
}'
  • 请求参数
KEY REQUIRE DESCRIPTION
app_key Y 极光appKey
paltform Y 开通平台,Andoird:a,iOS:i
package _name Y Android包名或者iOS的Bundle ID
app_sign N 应用签名,当paltform为a时必填,区分大小写,用于对应用进行二次身份校验,通常由32个小写字母和数字组成
app_type Y 应用类型,1游戏、2应用
app_intro Y 应用简介(60-1200字符)
rsa_pubkey Y RSA加密公钥,1024位,密钥格式PKCS#8
callback_url Y 接收开通结果的回调地址

响应示例

请求成功

{
    "code": 9200
}

请求失败

{
    "code": 9012,
    "content": "parameter invalid"
} 
  • 响应参数
KEY DESCRIPTION
code 返回码
content 返回码说明

开通结果回调

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

{
    "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",
}'
  • 请求参数
KEY REQUIRE DESCRIPTION
app_key Y 极光appKey
paltform Y 开通平台,Andoird:a,iOS:i

响应示例

请求成功

{
    "status": "PASS"
}

请求失败

{
    "code": 9012,
    "content": "parameter invalid"
} 
  • 响应参数
KEY DESCRIPTION
code 返回码
content 返回码说明
status 开通状态,NONE:未开通,PASS:开通成功,NO_PASS:开通失败

返回码

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


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

Documentation built with MkDocs.