当前位置:文档之家› 天宏一卡通支付接口说明文档V1.0.2

天宏一卡通支付接口说明文档V1.0.2

天宏一卡通支付接口说明文档V1.0.2
天宏一卡通支付接口说明文档V1.0.2

1引言

1.1 编写目的

文档历史

修订日期修订内容修订版本修订人2010-7-1 创建 1.0.1 lvzhe 2010-7-14 修改支付金额为可选参数。 1.0.2 lvzhe 本文档说明了如何通过网关系统和天宏公司一卡通游戏充值系统进行对接。

2协议概述

2.1 协议列表

协议名称说明销售协议充值一卡通的协议

2.2 协议的交互逻辑

华彤商家

销售请求

销售结果

3销售协议

3.1 协议说明

协议采用HTTP协议,经销商将请求报文post或get到天宏的一卡通充值的80端口:

正式地址:

支付地址:https://www.doczj.com/doc/6f8112597.html,/gateway/ECard_PayGate.do

单笔查询地址:https://www.doczj.com/doc/6f8112597.html,/gateway/ECard_QueryGate_Single.do

批量查询地址:https://www.doczj.com/doc/6f8112597.html,/gateway/ECard_QueryGate.do

url示例:

https://www.doczj.com/doc/6f8112597.html,/gateway/ECard_PayGate.do?username=***&productid=***&cknum=***&kahao1=*** &mima1=*** &buynum=*** &orderNum=***&addition=***&returnUrl=*** &md5toself=***

https://www.doczj.com/doc/6f8112597.html,/gateway/ECard_QueryGate_Single.do?userName=***&orderNum=***&md5toself=***

https://www.doczj.com/doc/6f8112597.html,/gateway/ECard_QueryGate.do?userName=***&productID=***&eCardNum=*** &buyNum=***&orderNum=***&startDate=***&endDate=***&ip=***&pageCount=***&pageIndex=***& md5toself=***

测试地址:

支付地址:http://222.222.59.248/ECardPay/gateway /ECard_PayGate.do

单笔查询地址:http://222.222.59.248/ECardPay/gateway / ECard_QueryGate_Single.do

批量查询地址:http://222.222.59.248/ECardPay/gateway / ECard_QueryGate.do

3.1.1支付接口调用说明

支付接口参数说明:

输入参数数据类型说明是否必填

username varchar(20) 商户名Y

productid Int 产品类型,请和公司申请Y

cknum Int 一卡通张数Y

kahao1 mima1 kahao2 mima2

*

*

* varchar(50) 一卡通卡号密码

(最多支持5张一卡通组合充值支付)

Y

buynum Int 购买数量(按元计算,1=1元)

orderNum varchar(50) 商户订单号Y addition varchar(50) 附加信息

returnUrl varchar(200) 回调地址

md5toself Int 数字签名Y

调用说明:

1.所有字段中不能包含“&”和“=”

https://www.doczj.com/doc/6f8112597.html,ername:商户名,例如huatong

3.productid:表示产品类型,真实产品ID请和天宏公司索要。

4.cknum:本次充值所提交的一卡通数量,请注意和kahao、mima字段要保持一致。

5.kahao\mima:所提交的一卡通卡号密码,形式为kahao1、kahao2…….mima1、mima2……,,其中

密码为MD5(32位)加密后的结果卡号密码提交前请务必请转换成大写。

6.buynum:充值数量表示充值1面值卡的张数,取值范围[1, 500]。可选参数,不传时默认全额支

付(支付所传一卡通的所有余额)。

7.orderNum: 商户订单号

8.addition: 附加信息

9.returnUrl: 回调地址,用于异步调用时的回调。

10.md5toself为按顺序对交易信息的MD5加密签名的32位字符串:

md5toself =md5(username=***&productid=***&cknum=***&kahao1=***&mima1=*** &buynum=*** &orderNum=***&addition=***&returnUrl=*** ||enc_key) 。

●可选参数如果不传的话,不能包含在加密串中。

●其中enc_key为双方约定的key,用于验证交易的合法性,请和天宏公司申请。

3.1.2支付接口返回结果说明

返回结果是xml格式数据字符串

1

成功!

10

充值结果代码结果说明

0 未知异常

1 成功

-1 参数验证异常

-2 一卡通验证异常

-3 账户验证异常

-4 支付类型验证异常

-5 订单验证异常

-6 支付操作异常

3.1.3查询接口调用说明

1.单笔查询接口参数说明:

输入参数数据类型说明默认值是否必填userName varchar(20) 商户名Y

orderNum varchar(50) 商户订单号Y

md5toself Int 数字签名Y

调用说明:

1.所有字段中不能包含“&”和“=”

https://www.doczj.com/doc/6f8112597.html,erName:商户名,例如huatong

3.orderNum: 商户订单号

4.md5toself为按顺序对交易信息的MD5加密签名的32位字符串:

md5toself =md5(userName=***&orderNum=***||enc_key) 。

其中enc_key为双方约定的key,用于验证交易的合法性,请和天宏公司申请。

