1 文档说明   
2 接口介绍   
3 开发指南      
4 接口参数   
4.1.1 AppServer发送消息到JCM接口   
4.1.2 App保存接口   
4.1.3 消息查询 API-1：消息列表查询    
4.1.4 消息查询 API-2     
4.1.5 删除未发送消息     
4.1.6 查询应用历史推送数     
4.1.7 停止应用     
4.1.8 启动应用     
4.1.9 获取应用标签列表     
4.1.10 添加或删除应用标签     
4.1.11 上传IOS推送证书文件     
4.1.12 删除IOS推送证书文件     
4.1.13 设置环境类型     
4.1.14 获取环境类型     
4.1.15 IOS注册接口     
4.1.16 IOS添加Tag接口     
4.1.17 IOS删除Tag接口

文档说明

1.1       功能描述

消息推送是云平台支撑平台，管理云平台账号扩展信息、用户权限信息等。

通过BOSS可以将云计算资源整合到统一系统并提供提供接口调用服务。

1.2       阅读对象

需要接入JMP对外提供服务的各项目开发人员。

1.3       业务术语

表1 业务术语

2.1      概述

完善中...

2.2      接口交互模式

图应用系统与接口的交互响应模式

1.构造接口参数

根据需要调用的接口，构造它的所需要的参数。

2.发送请求参数

应用程序向接口发送请求。

3.接口业务处理

接口服务器程序对本次接口请求进行响应的业务处理。

4.返回响应数据

API返回请求的数据。

5.对接口返回数据进行处理

应用程序根据返回的数据进行后续处理。

2.3      接口发布形式

3.1      开发环境

完善中...

3.2      接入方式

1.3      接入流程

3.4      接口测试

3.5      接口授权和约束

3.6      注意事项

4.1.1       AppServer发送消息到JCM接口

接口名称

POST http://jmp.jd.com/jcm/send

功能说明

发送消息到JCM

权限和约束

4.1.1.1 安全签名

AppServer 向消息推送(jcm)系统发送的http调用请求，都要做安全签名。

4.1.1.2 签名需求

为保障消息推送(JCM)系统的安全,维护用户合法权益,京东消息推送(JCM)要求所有的请求必须进行签

名。

4.1.1.3 签名的格式

签名的以如下形式保存在Http 请求的头内,发送给消息推送(JCM)系统。

Token: jingdong AppKey:Signature

其中jingdong为固定关键字

Signature 为摘要内容

注:AppKey 由京东消息推送(JCM)分发。AppKey 在所有的操作中都会被使用,并且会以明文

形式传输。用于标识用户身份。每位用户一个,不会重复。

4.1.1.4签名伪代码

计算的伪代码如下

StringToSign = HTTP-Verb + "\n" +// http 的请求动作

Content-MD5 + "\n" + // http 请求的Md5 值

Content-Type + "\n" + // http 请求的类型

Date + "\n" + // http 请求的时间

CanonicalizedResource; // http 请求的资源

其中

1) HTTP-Verb 表示http 的请求动作,目前我们支持"POST"

请求动作(不能为空)

2) Content-MD5 表示请求内容数据的MD5 值(可以为空)

3) Content-Type 表示请求内容的类型(可以为空)

4) Date 表示了此次操作的时间(不能为空)

6) CanonicalizedResource 表示http 请求中的资源(不能为空)

Signature =Base64(HMAC-SHA1(UTF-8-Encoding-Of(SecretKey, StringToSign ) ) );

token = "jingdong" + " "+ AppKey + ":" + Signature;

注:SecretKey 也由京东消息推送(JCM)分发,SecretKey 总是随同AppKey 一起分发,一个

AppKey 对应一个SecretKey。SecretKey相当于私钥,可通过其产生签名。因为出于安

全问题的考虑,对消息推送(JCM)的所有的操作都需要由SecretKey 签名摘要后才能有效,摘要信息将成为请求的一部分,发送给云系统。

4.1.1.5 抽取基本Http 请求字段

1) 抽取Http 请求中以下字段组成将被签名的字符串StringToSign

HTTP-Verb + "\n" + // http 的请求动作

Content-MD5 + "\n" + // http 请求的Md5

Content-Type + "\n" + // http 请求的类型

Date + "\n" + // http 请求的时间

注意除http请求动作和Date字段以外,其他2个字段为非必填字段,所以可能没有,

如果没有则以空字符代替

以下是一个简单的例子

http 请求如下

POST /jcm/send  HTTP/1.1

Date: Tue, 7 Mar 2011 11:16:31 +0000

所以第一步抽取后结果为

StringToSign = "POST\n" +

"\n" +

"\n" +

"Tue, 7 Mar 2011 11:16:31 +0000\n"

4.1.1.6 获取CanonicalizedResource

1) 获取请求的CanonicalizedResource

例如请求如

POST /jcm/send HTTP/1.1

Content-Type: image/jpeg

Date: Tue, 22 Mar 2011 11:58:15 +0000

那么CanonicalizedResource = “/jcm/send”

2) 将CanonicalizedResource 附加在StringToSign 后面

4.1.1.7 对StringToSign 进行摘要算法

