新手指南更新时间:2016-10-31 

一、入驻成为开发者

要使用千米开放平台任何设施,首先要成为开放平台的开发者。如果您已经是千米网用户,可以直接登录开放平台控制台入驻,不需要再次注册;如果您是作为第三方ISV入驻,需要新注册开发者账号。

点击右上角"注册"按钮,或者"立即加入"进入开发者账号注册页面。

E生活业务接入

1)开发者账号:E生活BOSS账号,A开头。

2)接入版本:E生活接口版、E生活旗舰版。

3)应用标签:仅E生活-商家后台应用。

电商云业务接入

电商云业务接入根据应用类型分为商家后台应用和在线订购应用:

商家后台应用:提供给具备开发能力的电商云商家,开发基于自己店铺的电商工具软件的需求接入。

在线订购应用:提供给第三方ISV,开发基于千米电商云平台的电商工具应用,并将应用发布到千米商家服务市场,提供给千米商家订购使用的需求接入。

1)开发者账号:电商云账号(开发者账号),A开头。

2)接入版本:云商城、云订货系统可接入,云小店暂时不支持接入。

3)应用标签:根据实际业务需要可选择商家后台或者在线订购。

二、熟悉接入指南

接入指南文档下载

根据自己应用实际功能,选择合适的标签接入,只有明确接入方式才能快速高效的接入开放平台。

例如:

1)准备开发一个话费充值、水电煤缴费、固话宽带充值、火车票等便民缴费系统,可以选择参考"E生活业务接入"文档说明的接入流程进行开发,测试,发布。

2) 准备开发一个商品订单管理、进销存、ERP、物流发货工具系统,并且想提供给其他商家订购使用,可以参考"电商云业务接入"文档中说明的接入流程进行开发,测试,发布。

E生活接入指南:

为了更好的服务E生活接入用户,我们提供了千米开放平台接入指南,请E生活接口用户在对接之前务必熟悉指南文档,按照指南流程操作,以免不必要的麻烦。

千米开放平台接入指南(E生活)-pdf版

电商云技术开发白皮书:

为了更好的服务电商云开发者接入,开放平台小组编撰了开放平台技术开发规范白皮书,请电商云用户接入参考白皮书中的规范要求,按照流程操作,以免不必要的麻烦。

千米开放平台技术开发规范白皮书-pdf版

三、创建应用

根据接入指南或者白皮书中的要求,在完成应用创建前的一些前置设置或者认证以后,可以直接在控制台-创建应用页面进行创建

填写应用名称,选择好标签,完成应用创建。

四、获取AppKey和AppSecret

应用创建完成,进入应用管理,在证书管理页面可以查看appKey和appSecret

在实际开发之前,您需要补充应用的基本信息,包括应用图标、商家授权回调地址等(可选)

回调地址的主要作用是在使用开放平台oAuth2.0授权获取或AccessToken时,服务器会将登陆授权成功后的信息返回给回调地址

五、开发测试

API文档结构

包括API的调用方式,和API文档本身,API为HTTP(或HTTPS)接口调用方式

一个完整的API文档包括以下内容:

  • 当前API是否需要授权(调用当前API是否需要传access_token参数)。
  • 调用API的系统级参数(所有API调用均需要传的一些公共入参)。
  • 当前API相关的业务级参数。
  • 当前API的请求示例(仅仅是SDK示例)。
  • 当前API的相应参数(返回值,点击可展开查看字段详情)。
  • 当前API的响应示例(返回示例json)。
  • 当前API可能返回的业务异常。
  • 当前API的FAQ补充问题描述。
相关技术文档

如何正确的调用API,查阅:API调用详解

如何使用官方SDK进行开发,查阅:SDK使用说明

什么叫用户授权,查阅:用户授权介绍

如何使用消息服务,查阅:消息服务使用说明

六、发布上线

应用开发测试完毕以后,您需要将应用发布上线,未上线的应用限制API的调用流量为5000次/天,商家后台应用可直接在应用向导中发布,在线订购应用需要在完成应用发布以后,将应用发布到服务市场给商家订购。

七、常见问题

一:QMOP的API是采用的什么协议?支持哪些接入终端?

QMOP的接口基本约定如下:

通讯协议: HTTP协议,查询类接口请使用GET方式,操作类请使用POST方式。

编码格式: 所有请求/响应均为 UTF-8。

数据格式: 为了减少网络开销,使用JSON数据格式。

SDK工具包: 提供了常用的 JAVA、PHP、.NET等SDK,请优先使用SDK进行开发。

接入终端: pc端、app(ios,android)端、微信公众号等其他第三方平台或系统均可接入

 

二:E生活便民应用第三方会员充值缴费,怎么实现?

由于第三方应用/平台上面的会员不是千米网的会员用户,所以不直接跟千米网直接产生交易,需要通过BOSS用户作为中间人进行交易,我们推荐的第三方充值缴费应用/平台的对接流程如下:

1:E生活BOSS商家在BOSS后台对接好商品(货源)、查询模板、建立直销商账号(用于千米网授权账号对接),该步骤必须;

2:第三方应用/平台给您的会员提供话费、水电煤等查询功能,后台调用千米开放平台查询话费、水电煤等账户信息,该步骤可选;

3:第三方应用/平台提供本地下单,支付功能(支付网关需要自己对接,本地交易资金直接本地结算,资金入第三方应用);

4:第三方应用/平台调用千米开放平台下单、支付接口(直销商余额支付),第三方订单编号可作为外部订单号传入,第三方应用需要保存生成的千米订单或者做关联映射;

5:订单支付成功,需要通过开放平台消息服务监听充值订单充值状态变更消息,及时更新本地订单数据。

6:对于异常订单,如果充值失败,千米会原路退回直销商账号余额,第三方应用/平台需要及时跟千米客服反馈,核实订单,处理本地订单退款事宜。

 

三:E生活充值订单我如何知道成功还是失败了?是否有回调功能

回调方式受限于被回调方系统的稳定性,可靠性,网络超时等原因,QMOP为了保证整个平台的高并发稳健运行,根据千米自身架构特点,研发了目前业内领先的主动通知服务(异步消息通知),采用主动推送消息方式(SDK)+API拉取消息方式两种方式获取消息通知,充值成功以后,QMOP会通过消息服务将订单的充值状态推送到ISV应用,详情请查看"消息服务使用说明"文档。