2.批量查询接口参数说明:

输入参数数据类型说明默认值是否必填userName varchar(20) 商户名Y

productID Int 产品类型,请和公司申请0

eCardNum varchar(50) 一卡通卡号

buyNum Int 购买数量(按元计算,1=1元)0

orderNum varchar(50) 商户订单号

startDate varchar(50) 开始时间

endDate varchar(50) 截止时间

ip varchar(50) 支付ip地址

pageCount int 每页数量100(暂定)

pageIndex int 页码 1

md5toself Int 数字签名Y

调用说明:

5.所有字段中不能包含“&”和“=”

https://www.doczj.com/doc/6f8112597.html,erName:商户名,例如huatong

7.productID:表示产品类型,真实产品ID请和天宏公司索要。

8.eCardNum:所提交的一卡通卡号。

9.buyNum:充值数量表示充值1面值卡的张数,取值范围[1, 500]

10.orderNum: 商户订单号

11.startDate: 开始时间

12.endDate: 截止时间

13.ip: 支付时的ip地址

14.pageCount:每页记录数

15.pageIndex:当前页码

16.md5toself为按顺序对交易信息的MD5加密签名的32位字符串:

md5toself =md5(userName=***&productID=***&eCardNum=*** &buyNum=*** &orderNum=***&startDate=***&endDate=*** &ip=***&pageCount=***&pageIndex=***||enc_key) 。

●可选参数如果不传的话,不能包含在加密串中。

●其中enc_key为双方约定的key,用于验证交易的合法性,请和天宏公司申请。

3.2 返回结果说明

返回结果是Xml格式数据字符串

1.单笔查询:

1

查询成功!

2.批量查询

1

查询成功!

4

30

1

1

1.Code: 返回值编码

2.Msg: 返回信息

3.totalCount: 记录总数

4.perPageCount: 每页记录数

5.pageIndex: 当前页码

6.md5Key: md5加密的数据信息。用于单笔查询中的安全认证。

规则:

md5Key = md5(userName=***&buyNum=***&orderNum=***&payDate=***

&code=***||enc_key)

其中enc_key为双方约定的key,用于验证交易的合法性,请和天宏公司申请。

7.items: 数据明细节。用于显示数据的详细信息。例如:

test

1

GC0706100328

1

2010/7/7 16:12:29

11

aaa

http://localhost:3039/port27399/gateway/ReturnPa ge.aspx

查询结果代码结果说明

1 成功

0 未知异常

-1 系统检测到不安全的字符!

-2 用户名不能为空!

-3 参数类型错误!

-4 md5串格式错误!

-5 用户验证失败!

-6 ip地址校验失败!

-7 md5校验失败!

http接口说明模板

一、查询菜品列表接口(DONE) 1、功能说明 接受提供的菜品 XXX画面XXX功能(比如人口查询画面-查询 | 人口查询画面-详细等) 2、接口调用说明 2.1获取地址 http://192.168.0.6:8080/FamilyServiceSystem/BookDinnerQueryAction?ope ration=queryServiceItem 2.2http请求方式 GET 2.3数据返回格式 JSON 2.4传递参数

2.5成功返回结果 [ “serverResponse”:”Success”, “totalRecords”:”52”, “page” : “10”, “pageSize” : “5”, “data”:{ “id” : “123”, “itemName” : “皇堡”, “priceNow” : “10”, “pricePast” : “12”, “servicePicture” :”s9118668.jpg”, “serviceStars” : “3” }, ……. { “id” : “”, “itemName” : “”, “priceNow” : “”, “pricePast” : “”, “servicePicture” :” s9118668.jpg”,

“serviceStars” : “3” } ] 2.6返回结果解释 二、查询广告接口(DONE) 1、功能说明 接受广告图片,目前为一张 2、接口调用说明 2.1获取地址 http://192.168.0.6:8080/FamilyServiceSystem/BookDinnerQueryAction?ope ration=queryAdvertisePicture

接口调用说明文档

XXX)科技有限公司 数据接口 2015-5-26

目录 第1章引言. ......................................................... 错误!未定义书签。 背景. ........................................................... 错误!未定义书签。 第2章接口与数据定义. ................................................... 错误!未定义书签。 曝光台查询接口. ..................................................... 错误!未定义书签。 曝光台列表查询.......................... 错误!未定义书签。 曝光台详情查询.......................... 错误!未定义书签。 信用公示查询接口定义.......................... 错误!未定义书签。 守信公示列表查询.......................... 错误! 未定义书签。 守信公示详情查询.......................... 错误!未定义书签。 失信公示列表查询.......................... 错误!未定义书签。 失信公示详情查询.......................... 错误!未定义书签。 企业名称查询接口定义.......................... 错误!未定义书签。 Webservice 方法定义 ........................ 错误! 未定义书签。 请求参数. .................................................... 错误! 未定义书签。 返回数据. .................................................... 错误!未定义书签。 企业信息查询接口定义.......................... 错误!未定义书签。 Webservice 方法定义 ........................ 错误! 未定义书签。 请求参数. .................................................... 错误! 未定义书签。 返回数据. .................................................... 错误!未定义书签。