1) 对StringToSign 进行UTF-8 编码

2) 以SecretKey 和StringToSign 为参数,进行HMAC-SHA1 摘要计算

3) 摘要结果进行Base64 编码得到最后的签名Signature

伪代码如下:

Signature =

Base64( HMAC-SHA1(UTF-8-Encoding-Of(SecretAppKey,StringToSign)));

输入参数

一个消息请求HTTPbody的格式是个JSON:

http body:

构建请求采用JSON格式

输出参数

当调用接口时，会进行简单的校验检查，并立即返回结果。

返回内容类型为字符串，形式为JSON，返回码为200，除非有其他异常如404/ 500 错误。

返回示例

错误码

错误码定义

接口名称

POST http://ip:port/jcm/saveapp

功能说明

导入App信息

权限和约束

无

输入参数

一个消息请求HTTPbody的格式是个JSON:

构建请求采用JSON格式

http body:

表获取用户登录状态输入参数

输出参数

返回示例

无

错误码

参看返回码说明

4.1.3消息查询 API-1：消息列表查询

接口名称

GET http://ip:port/jcm/msginfo?appid=应用名称[&page=页码&size=每页数量]

功能说明

用来查询本APP的消息，返回结果按发送时间排序

权限和约束

无

输入参数

表获取用户登录状态输入参数

输出参数

返回内容无具体信息内容。要查询具体消息内容，用下一个查询API.

页码从0开始。范围[0,200]. 可以没有，默认为0.超过范围也设置为0.

每夜数量[0, 200]。可以没有。默认为50.超出范围也设置为50.

Infolist具体一项内容：

{

"msgid":"525e6bfee138232a2d00051a1",

"type":"broadcast",

"receivecount":"10",

"responsecount":"6",

"centerduration":0.012372801000000001,

"sendtime":"2013-10-16T18:35:43+08:00",

"handletime":"2013-10-16T18:35:47+08:00",

"appid":"12435",

"handler":"192.168.195.72:9080",

"data":"{\"Content\":\"2222222222\",\"Title\":\"广播hello$^&*#,/1231381920705\"}",

"regids":[],

"tags":[],

"state":"sended",

"platform":"ios",

"formattype":1

}

返回示例

{"errcode":"0","errmsg":"调用成功",

"requestid":"525f876ae138232a2d00051d","totalcount":100,

"infolist":[

{"msgid":"525e6bfee138232a2d00051a1","type":"broadcast","receivecount":"10","responsecount":"6","centerduration":0.012372801000000001,"sendtime":"2013-10-16T18:35:43+08:00","handletime":"2013-10-16T18:35:47+08:00","appid":"12435","handler":"192.168.195.72:9080","data":"{\"Content\":\"2222222222\",\"Title\":\"广播hello$^&*#,/1231381920705\"}","regids":[],"tags":[],"state":"sended","platform":"ios","formattype":1},{"msgid":"525e6bfee138232a2d00051b1","type":"broadcast","receivecount":"10","responsecount":"6","centerduration":0.013437189,"sendtime":"2013-10-16T18:35:43+08:00","handletime":"2013-10-16T18:35:47+08:00","appid":"12435","handler":"192.168.195.72:9080","data":"{\"Content\":\"2222222222\",\"Title\":\"广播hello$^&*#,/1231381920704\"}","regids":[],"tags":[],"state":"sended","platform":"ios","formattype":1}]

}

调用示例

错误码

参看返回码说明

消息查询API-2：消息具体查询

接口名称

GET  http://ip:port/jcm/msginfo?msgid=消息名称

功能说明

此API用来查询具体消息的内容。

权限和约束

无

输入参数

表获取用户登录状态输入参数

输出参数

返回示例

{

"errcode":"0",

"errmsg":"调用成功",

"requestid":"525f88c9e138232a2d00051e",

"detail":{

"msgid":"525e6bfee138232a2d00051a1","type":"broadcast","receivecount":"10","responsecount":"6","centerduration":0.012372801000000001,"sendtime":"2013-10-16T18:35:43+08:00","handletime":"2013-10-16T18:35:47+08:00","appid":"13454","handler":"192.168.195.72:9080","data":"{\"Content\":\"2222222222\",\"Title\":\"广播hello$^&*#,/1231381920705\"}",

"regids":[],"tags":[],"state":"sended","platform":"ios","formattype":1},

"responselist":null

}

调用示例

错误码

参看返回码说明

接口名称

GET  http://ip:port/jcm/delmsg?appid=应用名称&msgid=消息名称

功能说明

此API用来删除还未发送消息。

权限和约束

只能删除消息状态为waited的消息。

输入参数

表获取用户登录状态输入参数

输出参数

返回示例

无

调用示例

错误码

参看返回码说明

接口名称

GET  http://ip:port/jcm/report?appid=应用号&start=开始时间&end=结束时间

功能说明

此API用来查询该应用的消息推送情况。

权限和约束

无

输入参数

表获取用户登录状态输入参数

输出参数

返回示例

