糯米网站外码对接接口文档.docxVIP

API-站外码对接接口文档接口名称站外码对接接口接口负责人作者庞彤彤文档提交日期2014/04/09修改记录No修改后版本号修改内容简介修改日期修改人1V1.0初稿2014.4.09庞彤彤V2.02014.6.26李红序目 录1概述12站外码对接接口12.1券验证状态通知接口12.1.1接口基本信息12.1.2请求参数说明22.1.3返回字段说明22.2券生效状态查询接口32.2.1接口基本信息32.2.2请求参数说明32.2.3返回字段说明3概述采用http协议交互，用json传输和展现数据，所有请求请用post请求方式。通过/提供的key进行认证，即使用者需要先在这个平台申请一个key，后续用这个key就可以直接访问。后续会升级安全方案，在此之前请保管好key。申请流程：首先访问/，登录之后点击API控制台，如下图：然后点击创建秘钥，token就是生成的访问密钥(ak)，userName则是你的用户名，在页面右上角可以看到。申请完成之后，接下来请拿到你的token和用户名联系我们这边的RD，给你的账号添加访问权限，之后你就可以访问api了，访问地址例如：/lbs-api/yyyy/zzz.action?auth={userName:,token:}data={xxxxxxxxxxx}，使用utf-8编码返回结果的json串包含3个对象，code，info和res（每个接口返回的res对象都不一样），其中code是0表示成功，info为success，可以直接取res的object结果，code为其他值表示有问题，info中会给出详细信息。站外码对接接口券验证状态通知接口接口基本信息接口名/tapi/tuan/out/cert/sitecode/update线下地址73:8085/tapi/tuan/out/cert/sitecode/update线上地址/tapi/tuan/out/cert/sitecode/update请求方式POST编码类型UTF-8请求参数说明参数名称参数含义类型必须备注auth认证信息json格式对象是包含信息如下userName用户名String是token访问密钥String是dealId团单IDLong否code券码String是userName供应商名称String是phone供应商电话String是返回字段说明示例{ code: 0, info: success, res: { errCode: 0，errMsg:消费成功,“dealId”:”团单ID”“code”:”券码”}}字段名称字段含义类型必须备注code状态码Int是0：正常400：请求参数错误500：服务异常info描述信息String否res返回结果对象Json否 res中详细信息描述如下：字段名称字段含义类型必须备注errCode更新结果Int是0 消费成功， 1消费失败errMsg返回信息String是dealId团单IDLong是code更新的券码String是券生效状态查询接口接口基本信息接口名/tapi/tuan/out/cert/sitecode/query线下地址73:8085/tapi/tuan/out/cert/sitecode/query线上地址/tapi/tuan/out/cert/sitecode/query请求方式POST编码格式UTF-8请求参数说明参数名称参数含义类型必须备注auth认证信息json格式对象是包含信息如下userName用户名String是token访问密钥String是dealId团单IDLong否code券码String是userName供应商名称String是phone供应商电话String是返回字段说明示例{ code: 0, info: success,res: {“code”:”券码”,“dealId”:”团单ID”,“status”:”状态”,“useTime”:”使用时间”,“expireTime”:”过期时间”}}字段名称字段含义类型必须备注code状态码int是0：正常400：请求参数错误500：服务异常info描述信息String否res返回结果对象Json否 res中详细信息描述如下：字段名称字段含义类型必须备注code券码String是dealId团单IDLong是status券码状态Int否0 未消费1 已消费-2 已退款-3 不存在useTime使用时间Int否Linux时间戳，默认为0expireTime过期时间Int否Linux时间戳，默认为0