海康威视摄像头HTTP接口能力调研报告

视频监控平台调研报告【海康】

目录

1.前言 本次从海康租借了一台硬盘录像机、一个枪机和一个球机。由于对方HTTP告警消息模块有BUG,调测花费时间较长。对方提供升级测试版本后已经解决。从目前的进展情况看基本完成了我们的预期目标。主要常用功能均已验证通过,包括:视频监控(VLC插件方式)、录像回放、读取设备信息、设备重启、图像抓拍、告警通知、云台控制。本次报告主要目的是记录相关功能具体实现和验证的方式方法及注意事项。 2.部署情况 租借的三台设备均部署在五层实验室,通过无线路由器连接到公司网络。 1)账号信息 设备类型设备型号IP地址管理账号密码 枪机DS-2CD2T20-I3admin Nuctech123 录相机DS-8608N-E8admin Nuctech123 球机DS-2DE7184-A admin Nuctech123 2)设备部署&端口映射 3)设备配置注意事项 IPC和NVR均需要通过修改管理员密码才可以激活,然后接入网络; 录相机(NVR)标准配置都是不带硬盘,所以需要事先准备好SATA硬盘; 录相机(NVR)在接入枪机时,自动识别的设备协议为“海康协议”但实际需要根据说 明书修改为ONVIF才可以,否则会一直报“未知错误“; 枪机(IPC)须另备 DC12V Φ圆头电源; 设备因为是租借来的,所以不是全新,建议配置调试之前先做出厂设置; 设备默认出厂IP均为: 3.视频监控

3.1主码流与字码流 主码流与子码流是海康威视提出的概念,是为了解决在网络情况不好时为了满足远程预览的流畅性,而不影响本地录像提出的双码流技术,主码流分辨率高于子码流,主码流用来录像,子码流用来网传,默认客户端访问采用主码流,客户可以根据网络情况选择子码流访问,以达到改善网络浏览的流畅性,而又不改变本地录像的录像效果。 3.2RTSP地址格式 (1)摄像头(IPC/IPD) 地址格式: username: pwd @ ip: port [554]/h264/ch1/码流类型/av_stream 码流类型:main表示为主码流,sub表示为子码流 举例: IPC主码流: number >,1-32是模拟通道,33以后是IP通道。 举例: IPC@NVR:举例: ,设备 信息和配置推荐使用ISAPI接口,云台控制则推荐使用CGI接口。 接口入口地址:,GET表示读取当前信息、PUT表示更新配置、POST表示创建数据、DELETE表示删除配置。 3.3设备信息 3.3.1基本信息 调用地址:/ISAPI/System/deviceInfo IP DOME ef947dd1-f70b-11b4-83a0-c056e38ef866 IPDome STD-CGI STD-CGI DS-2DE7184-A DS-2DE7184-ACCCH5 c0:56:e3:8e:f8:66 build 150129 build 141009

帝国CMS版接口说明

帝国CMS接口使用手册 一、简介 1、本接口应用于帝国CMS 版新闻系统模型的栏目文章发布; 2、本接口可以自动生成文章、栏目、首页等静态HTML页面; 3、本接口可以生成随机点击数,详见发布接口参数说明; 4、发布时请使用管理员用户帐号; 5、在帝国CMS utf8版使用本接口时,请在发布规则中选择编码为UTF-8; 6、本接口基于帝国CMS UTF8版制作,适用于帝国CMS GBK/utf-8等版本,应用于其他版本时请自行测试调整;; 7、接口文件无须任何改动即可使用,如果你希望增加校验或其他功能,请仔细修改; 8、2个接口文件请复制在网站 /e/admin目录下使用; 二、安装接口 在接口文件夹中找到接口文件,如图: 请将、等接口文件上传到指定目录,请使用二进制方式上传,如图: 三、配置发布规则 1、将范例发布规则文本导入ET2发布配置,或使用软件内置发布规则范例,如图:

2、将检查网址和发布网址中的“您的网站”改为您要发布的网站网址,如图: 3、在检查网址填上您要发布的栏目ID,如图: 4、在参数取值页,填上您要发布的网站栏目ID,如图: 这里查看栏目ID:

4、填上您的管理账号、密码,注意格式,如图: 四、接口说明 一、检查接口 1、接口文件名,为保密,请自行修改文件名; 2、本接口文件复制在网站/e/admin目录使用,如果目录名有变更,请自行对应; 3、主要参数 keyboard 文章标题 classid 栏目ID,用于指定检查栏目,可在后台网站栏目管理处查看; vercode 校验码,请自行设定,并在检查接口文件开始处修改$vercode 使其一致; 4、发布配置-文章检查网址处,可以如下填写: 注:使用大小写敏感的服务器的用户请注意网址大小写和网站文件一致 5、接口文件无须任何改动即可使用,如果你希望增加校验或其他功能,请仔细修改; 二、发布接口 1、接口文件名,为保密,请自行修改文件名; 2、本接口文件请复制在网站/e/admin目录下使用,为保密,请自行修改文件名;