{"errcode":"0","errmsg":"调用成功",

"requestid":"525f89e8e138232a2d00052b","infolist":

[

{"appid":"34345","receivecount":"0","responsecount":"37","iosreceivecount":"67","iossendcount":"0","date":"2013-10-08T09:00:00+08:00"},

{"appid":"34345","receivecount":"0","responsecount":"4","iosreceivecount":"121","iossendcount":"116","date":"2013-10-09T09:00:00+08:00"},

{"appid":"34345","receivecount":"0","responsecount":"0","iosreceivecount":"10","iossendcount":"10","date":"2013-10-10T09:00:00+08:00"},

{"appid":"34345","receivecount":"0","responsecount":"0","iosreceivecount":"20","iossendcount":"20","date":"2013-10-11T09:00:00+08:00"},

{"appid":"34345","receivecount":"0","responsecount":"0","iosreceivecount":"0","iossendcount":"0","date":"2013-10-12T09:00:00+08:00"},

{"appid":"34345","receivecount":"0","responsecount":"0","iosreceivecount":"0","iossendcount":"0","date":"2013-10-13T09:00:00+08:00"}

]}

调用示例

错误码

参看返回码说明

接口名称

GET  http://ip:port/jcm/stopapp?appid=应用号

功能说明

此API用来停止应用的消息推送功能。

权限和约束

无

输入参数

表获取用户登录状态输入参数

输出参数

1.1.1       启动应用

接口名称

GET  http://ip:port/jcm/startapp?appid=应用号

功能说明

此API用来启动应用的消息推送功能。

权限和约束

无

输入参数

表获取用户登录状态输入参数

输出参数

接口名称

GET http://jmp.jd.com/jcm/apptag？appid=xx&operate=get

功能说明

设置环境的类型

权限和约束

输入参数

输出参数

当调用接口时，会进行简单的校验检查，存入成功后返回。

返回内容类型为字符串，形式为JSON，返回码为200，除非有其他异常如404/ 500 错误。

Eg:

{"errcode":"0","errmsg":"调用成功",

"requestid":"52944064e1382337bb000015",

"num":3,"tags":["cloth","food","tool"]}

接口名称

GET http://jmp.jd.com/jcm/apptag？appid=xx&operate=xx&tag=xx

功能说明

设置环境的类型

权限和约束

输入参数

 输出参数

当调用接口时，会进行简单的校验检查，存入成功后返回。

返回内容类型为字符串，形式为JSON，返回码为200，除非有其他异常如404/ 500 错误。

Eg:

{"errcode":"0","errmsg":"调用成功","requestid":"5294402ae1382337bb000012"}

接口名称

POST http://jmp.jd.com/jcm/upload

功能说明

上传IOS生成的证书文件到JMP，上传证书是推送到IOS系统的先决条件

权限和约束

上传成功后，需要设置环境类型

必要设置

enctype="multipart/form-data",method=post, type="file"

输入参数

一个消息请求HTTP body的格式是个JSON:

http body:

构建请求采用JSON格式

输出参数

当调用接口时，会进行简单的校验检查，存入成功后返回。

返回内容类型为字符串，形式为JSON，返回码为200，除非有其他异常如404/ 500 错误。

接口名称

POST http://jmp.jd.com/jcm/delcert

功能说明

删除上传的IOS证书文件

权限和约束

删除成功后需要更新环境类型

必要设置

输入参数

一个消息请求HTTPbody的格式是个JSON:

http body:

构建请求采用JSON格式

输出参数

当调用接口时，会进行简单的校验检查，存入成功后返回。

返回内容类型为字符串，形式为JSON，返回码为200，除非有其他异常如404/ 500 错误。

接口名称

GET http://jmp.jd.com/jcm/setenv？appid=xx&activetype=x

功能说明

设置环境的类型

权限和约束

输入参数

输出参数

当调用接口时，会进行简单的校验检查，存入成功后返回。

返回内容类型为字符串，形式为JSON，返回码为200，除非有其他异常如404/ 500 错误。

接口名称

GET http://jmp.jd.com/jcm/getenv？appid=xx

功能说明

设置环境的类型

权限和约束

输入参数

输出参数

当调用接口时，会进行简单的校验检查，存入成功后返回。

返回内容类型为字符串，形式为JSON，返回码为200，除非有其他异常如404/ 500 错误。

Eg:

{"errcode":"0","errmsg":"调用成功",

"requestid":"52284730e13823073a000003",

"activetype":1,

"validecerts":[1,2]}

接口名称

POST http://ip:port/query

功能说明

设置环境的类型

权限和约束

输入参数

一个消息请求HTTPbody的格式是个JSON:

http body:

构建请求采用JSON格式

输出参数

成功：success

不成功：错误信息

接口名称

POST http://ip:port/query

功能说明

设置环境的类型

权限和约束

输入参数

一个消息请求HTTPbody的格式是个JSON:

http body:

构建请求采用JSON格式

输出参数

成功：success

不成功：错误信息

接口名称

POST http://ip:port/query

功能说明

设置环境的类型

权限和约束

输入参数

一个消息请求HTTPbody的格式是个JSON:

http body:

构建请求采用JSON格式

输出参数

成功：success

不成功：错误信息