Admin API V1

JPush Admin API 提供给开发者操创建/删除 app，上传证书等功能。这类 API 地址统一为： https://admin.jpush.cn/v1/

注：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基本认证。

创建极光 app

功能说明

在开发者账号下创建一个 app

调用地址

POST https://admin.jpush.cn/v1/app

请求示例

    curl  -X POST -v https://admin.jpush.cn/v1/app
          -H 'Content-type: application/json'
          -u 'd61988533983cbc7a2eceb0a:fb3ea2a1830d9731ef202a8f'
          -d '{"app_name":"myapp","android_package":"cn.jpush.app","group_name":"groupOne"}'
    > POST /v1/app HTTP/1.1
    > Authorization: Basic ZDYxOTg4NTMzOTgzY2JjN2EyZWNlYjBhOmZiM2VhMmExODMwZDk3MzFlZjIwMmE4Zg==

请求参数

请求参数为一个 App 对象，以 JSON 格式表达，包含的字段信息如下：

    {"app_name":"myapp","android_package":"cn.jpush.app","group_name":"groupOne"}

响应示例

    < HTTP/1.1 200 OK
    < Content-Type: application/json
    {"app_key":"dc51b6829206b2736e7e6d63","is_new_created":true,"android_package":"cn.jpush.app"}

响应参数

app 删除

功能说明

删除开发者账号下的指定 app

调用地址

POST https://admin.jpush.cn/v1/app/{appKey}/delete

请求示例

    curl https://admin.jpush.cn/v1/app/ffbb0932c267d938941e470b/delete
         -X POST
         -u devKey:devSecret

响应示例

    错误:{"error":{"code":1015,"message":"app delete fail"}}
    正确:{"success":"Synchronized success"}

证书上传

功能说明

使用该 API 开发者可上传证书到对应的极光 app

调用地址

POST https://admin.jpush.cn/v1/app/{appKey}/certificate

请求示例

    curl https://admin.jpush.cn/v1/app/ffbb0932c267d938941e470b/certificate
         -F "devCertificatePassword=your dev certificate passowrd"
         -F "proCertificatePassword=your pro certificate passowrd"
         -F "devCertificateFile=@your dev certificate file"
         -F "proCertificateFile=@your pro certificate file"
         -u '{devKey}:{devSecret}'

如果没有 dev 证书或 pro 证书，则不需要相应的 -F 参数及相应 password，只有 dev 证书的请求示例：

    curl https://admin.jpush.cn/v1/app/ffbb0932c267d938941e470b/certificate
         -F "devCertificatePassword=your dev certificate passowrd"
         -F "devCertificateFile=@your dev certificate file"
         -u 'devKey:devSecret'

请求参数

响应示例

    错误:{"error":{"code":1012,"message":"certificate invalid"}}
    正确:{"success":"Synchronized success"}

响应参数

错误码及错误信息

参考文档：HTTP-Status-Code