接口使用说明文档

中国移动短信网关 SP端接口使用手册 China Mobile Shot Message Gateway Interface for SP Manual 作者:沈岗 日期:2004年1月 版本:V1.2

一、CMSMIF.CMPPApp 简要说明: 该类采用CMPP协议(V2.0)实现了SP端与移动短信网关的连接处理。 本类中,采用长连接方式与ISMG通讯。通信双方以客户-服务器方式建立TCP连接,用于双方信息的相互提交。当信道上没有数据传输时,通信双方应每隔时间C发送链路检测包以维持此连接,当链路检测包发出超过时间T后未收到响应,立即再发送链路检测包,再连续发送N-1次后仍未得到响应则断开此连接。参数C、T、N可通过属性配置。 消息发送时采用并发方式,即发送一条消息不等待网关回复确认,继续向网关发送短信,这样发送消息速度非常快,完全取决于网关的处理速度及网络速度。为避免消息丢失,同时采用了滑动窗口流量控制,窗口大小可通过属性设置。 消息接收、网络断开等采用事件触发方式,不需应用程序轮询,在此接口基础之上编程方便。 类中运用了多线程技术,如一条线程处理发送网络包,而另一条线程处理从网关上接收网络包,其他还有一些线程处理检测包、网络连接情况监测等,使程序思路明确、执行效率很高、运行非常稳定。 (一)属性 1.ActiveInterval 说明:检测包发送时间间隔,单位:毫秒。默认值为120000,即120秒。为上 述类说明中的C参数。 2.MaxNetworkPackSize 说明:与ISMG通讯时最大网络包大小,单位:字节。默认值为512Byte。 3.MaxRetryTimes 说明:网络超时最大重发次数,单位:次。默认值为3次。为类说明中的N。 4.OverTime 说明:网络包发送超时时间,单位:毫秒,超过此值还未收到回复则重发。默认值 为60000,即60秒。为类说明中的T。 5.QueueLength 说明:网络队列大小,单位:个,默认值为20。为类说明中的滑动窗口大小, 以控制发送流量。 (二)方法 1.ConnectToIsmg 方法说明: 连接到远程短信网关ISMG上,只有连接到远程短信网关上,才可进行短信收发操作。 在本操作中,自动初始化本地Socket,以连接到指定IP服务器的指定端口上。 声明原型:int ConnectToIsmg(string ServerIP,int Port,string SP_ID,string Secret,string SN) 参数说明: ServerIP:远程短信网关服务器的IP地址,如211.138.200.51 Port:远程短信网关服务器的端口号,如7890 SP_ID:企业服务代码

Place API http接口使用说明

PlaceAPI http 接口使用说明 1.1 Place API http 接口简介 Place API http 接口(以下简称http 接口)是一个供程序员调用的、http 形式的地图检索服务接口,且只向百度合作伙伴开放。 目前http 接口提供的功能包括:矩形区域关键字检索、周边区域关键字检索(也称:圆形区域检索)和城市内关键字检索。http 接口主要服务那些非网页程序的调用,例如:C# 、C++、Java 等开发的应用程序,这些开发语言都能发送http 请求且能接收返回数据。http 接口可以返回xml 和json 两种不同形式的的地理数据。 目前提供的功能不是很多、以后随着用户需求的收集和总结,会不断完善http 接口。 1.2 Place API http 接口使用说明 http 接口使用分为3个步骤:第一步,申请注册key ;第二步,拼写http 请求发送的url ,url 中附带上第一步申请的key 值;第三步,接收http 请求返回的数据(json 或xml 格式),如下图示意: 1.2.1申请注册key 说明 用户打开https://www.doczj.com/doc/6f8112597.html,/wiki/static/mapws/placeapikey/页面,在此页面中申请注册key 值。该key 主要目的是判断用户请求的url 是否合法,且限制用户1天发送的http 请求数不能超过1000次。注册页面如下图:

填写好信息后,点击生成API密钥按钮就获取到所需的key值了,申请的key值和应用程序名称相关联,既相同的应用程序名称返回的key值是一样的。 特别注意:申请key之前会提示用户首先注册百度账号,只有拥有了百度账号,才能顺利的申请key值。 1.2.2 http接口请求参数说明 http接口请求参数主要包括:检索关键字、检索区域(3种选择形式)、输出结果类型(xml或json),如下表:

APP接口开发规范文档-V1.0

{ APP接口规文档}手机客户端接口文档

版本历史

