京东云鼎
消息推送服务
点击观看视频课程
消息推送是京东商家开放平台为提高应用API调用效率而推出的一种主动推送服务,推送内容包括(京东订单、商品、退款等信息),基于该推送服务,应用获取京东数据不需再不停轮询API,仅需在接收到京东推送的消息时调用API获取即可,大大提高API调用效率和降低API使用费用。
注意:当前消息服务免费提供给开发者使用,topic拥有人为商家开放平台,费用由开放平台承担。
使用参考文档列表
1、消费方接入文档:https://open.jd.com/v2/#/doc/guide?listId=1903
2、消费接入FAQ文档(消息收不到、丢失):https://open.jd.com/v2/#/doc/guide?listId=1881
3、消费程序对接指引:https://docs.jdcloud.com/cn/message-queue/product-overview
4、消费SDK代码demo下载:https://docs.jdcloud.com/cn/message-queue/demo
5、JCQ的SDK接入常见问题(超时、网络不通、topic not exist、程序报错等): https://docs.jdcloud.com/cn/message-queue/faq
6、各类消息文档:https://open.jd.com/v2/#/doc/msgApi?apiCateId=81&apiId=276
7、授权消息怎么授权?https://open.jd.com/v2/#/doc/guide?listId=1908
订单类消息汇总:
编号 | 开放MQ | 说明 | 其他注意 | 文档地址 |
---|---|---|---|---|
1 | pop_order_create(POP订单创建消息) | POP店铺产生订单后(未付款),会推送该消息通知开发者,开发者可以通过POP订单接口获取最新的订单消息。 | https://open.jd.com/v2/#/doc/msgApi?apiCateId=81&apiId=183 | |
2 | order_order_cancel(订单取消消息) | 支持的订单类型:22:SOP,75:LOC,21:FBP,112:FCS,142:IBS。场景:未支付取消,用户主动取消,退钱场景。不包括订单拆分取消 | 主单是自营和pop混合单时不会下发,拆单后下发POP订单 | https://open.jd.com/v2/#/doc/msgApi?apiCateId=81&apiId=128 |
3 | order_order_pay(订单支付消息) | 订单付款状态或金额发生变更,支持的订单类型:22:SOP,75:LOC,21:FBP,112:FCS,142:IBS,需配合订单接口获取订单最新状态,需要做消息幂等。 | 主单是自营和pop混合单时不会下发,拆单后下发POP订单 | https://open.jd.com/v2/#/doc/msgApi?apiCateId=81&apiId=130 |
4 | pop_order_change(POP订单变更消息) | 等待出库->等待发货-等待确认收货->完成。订单状态变更消息。从等待出库状态开始,订单变更触发,支持的订单类型如下: 22:SOP,75:LOC,21:FBP,112:FCS,142:IBS | 从待出库状态开始,订单变更触发包括-等待出库\等待发货\等待确认收货\完成 | https://open.jd.com/v2/#/doc/msgApi?apiCateId=81&apiId=115 |
5 | pop_order_out(POP订单出库消息) | POP订单出库消息,支持的订单类型:22:SOP,75:LOC,21:FBP,112:FCS,142:IBS | https://open.jd.com/v2/#/doc/msgApi?apiCateId=81&apiId=127 | |
6 | pop_order_remk_chg(POP订单商家备注消息) | POP商家的订单备注发生变化时,会进行消息的推送。 | https://open.jd.com/v2/#/doc/msgApi?apiCateId=81&apiId=165 | |
7 | pop_order_promise(可选-晚发赔功能使用) | pop订单在不同的环节触发时效计算后的最新时效。 | 时效计算时会触发,触发环节:1-订单转移、3-订单可见、5-承运商揽件、6-订单修改、7-紧急报备、17-催单协商 | https://open.jd.com/v2/#/doc/msgApi?apiCateId=81&apiId=276 |
8 | ORDER_ADDR_MODIFY(消费者主动修改地址推送) | 消费者主动发起修改收货地址、收件人姓名、电话,从未支付状态开始支持,仅支持POP。附对应接口: POP订单列表查询:jingdong.pop.order.search 单个POPSOP订单详情查询:jingdong.pop.order.get | https://open.jd.com/v2/#/doc/msgApi?apiCateId=81&apiId=274 |
一. 条件与准备
- 条件:
a) 正式数据仅支持内网通知与推送,所以需要入鼎。
(云鼎内服务器可以使用平台提供的SDK接入,公有云集群只能通过https方式拉取消费。特殊情况:如果在京东云外使用,消费时只能自行通过http接口轮询拉取不能使用sdk,在开放控制台订阅topic时必须选择公有云集群,平台建议在云鼎内使用)
b) 平台建议优先使用华北机房,(其中华东机房仅支持云鼎内使用,公有云不支持华东)。华南地域不支持,请开发者在华北机房接收后自行转发,或通过公有云华北集群 https方式访问。
c) Java语言可使用SDK,非Java需要使用http请求API来接收消息
- 准备:
a) 京东云账号(需要设置账号的Access Key),用来接收消息
b) 至少一个商家Pin对订阅消息的Appkey授权,JDO会根据此Appkey生成Topic,并向该Topic推送此商家的消息
c) 消息推送Demo示例,请参见https://docs.jdcloud.com/cn/message-queue/demo
d) 请在”文档中心“—>"常用文档”—>"消息体文档“获取消息体信息
e) 订阅半小时后实际生效,才能收到消息
二. 使用流程
1.注册京东云账户,创建账户秘钥
使用京东账户登录京东云鼎https://yd.jdcloud.com/#/,右上角账号处单击,选择“Access Key管理”。
建议选择“继续使用”(部分功能子账号不支持)。
点击 “创建Access Key”。
注意:请保存好已经创建的京东云Access Key ID与Access Key Secret,在后续的开发者控制台消息配置中将会用到;
2.在开放平台控制台(http://open.jd.com)根据业务需求创建对应的应用类型。
通过审核后在应用列表中选择对应的应用点击 “管理”。
查看该应用的Appkey
3.应用订阅消息
在开发者控制台应用应用列表中选择对应的应用,通过管理入口进入到应用菜单,选择消息服务下的“订阅消息”。
点击需要查看的消息主题的“消息文档”可以查看该主题的消息体字段信息。
选择需要订阅的消息主题后点击订阅,此处需要填入京东云Access Key ID与Access Key Secret(查找方式请查阅本章第1部分内容),系统会校验账户关联与信息准确性,请开发者务必填写准确。
云账号名-获取方式如下:
访问地址:https://uc.jdcloud.com/account/basic-info
AccessKeyID\AccessKeySecret-获取方式
地址:https://uc.jdcloud.com/account/accesskey
4.管理我订阅的消息
点击我的订阅进入消息管理界面,订阅状态包括订阅成功、订阅失败、审核中三种;订阅成功的消息体可以取消订阅,订阅失败的消息可以重新订阅,审核中的消息体审核完成后状态会变更为订阅成功或者订阅失败。
5.消息配置信息查看
消息主题名称(topic)、消费者组ID(consumerGroupId)、SDK接入点,在 我的订阅-订阅信息 中查看。
注意:如果该消息没有权限,则说明应用未开通相关API调用权限,可以在应用内查看并申请相应的权限包。
6.查看消息体文档
查看消息文档也可在文档中心—>常用文档—>消息体文档获取文档信息
7.消息查询
8. 授权类消息如何授权?
授权操作步骤文档:https://open.jd.com/v2/#/doc/guide?listId=1908
授权有效期查询工具:https://open.jd.com/v2/#/doc/guide?listId=token