目录 一、概述 (1) 1.1 有关接口 (1) 1.1.1接口是纯数据的交互 (1) 1.2 接口的分类 (1) 1.2.1查询类接口 (1) 1.2.2 操作类接口 (1) 1.2.3上传下载类接口 (1) 1.2.4推送类接口 (1) 二、查询类接口格式规 (1) 2.1获取单条对象信息 (1) 2.1.1 请求格式 (1) 2.1.2参数说明 (2) 2.1.3正常返回结果 (2) 2.2获取列表对象信息 (3) 2.2.1 请求格式 (3) 2.2.2参数说明 (3) 2.2.3正常返回结果 (3) 三、操作类接口 (4) 3.1 新增操作 (4) 3.1.1接口说明 (4) 3.1.2参数说明 (4) 3.1.3正常返回结果 (4) 3.1.4错误返回列表 (5) 3.2 修改操作 (5) 3.2.1接口说明 (5) 3.2.2参数说明 (5) 3.2.3正常返回结果 (5) 3.2.4错误返回列表 (5) 3.3 删除操作 (6) 3.3.1接口说明 (6) 3.3.2参数说明 (6) 3.3.3正常返回结果 (6) 3.3.4错误返回列表 (6) 四、上传下载类 (7) 4.1 上传文件 (7) 4.1.1接口说明 (7) 4.1.2参数说明 (7) 4.1.3正常返回结果 (7) 4.1.4错误返回列表 (7) 4.2 下载文件 (7) 4.2.1接口说明 (7)

4.2.2参数说明 (8) 4.2.3正常返回结果 (8) 4.2.4错误返回列表 (8) 五、推送类接口 (8) 5.1 推送消息 (8) 5.1.1接口说明 (8) 5.1.2参数说明 (8) 5.1.3正常返回结果 (9) 5.1.4错误返回列表 (9) 六、通用返回格式 (9) 6.1 正确返回 (9) 6.1.1接口说明 (9) 6.1.2参数说明 (9) 6.1.3正常返回结果 (9) 6.1.4错误返回列表 (10) 6.2 错误返回 (10) 6.2.1接口说明 (10) 6.2.2参数说明 (10) 6.2.3正常返回结果 (10) 6.2.4错误返回列表 (10) 七、附录 (11) 7.1 通用错误返回列表 (11) 7.2 URL地址信息 (11) 7.2.1 主机地址 (11) 7.2.2 URL列表 (11) 7.3 安全机制 (11) 7.3.1 验证签名机制 (11) 7.4 其他 (12) 7.2.1 列表数据为空的返回 (12)

项目接口需求及设计说明文档

媒讯集团E A S项目 CTC与EAS接口 需求及设计说明书 文档作者: 创建日期:20X X-05-10 确认日期: 当前版本:1.0 拷贝数量:1 审批签字: 客户方: 实施方:

文档控制 修改记录 日期作者版本参考版本备注

目录 1.概述 (4) 1.1读者 (4) 1.2图例 (4) 1.3目的 (4) 二、业务现状 (5) 三、概要设计 (5) 3.1接口通讯方式 (5) 3.2通讯内容定义 (5) 3.3媒讯CTC系统提供接口使用范例 (5) 3.4金蝶EAS提供接口使用范例 (5) 3.5媒讯CTC系统提供接口服务地址 (7) 3.6金蝶EAS提供接口服务地址 (7) 3.7接口需求 (7) 四、详细设计 (8) 4.1XX EAS接口 (8)

1.概述 金蝶与用户及用户业务系统方通过多次讨论,制定了接口开发需求设计说明书,作为双方后续开发指引。 1.1读者 本文读者对象为业务管理人员、系统设计、开发人员、测试人员。 1.2图例 本文中如未进行特殊说明,各图标代表的含义如下: 表示一个活动; 表示动态的业务数据,如系统单据; 表示流程走向; 表示条件判断、流程分支; 表示静态的业务数据,如基础资料; 表示系统外一个手工处理活动; 表示系统外手工填制的单据; 表示当前系统之外的活动; 表示当前系统之外产生的业务数据。 1.3目的 本文档是媒讯CTC系统与EAS系统接口的需求及设计方案相关文档,可用于指导开发、测试工作和作为验收相关依据文档。

二、业务现状 待补充 三、概要设计 3.1接口通讯方式 金蝶EAS与媒讯CTC系统之间通讯采用WebService方式进行数据传输。 3.2通讯内容定义 对于记录型的大对象,在通讯时,采用String型的xml格式的参数进行传递。对于其他非记录型的对象,在通讯时,可采用非xml格式的参数进行传递,也可使用多个参数。具体格式,请参照每个接口的通讯用例说明。 3.3媒讯CTC系统提供接口使用范例 待补充。 3.4金蝶EAS提供接口使用范例 3.4.1规范说明 EAS通过webService接口与异构系统通信。EAS WebService全部是使用java编写的,其接口描述符合WSDL国际标准,其数据描述符合XSD 国际标准。 本次提供的接口除系统登录接口外,其他接口都需要调用登录接口,以便将登陆的SessionId信息放入到SOAP 的HEADER 报文中。 3.4.2使用示例 金蝶在EAS上发布WebService服务,提供wsdl文件供客户端下载,其他业务系统根据下载的wsdl文件,产生客户端。 建议使用Axis2来生成客户端代理。

HTTP接口文档

HTTP接口文档 接口域名: 一、工作方式....................................................................... 错误!未定义书签。 1.1 密码验证方式............................................................................... 错误!未定义书签。 二、字符编码....................................................................... 错误!未定义书签。 三、响应格式....................................................................... 错误!未定义书签。 四、短信发送(单条,多条发送)...................................... 错误!未定义书签。 五、接收状态报告................................................................ 错误!未定义书签。 5.1 主动获取状态............................................................................... 错误!未定义书签。 六、接收上行短信(回复)................................................. 错误!未定义书签。 6.1 主动接收上行短信(回复) ......................................................... 错误!未定义书签。 6.2 推送接收上行短信(回复) ......................................................... 错误!未定义书签。 七、取剩余短信条数............................................................ 错误!未定义书签。 八、取已发送总条数............................................................ 错误!未定义书签。 九、接口安全(绑定IP).................................................... 错误!未定义书签。 十、取发送记录 ................................................................... 错误!未定义书签。 一、工作方式 双方通过HTTP方式交互数据,第三方可以简单的“name=value”方式发送提交内容或响应请求内容。即通过HTTP的GET/POST方式交换。 另外双方需要保证数据传输的完整性和安全性,每次发送请求都有响应(响应返回格式为纯文本),安全验证目前采用用户名、密码和IP绑定的方式。 1.1 密码验证方式 接口密码使用“登录密码”与“用户名”拼接字符串后能过md5加密进行验证 如登录密码是:123123 如用户名是:test 接口密码(pwd)=md5(登录密码+用户名) pwd=md5(123123test) pwd=b9887c5ebb23ebb294acab183ecf0769 二、字符编码 服务器接收数据可以是GBK或UTF-8编码字符,默认接收数据是GBK编码,如提交的是UT F-8编码字符,需要添加参数encode=utf8。 请求响应返回内容是GBK编码。 三、响应格式 所为响应即每次向服务器提交请求后返回值

项目接口需求及设计说明文档(模板)

客户化开发需求规格说明书 媒讯集团E A S项目 CTC与EAS接口 需求及设计说明书 文档作者: 创建日期:2013-05-10 确认日期: 当前版本:1.0 拷贝数量:1 审批签字: 客户方: 实施方:

文档控制 修改记录 日期作者版本参考版本备注

目录 1.概述 (4) 1.1读者 (4) 1.2图例 (4) 1.3目的 (4) 二、业务现状 (5) 三、概要设计 (5) 3.1接口通讯方式 (5) 3.2通讯内容定义 (5) 3.3媒讯CTC系统提供接口使用范例 (5) 3.4金蝶EAS提供接口使用范例 (5) 3.5媒讯CTC系统提供接口服务地址 (7) 3.6金蝶EAS提供接口服务地址 (7) 3.7接口需求 (7) 四、详细设计 (8) 4.1XX EAS接口 (8)

1.概述 金蝶与用户及用户业务系统方通过多次讨论,制定了接口开发需求设计说明书,作为双方后续开发指引。 1.1读者 本文读者对象为业务管理人员、系统设计、开发人员、测试人员。 1.2图例 本文中如未进行特殊说明,各图标代表的含义如下: 表示一个活动; 表示动态的业务数据,如系统单据; 表示流程走向; 表示条件判断、流程分支; 表示静态的业务数据,如基础资料; 表示系统外一个手工处理活动; 表示系统外手工填制的单据; 表示当前系统之外的活动; 表示当前系统之外产生的业务数据。 1.3目的 本文档是媒讯CTC系统与EAS系统接口的需求及设计方案相关文档,可用于指导开发、测试工作和作为验收相关依据文档。

二、业务现状 待补充 三、概要设计 3.1接口通讯方式 金蝶EAS与媒讯CTC系统之间通讯采用WebService方式进行数据传输。 3.2通讯内容定义 对于记录型的大对象,在通讯时,采用String型的xml格式的参数进行传递。对于其他非记录型的对象,在通讯时,可采用非xml格式的参数进行传递,也可使用多个参数。具体格式,请参照每个接口的通讯用例说明。 3.3媒讯CTC系统提供接口使用范例 待补充。 3.4金蝶EAS提供接口使用范例 3.4.1规范说明 EAS通过webService接口与异构系统通信。EAS WebService全部是使用java编写的,其接口描述符合WSDL国际标准,其数据描述符合XSD 国际标准。 本次提供的接口除系统登录接口外,其他接口都需要调用登录接口,以便将登陆的SessionId信息放入到SOAP 的HEADER 报文中。 3.4.2使用示例 金蝶在EAS上发布WebService服务,提供wsdl文件供客户端下载,其他业务系统根据下载的wsdl文件,产生客户端。 建议使用Axis2来生成客户端代理。

接口说明文档

接口说明文档 本文档提供面向openflowjava项目的扩展yang模型说明。yang模型文件(sptn-match.yang&sptn-action.yang)根据CMCC提供的ttp文件书写。 1.Match 1.1.扩展Match相关yang元素的命名方式 本节提供扩展match相关yang元素的命名方式说明,其中粗体部分与ttp文件的映射关系见表1。 identity:”sptnxm-sptnx-“ + Match grouping:”ofj-sptnxm-sptnx-“ +Match+”-grouping” case:Match+”-case-value” 1.2.Match扩展例子 以vlan-dei为例

1.Match field within the class identity sptnxm-sptnx-vlan-dei { base ofoxm:match-field; } 2.value of the match container vlan-dei -values { leaf value { type uint8; } } 3.在openflow-augments: experimenter-id-case中扩展 augment "/ofoxm:oxm-container/ofoxm:match-entry-value/aug:experimenter-id-case" { ext:augment-identifier "ofj-aug-sptnx-match"; choice sptnx-match-entry-value { case vlan-dei -case-value { uses ofj-sptnxm-sptnx- vlan-dei -grouping; } } }

http接口说明模板

http接口说明模板

一、查询菜品列表接口(DONE) 1、功能说明 接受提供的菜品 XXX画面XXX功能(比如人口查询画面-查询 | 人口查询画面-详细等) 2、接口调用说明 2.1获取地址 http://192.168.0.6:8080/FamilyServiceSystem/BookDinnerQueryAction?op eration=queryServiceItem 2.2http请求方式 GET 2.3数据返回格式 JSON 2.4传递参数 类型示例描述 参数名称是否 必须 page 是String 1 获取第几个分页的菜 品,默认第一个分页 为1

pageSize 是String 5 每页显示多少个菜 品,默认为5 isFood 是String true 查询食物还是饮料, 查询食物为true 饮料为false 饮料和食物为空 2.5成功返回结果 [ “serverResponse”:”Success”, “totalRecords”:”52”, “page” : “10”, “pageSize” : “5”, “data”:{ “id” : “123”, “itemName” : “皇堡”, “priceNow” : “10”, “pricePast” : “12”, “servicePicture” :”s9118668.jpg”, “serviceStars” : “3” }, ……. { “id” : “”, “itemName” : “”,

“priceNow” : “”, “pricePast” : “”, “servicePicture” :” s9118668.jpg”, “serviceStars” : “3” } ] 2.6返回结果解释 参数名称类型描述备注 page String 当前返回的 是第几页 id Int 菜品编号itemName String 菜品名字priceNow String 现价 pricePast String 原价servicePicture String 菜品图片 serviceStars String 菜品星级

接口调用说明文档

XXXX科技有限公司 数据接口 2015-5-26

目录 第1章引言............................................................. 错误!未定义书签。 背景.............................................................. 错误!未定义书签。第2章接口与数据定义................................................... 错误!未定义书签。 曝光台查询接口.................................................... 错误!未定义书签。 曝光台列表查询................................................ 错误!未定义书签。 曝光台详情查询................................................ 错误!未定义书签。 信用公示查询接口定义.............................................. 错误!未定义书签。 守信公示列表查询.............................................. 错误!未定义书签。 守信公示详情查询.............................................. 错误!未定义书签。 失信公示列表查询.............................................. 错误!未定义书签。 失信公示详情查询.............................................. 错误!未定义书签。 企业名称查询接口定义.............................................. 错误!未定义书签。 Webservice方法定义............................................ 错误!未定义书签。 请求参数...................................................... 错误!未定义书签。 返回数据...................................................... 错误!未定义书签。 企业信息查询接口定义.............................................. 错误!未定义书签。 Webservice方法定义............................................ 错误!未定义书签。 请求参数...................................................... 错误!未定义书签。 返回数据...................................................... 错误!未定义书签。

公文对外接口说明

公文对外接口说明 一、REST接口 1.导出公文数据接口 接口请求方式: http请求方式:POST http://ip:port/seeyon/rest/edoc/export public void test() { Map param = new HashMap(); param.put("summaryid",new String[]{"7296218641489879223"}); param.put("folder", "D:\\changx\\"); client.bindUser("chenyx"); String s =client.post("edoc/export",param,String.class); } 本地生成文件

2.导入公文数据接口 接口请求方式: 3.获取公文待签收列表 接口请求说明: http请求方式:GET http://ip:port/seeyon/rest/edocResource/signed?memberId={member Id} 参数说明:

4.获取公文待登记列表 接口请求说明: http请求方式:GET http://ip:port/seeyon/rest/edocResource/registered?memberId={m emberId} 参数说明: 5.导出MHT公文单 接口请求说明: http请求方式:POST http://ip:port/seeyon/rest/edoc/id/exportmht 参数示例: Map res = new HashMap(); String[] SummaryId={"-7993161577072146191"}; res.put("summaryid", SummaryId); res.put("folder", "F:\UFSeeyon\folder\");

java,http协议,接口

竭诚为您提供优质文档/双击可除java,http协议,接口 篇一:http接口 2.客户端:通过httpinvoker代理向服务器端发送请求,远程调用服务接口的方法 3.服务器端与客户端通信的数据需要序列化 配置服务器端和客户端的步骤 配置服务器端 1.添加springjaR文件 建议使用spring2+.jar版本 2.创建服务接口 3.创建服务接口的具体实现类 4.公开服务 配置客户端 1.添加springjaR文件 建议使用spring2+.jar版本 2.创建服务接口 3.访问服务 实例讲解

服务器端 1.服务接口:ucservice.java 它提供两项服务,查询用户信息和记录日志,如下: publicinterfaceucservice{ publicuserinfogetuserinfobyname(stringusername); publicintrecordlog(stringusername,stringpoint,strin goperate,stringdesc);} 说明:举这个列子是因为其比较有代表性,它将展示普通数据类型(int,long等)和复杂数据类型(dto等)的远程调用方式。userinfo是一个普通的dto,代码如下:publicclassuserinfoimplementsserializable{ privatestaticfinallongserialVersionuid=-69709675067 12260305l; /**用户名*/ privatestringusername; /**电子邮箱*/ privatestringemail; /**注册日期*/ privatedateregistdate; publicstringgetusername(){

http接口

2 HTTP invoker 服务模式

2. 客户端:通过 HTTP invoker 代理向服务器端发送请求,远程调用服务接口的方法 3. 服务器端与客户端通信的数据需要序列化 配置服务器端和客户端的步骤 配置服务器端 1. 添加 springJAR 文件 建议使用 spring2+.jar 版本 2. 创建服务接口 3. 创建服务接口的具体实现类 4. 公开服务 配置客户端 1. 添加 springJAR 文件 建议使用 spring2+.jar 版本 2. 创建服务接口 3. 访问服务 实例讲解 服务器端 1. 服务接口: UcService.java 它提供两项服务,查询用户信息和记录日志,如下: public interface UcService { public UserInfo getUserInfobyName(String userName); public int recordLog(String username, String point, String operate, String desc); } 说明:举这个列子是因为其比较有代表性,它将展示普通数据类型( int,long 等)和复杂数据类型( DTO 等)的远程调用方式。 UserInfo 是一个普通的 DTO ,代码如下: public class UserInfo implements Serializable { private static final long serialVersionUID= -6970967506712260305L; /**用户名*/ private String userName ;

接口文档规范

XXX接口说明书(版本:V1.0)

修订记录

1简介 1.1文档目的 接口文档是前端与后端交互密不可分的环节,接口的规范性会直接影响双方对接过程中的效率和质量。本着快速高效开发的目的性,避免对接过程中的错误率。 1.2接口规范 (1)遵循RESTfulAPI设计风格 (2)数据格式采用json格式 (3)返回统一结构数据 例如: 结构:data(数据)、errorCode(状态码)、msg(提示信息) { data:{}, // 数据类型不一定为object类型 errorCode:10001, msg:'' } (4)枚举型参数应列举参数所有值及说明 例如: gender:性别(男:1,女:2) userInfo:{ name:'张三', age:23, gender:1 } (5)具有嵌套关系的参数应指明嵌套关系及子级数据结构 例如: billList: 账单列表(父级)

billList:[ { id:'001', billName:'测试数据', billStauts:1, address:'雁塔区' } ] (6) 返回参数数据类型保持一致性 例如: billList: 账单列表(有数据) billList:[ { id:'001', billName:'测试数据', billStauts:1, address:'雁塔区' } ] billList: 账单列表(无数据) billList:[] 返回的参数数据类型都为:array (7)下拉及选择型数据以键值对的形式返回例如: orderOperate:订单操作 orderOperate:[ { label:'待开票' value:1001 }, { label:'回款' value:1003 } ]

短信HTTP接口说明文档

HTTP接口说明文档 接口地址:http://203.171.227.208:9876/plan/Api/ 请先读这里: 通过API提交参数时, 参数内容编码必须为GB2312, 且经过url编码 例如:“您好”的url编码为“%C4%FA%BA%C3” API返回的内容是一些键值对的字符串集合,形式为:“k1=v1&k2=v2&k3=v3…” 返回内容中的键值显示为url编码形式, 经过url解码后的键值是GB2312编码的字符串 例如: 返回内容“result=0&description=%B7%A2%CB%CD%B3%C9%B9%A6&faillist=”表示的实际内容为“result=0&description=发送成功&faillist=” 1、发送短信 功能描述:短信发送 调用格式:http://203.171.227.208:9876/plan/Api/Send.aspx?username=用户名&password=密码&mobiles=手机号码&content=内容&f=1 返回格式:result=&description=错误描述&faillist=失败号码列表 注:faillist 列表中的号码间隔为英文”,” 返回值:

2、修改密码 功能描述:修改密码 调用格式:http://203.171.227.208:9876/plan/Api/ChgPwd.aspx?username=用户名&password=密码&newpwd=新密码 返回格式:result=&description=错误描述 参数说明: 返回值: 3、查询余额 功能描述:查询余额 调用格式:http://203.171.227.208:9876/plan/Api/Query.aspx?username=用户名&password=密码 返回格式:result=返回值&balance=条数&description=错误描述 注意: 当返回值为0时才同时返回条数 参数说明: 返回值:

相关主题
文本预览
相关文档 最新文档