搜档网
当前位置:搜档网 › 接口调用说明文档

接口调用说明文档

接口调用说明文档
接口调用说明文档

XXXX科技有限公司

数据接口

2015-5-26

目录

第1章引言............................................................. 错误!未定义书签。

背景.............................................................. 错误!未定义书签。第2章接口与数据定义................................................... 错误!未定义书签。

曝光台查询接口.................................................... 错误!未定义书签。

曝光台列表查询................................................ 错误!未定义书签。

曝光台详情查询................................................ 错误!未定义书签。

信用公示查询接口定义.............................................. 错误!未定义书签。

守信公示列表查询.............................................. 错误!未定义书签。

守信公示详情查询.............................................. 错误!未定义书签。

失信公示列表查询.............................................. 错误!未定义书签。

失信公示详情查询.............................................. 错误!未定义书签。

企业名称查询接口定义.............................................. 错误!未定义书签。

Webservice方法定义............................................ 错误!未定义书签。

请求参数...................................................... 错误!未定义书签。

返回数据...................................................... 错误!未定义书签。

企业信息查询接口定义.............................................. 错误!未定义书签。

Webservice方法定义............................................ 错误!未定义书签。

请求参数...................................................... 错误!未定义书签。

返回数据...................................................... 错误!未定义书签。

第1章引言

1.1背景

为进一步保证业务的正确性及数据的安全统一性,并为后续各方开发工作提供指导,特编写此文档。

本接口通过Webservice方式进行交互,由市公共信用中心提供信息查询Webservice服务,供经授权的调用使用。

第2章接口与数据定义

2.1曝光台查询接口

2.1.1曝光台列表查询

2.1.1.1方法定义

访问地址:

曝光台Webservice接口及参数定义如下:

示例代码(Java) : public String queryBGTList ( ) {/*todo*/}

2.1.1.2返回数据

返回数据为字符串,内容格式为json,格式样板如下:

[{"id":"94a349902",

"title":"江苏省2014年12月份违法药品医疗器械保健食品广告公告", "createTime":"2015-05-15"},

{"id":"94a349e04",

"title":"省食品药品监督管理局暂停销售利肺胶囊等2个药品的公告", "createTime":"2015-05-15"},

{"id":"94a2432e24",

"title":"江苏省2014年5月份违法药品医疗器械保健食品广告公告", "createTime":"2015-05-15"}]

2.1.2曝光台详情查询

2.1.2.1方法定义

曝光台Webservice接口及参数定义如下:

示例代码(Java) : public String queryBGTDetail (String id ) {/*todo*/}

2.1.2.2返回数据

返回数据为字符串,内容格式为json,格式样板如下:

{"title":"江苏省2014年12月份违法药品医疗器械保健食品广告公告",

"content":"根据《江苏省药品监督管理条例》第三十二条的规定,我局经研究决定,自2015年2月15日起,对标示为吉林通化百信药业有限公司利肺胶囊等2种违法广告药品(品种名单见附件)采取暂停销售措施,在我省范围内暂停上述2品种的销售,现予以公告。"}

2.2信用公示查询接口定义

2.2.1守信公示列表查询

2.2.1.1方法定义

访问地址:曝光台Webservice接口及参数定义如下:

示例代码(Java) : public String querySHOUXINList ( ) {/*todo*/}

2.2.1.2返回数据

返回数据为字符串,内容格式为json,格式样板如下:

[{"id":"94a349902",

"title":" 2014年度江苏省价格诚信单位名单",

"createTime":"2015-05-15"},

{"id":"94a349e04",

"title":"【单位】苏州市水利工程有限公司",

"createTime":"2015-05-15"},

{"id":"94a2432e24",

"title":"市政府办公室关于表彰2012年度全市政府信息公开工作优秀单位的通报", "createTime":"2015-05-15"}]

2.2.2.1方法定义

曝光台Webservice接口及参数定义如下:

示例代码(Java) : public String querySHOUXINDetail (String id ) {/*todo*/}

2.2.2.2返回数据

返回数据为字符串,内容格式为json,格式样板如下:

{"title":"江苏省2014年12月份违法药品医疗器械保健食品广告公告",

"content":"各市、区人民政府,苏州工业园区、苏州高新区管委会;市各有关部门和单位: 2012年,各地各部门认真贯彻《中华人民共和国政府信息公开条例》,进一步建立健全政府信息公开工作制度,深化公开内容,丰富公开载体,拓展公开范围,不断提高政府信息公开的及时性、完整性和实用性,较好地发挥了政府信息对人民群众生产、生活和经济社会活动的服务作用。根据《市政府办公室关于开展 2012年度全市政府信息公开工作考核的通知》(苏府办〔2013〕14号)精神,综合各地自查、平时检查、网上测评和实地调研考核等方面情况,经市政府同意,决定对昆山市人民政府办公室、苏州市发改委等政府信息公开工作优秀单位予以通报表彰。各地各部门要以先进为榜样,进一步加强组织领导,完善工作机制,强化制度建设,加大公开力度,不断提升政府信息公开整体工作水平。

附件:2012年度全市政府信息公开工作优秀单位"}

2.2.

3.1方法定义

曝光台Webservice接口及参数定义如下:

示例代码(Java) : public String querySHIXINList ( ) {/*todo*/}

2.2.

3.2返回数据

返回数据为字符串,内容格式为json,格式样板如下:

[{"id":"94a349902",

"title":" 2014年度江苏省价格诚信单位名单",

"createTime":"2015-05-15"},

{"id":"94a349e04",

"title":"【单位】苏州市水利工程有限公司",

"createTime":"2015-05-15"},

{"id":"94a2432e24",

"title":"市政府办公室关于表彰2012年度全市政府信息公开工作优秀单位的通报", "createTime":"2015-05-15"}]

2.2.4.1方法定义

曝光台Webservice接口及参数定义如下:

示例代码(Java) : public String querySHIXINDetail (String id ) {/*todo*/}

2.2.4.2返回数据

返回数据为字符串,内容格式为json,格式样板如下:

{"title":"江苏省2014年12月份违法药品医疗器械保健食品广告公告",

"content":"各市、区人民政府,苏州工业园区、苏州高新区管委会;市各有关部门和单位: 2012年,各地各部门认真贯彻《中华人民共和国政府信息公开条例》,进一步建立健全政府信息公开工作制度,深化公开内容,丰富公开载体,拓展公开范围,不断提高政府信息公开的及时性、完整性和实用性,较好地发挥了政府信息对人民群众生产、生活和经济社会活动的服务作用。根据《市政府办公室关于开展 2012年度全市政府信息公开工作考核的通知》(苏府办〔2013〕14号)精神,综合各地自查、平时检查、网上测评和实地调研考核等方面情况,经市政府同意,决定对昆山市人民政府办公室、苏州市发改委等政府信息公开工作优秀单位予以通报表彰。各地各部门要以先进为榜样,进一步加强组织领导,完善工作机制,强化制度建设,加大公开力度,不断提升政府信息公开整体工作水平。}

2.3.1Webservice方法定义

访问地址:企业列表Webservice接口及参数定义如下:

示例代码(Java) : public String enterpriseList (String organCode,String registerNum,String organName){/*todo*/}

2.3.2请求参数

请求参数为下列数据。

2.3.3返回数据

返回数据为字符串,内容格式为JSON,格式样板如下:

[{"id":"0","organName":"企业名称0"},

{"id":"1","organName":"企业名称1"}]

2.4.1Webservice方法定义

访问地址:企业信息Webservice接口及参数定义如下:

示例代码(Java) : public String enterpriseCreditInfo(String organId){/*todo*/} 2.4.2请求参数

请求参数为下列数据。

2.4.3返回数据

返回数据为字符串,内容格式为JSON,格式样板如下:

[{

"baseInfo":{"organName":"江苏华晨海洋工程服务有限公司 ","organCode":"590***347 ","scope":"机械设备租赁","address":"张家港保税区新世纪广场306","registerNum":"3205*******8896","legalPerson":"张三"},

"tishiInfo":[{"checkResult":"通过","year":"2000","checkTime":"2000-05-01","registerNum":"3205*******8896"},

{"checkResult":"通过

","year":"2001","checkTime":"2001-05-01","registerNum":"3205*******8896"}],

"honorInfo":[{"identiDept":"环保局 ","organCode":"1111111","identiTime":"2000"}, {"identiDept":"环保局 ","organCode":"1111111"," identiTime ":"2001"}],

}]

baseInfo中是基本信息

其中:

organName:企业名称organCode:组织机构代码scope:经营范围

address:注册地址registerNum:工商注册号legalPerson:法定代表人

tishiInfo中是提示信息

其中:

checkResult:年检结论year:年检年度checkTime:(年检)核准日期registerNum:工商注册号

honorInfo中是荣誉信息

其中:

identiDept:认定机关名称organCode:组织机构代码identiTime:认定日期

接口使用说明文档

中国移动短信网关 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:企业服务代码

API接口调用说明及示例(第四次修订)

产品/项目名称Product/Project Name 保密级别Confidentiality Level eYou邮件系统机密 产品/项目版本Product/Project Version 最后更新日期Last Update 81032014-09-12 eYou邮件系统V8接口文档 北京亿中邮信息技术有限公司 All Rights Reserved 版权所有侵权必究 仅供内部使用

Revision Record 修订记录

目录 1 API接口简介------------------------------------------------------------------------------------------------------- 3 2 API认证概述------------------------------------------------------------------------------------------------------- 4 认证方式的分类 --------------------------------------------------------------------------------------------- 4认证方式的选择 --------------------------------------------------------------------------------------------- 5认证原理 ------------------------------------------------------------------------------------------------------- 5 3 认证方法详解及示例-------------------------------------------------------------------------------------------- 5 OAuth ----------------------------------------------------------------------------------------------------------- 5 eYouAuth ------------------------------------------------------------------------------------------------------- 5 SSO API的eYouAuth认证方法:----------------------------------------------------------------- 5 Feed API的eYouAuth认证方法: --------------------------------------------------------------- 7 申请会话Token:------------------------------------------------------------------------------------- 8 4 API接口调用示例 ---------------------------------------------------------------------------------------------- 10 Feed API调用----------------------------------------------------------------------------------------- 10 资源概述 ---------------------------------------------------------------------------------------------- 10 以用户的增删改查为例,示例各种Feed API调用步骤--------------------------------- 11 5 附表 ---------------------------------------------------------------------------------------------------------------- 13 1 API接口简介 API指eYou邮件系统所提供的接口。 调用接口流程图:

接口调用说明文档

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

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

各种接口说明资料

视频基础知识 目前,国内外各个视频会议生产厂家都陆续推出了自己的各种高清或超清产品,都在不遗余力的宣传图像分辨率。但是,要达到高清/超清的视频会议,单单有720p或者1080p的图像分辨率是不够的。视频会议作为多媒体的一种应用,整个系统涉及到前端视频采集、图像的编码能力、高质量的网络传输、高清晰的视频显示设备。另外,如果我们在观看高清晰视频图像的时候,不能得到一个更清晰、连续的音频效果,那么这个过程实际上就没有任何意义,所以高质量音频的重要性完全不亚于视频。所以在高清或者超清的视频会议中有几个关键的知识点需要了解:高清的视频分辨率、高清视频显示设备的接口、高质量的音频传输接口、高质量的音频。技术的发展都是循序渐进的过程,在本文档中不但列出了高清视频的相关术语,还把非高清视频系统中的相关术语也一并列出,这样会有一个很直观的比较过程。 1视频接口 我们经常在家里的电视机、各种播放器上,视频会议产品和监控产品的编解码器的视频输入/输出接口上看到很多视频接口,这些视频接口哪些是模拟接口、哪些是数字接口,哪些接口可以传输高清图像等,下面就做一个详细的介绍。 目前最基本的视频接口是复合视频接口、S-vidio接口;另外常见的还有色差接口、VGA接口、DVI接口、HDMI 接口、SDI接口。 1.1复合视频接口 1.1.1接口图 1.1.2说明 复合视频接口也叫AV接口或者Video接口,是目前最普遍的一种视频接口,几乎所有的电视机、影碟机类产品都有这个接口。 它是音频、视频分离的视频接口,一般由三个独立的RCA插头(又叫梅花接口、RCA接口)组成的,其中的V接

口连接混合视频信号,为黄色插口;L接口连接左声道声音信号,为白色插口;R接口连接右声道声音信号,为 红色插口。 1.1.3评价 它是一种混合视频信号,没有经过RF射频信号调制、放大、检波、解调等过程,信号保真度相对较好。图像品质 影响受使用的线材影响大,分辨率一般可达350-450线,不过由于它是模拟接口,用于数字显示设备时,需要一 个模拟信号转数字信号的过程,会损失不少信噪比,所以一般数字显示设备不建议使用。 1.2S-Video接口 1.2.1接口图 1.2.2说明 S接口也是非常常见的接口,其全称是Separate Video,也称为SUPER VIDEO。S-Video连接规格是由日本人开发的一种规格,S指的是“SEPARATE(分离)”,它将亮度和色度分离输出,避免了混合视讯讯号输出时亮度和色度的相互干扰。S接口实际上是一种五芯接口,由两路视亮度信号、两路视频色度信号和一路公共屏蔽地线共五条芯线组成。 1.2.3评价 同AV 接口相比,由于它不再进行Y/C混合传输,因此也就无需再进行亮色分离和解码工作,而且使用各自独立的传

帝国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目录下使用,为保密,请自行修改文件名;

时钟系统对时接口说明

时钟系统对时接口说明 时钟系统可以为其它系统提供标准时间信号以保证各系统间的时钟统一。时钟系统可以提供两钟对时信号,一种是RS422接口形式的对时信号,另一种是NTP网络时间信号。具体说明如下: 1. RS422接口的标准时间输出 1.1 RS422标准时间接口说明: 时钟系统可以为本系统外的其它系统,例如为公务电话系统、专用电话系统、无线通信系统、电视监视系统、广播等系统提供标准时间信号。 接口功能:为其它系统提供对时信息。 接口类型:RS422接口线缆 物理接口方式:RS422 通讯协议:参照时钟系统标准时间接口协议 接口数量:每个系统各1路。 接口位置及工程界面:控制中心通信系统设备室综合配线架的外侧。 1.2 时钟系统标准时间接口协议: ①输出接口:标准RS-422端口 ②波特率:9600bit/s ③数据位:8位

④起始位:1位 ⑤停止位:1位 ⑥校验位:无 ⑦工作方式:异步 ⑨数据格式:(ASCII字符串,共21个字符) ebh,90h, 起始符 c: 41h 无外时钟校时, 47h GPS校时 n4,n3,n2,n1 年 m2,m1 月 d2,d1 日 w(30h~36h) 星期 h2,h1 时 m2,m1 分 s2,s1 秒 xxh 校验码(累加检验,取低8位) cr(odh) 1ah; 结束符. 例:EB 90 47 32 30 30 39 30 33 33 31 32 31 30 32 34 33 36 XX 0D 1A 信息为:2009-03-31 星期二10:24:36 有外部较时。 ⑩传输距离:1200米(采用0.5平方毫米的双绞软线,超过1200米需增加中继器)2. NTP接口的标准时间输出 时钟系统也可以通过NTP网络时间服务器为本系统外的其它系统提供基于以太网协议网络接口时间信号。具体说明如下: ☉网络协议: NTP v2, v3 & v4 (RFC1119& 1305) NTP broadcast mode SNTP Simple Network Time Protocol (RFC2030) MD5 Authentication (RFC 1321) Telnet (RFC854) DHCP (RFC2132) FTP (RFC 959)

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来生成客户端代理。

博客园API使用说明接口文档

卷号 卷内编号 密级 项目编号: 空指针播放器 错误!未指定书签。 Version: 1.0 项目承担部门:0015 撰写人(签名): xxx 完成日期: 2014-2-24 本文档使用部门:□主管领导■项目组 □客户(市场)■维护人员□用户评审负责人(签名): 评审日期:

目录 项目承担部门:0015 (1) 撰写人(签名): xxx (1) 评审负责人(签名): (1) 1.获取推荐信息 (3) 1.1 获取推荐电影信息 (3) 1.2 获取推荐电视剧信息............................................................ 错误!未定义书签。 1.3 获取推荐动漫信息 (4) 2.获取频道接口信息 (6) 2.1 获取电影列表 (6) 2.2 获取电视剧列表 (8) 2.3 获取动漫列表 (10) 2.4 获取综艺列表 (11) 2.5 获取电影列表 (12) 2.6 获取纪录片列表............................................................ 错误!未定义书签。 3.获取用户信息 (6) 3.1 获取登陆信息 (6) 3.2 获取注册信息 (20)

1.获取推荐信息 1.1 获取推荐电影列表 URL http://192.168.1.101:8080/NullPointerService/servlet/InitDataS ervlet 支持格式 json HTTP请求方式 Get 请求参数 无 返回结果 [{"Title":"ddd","SourceName":"Cnbeta","SubmitDate":"2012-3-3","Content":"Hello","Imag eUrl":"","PrevNews":"11242","NextNews":"11190","CommentCount":"20"},{"Title":"ddd"," SourceName":"Cnbeta","SubmitDate":"2012-3-3","Content":"Hello","ImageUrl":"","PrevNe ws":"11242","NextNews":"11190","CommentCount":"20"},{"Title":"ddd","SourceName":" Cnbeta","SubmitDate":"2012-3-3","Content":"Hello","ImageUrl":"","PrevNews":"11242","N extNews":"11190","CommentCount":"20"},{"Title":"ddd","SourceName":"Cnbeta","Submit Date":"2012-3-3","Content":"Hello","ImageUrl":"","PrevNews":"11242","NextNews":"1119 0","CommentCount":"20"},{"Title":"ddd","SourceName":"Cnbeta","SubmitDate":"2012-3-3","Content":"Hello","ImageUrl":"","PrevNews":"11242","NextNews":"11190","CommentCo unt":"20"}] 返回结果说明 无

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

客户化开发需求规格说明书 媒讯集团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来生成客户端代理。

joomla接口说明

Joomla!接口使用手册 一、简介 1、本接口应用于Joomla! 文章发布; 2、发布时请使用管理员用户帐号; 3、Joomla! 是utf8网站,请在发布规则中选择编码为UTF-8; 4、本接口基于Joomla! 1.5.18官方中文版制作,应用于其他版本时请自行测试调整; 5、接口文件无须任何改动即可使用,如果你希望增加校验或其他功能,请仔细修改; 6、2个接口文件请复制在administrator网站根目录下使用; 二、安装接口 在接口文件夹中找到接口文件,如图: 请将etchk.php、etpost.php等接口文件上传到指定目录,请使用二进制方式上传,如图: 三、配置发布规则 1、复制范例发布规则或者将本节后附的范例规则文本导入ET2发布配置即可,如图:

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

这里查看分类ID: 4、填上您的管理账号、密码,注意格式,如图:

四、接口说明 一、检查接口 1、接口文件名etchk.php,为保密,请自行修改文件名; 2、本接口文件复制在网站administrator目录下使用; 3、主要参数 title文章标题 sectioned 单元ID,用于限定检查范围,可不填,请对照管理中心查看单元ID; catid 分类ID,用于限定检查范围,可不填,请对照管理中心查看分类ID; vercode 安全校验码,请自行设定,并在检查接口文件开始处修改vercode 使其一致; 4、发布配置-文章检查网址处,可以如下填写: http://您的网站/administrator/etchk.php?sectionid=&catid=&title=<%title%> 注:使用大小写敏感的服务器的用户请注意网址大小写和网站文件一致 5、接口文件无须任何改动即可使用,如果你希望增加校验或其他功能,请仔细修改; 二、发布接口 1、接口文件名etpost.php,为保密,请自行修改文件名; 2、本接口文件请复制在网站administrator目录下使用; 注:以下参数名后“=”号为示范取值而用,参数名本身不含“=”号; 固定取值的参数,可以在发布规则-参数取值中设置; 采集取值的参数项,请在发布规则-发布项中添加; 3、主要参数 Username 会员名参数名 passwd 密码参数名 title 主题标题参数名 text 内容参数名(若要进行分页请在数据整理中将ET2正文分隔标记“#-0-#”替换为Joomla分页标记


) etattachs 文件列表参数名; 4、附加参数 sectioned 单元ID,请对照管理中心查看; catid 分类ID,请对照管理中心查看; vercode 安全校验码,请自行设定,本项用以防止接口被他人利用,如果需

http接口说明

一、查询菜品列表接口(DONE) 1、功能说明 接受提供的菜品 XXX画面XXX功能(比如人口查询画面-查询| 人口查询画面-详细等)2、接口调用说明 2.1获取地址 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获取地址 2.2http请求方式 GET 2.3数据返回格式 JSON 2.4传递参数

2.5成功返回结果 { "serverResponse":"Success", “advertisePicture” : “0f736a68b929b0955b319ebc41336.jpg”} 2.6返回结果解释 三、查询订单列表接口(DONE) 1、功能说明 根据指定的客户id查询订单 2、接口调用说明 2.1获取地址 2.2http请求方式 GET 2.3数据返回格式 JSON

接口说明文档

接口说明文档 本文档提供面向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; } } }

完整的接口解决方案说明书

XXXXXX信息科技股份有限公司

1引言 1.1编写目的 本文档为XX电信工程外部协作系统(以下简称外协系统)与电信工程施工单位内部系统(以下简称施工系统)接口技术解决方案,以此作为外协系统与施工系统实施接口的技术方案依据和项目设计标准。 1.2覆盖范围 XX电信工程外部协作系统项目组 施工系统接口开发技术组 1.3预期读者与阅读建议 XX电信企业信息化部 XX电信工程建设部 XXXX公司开发人员 施工系统开发人员

1.4文档约定 粗体正文表示强调内容 红色正文表示未完成或需要今后考虑的内容 蓝色正文表示待讨论内容 1.5术语与缩略语 1.6参考文献 (XXXX) 2概述 建设XX电信工程外部协作系统的目标,是在工程项目的管理、建设、使用和实施单位之间搭建起数据交换和协同工作的信息平台,延伸与拓展工程建设管理信息化的应用范围,实现通信工程建设过程的信息化管理,促进工程项目的管理部门、建设部门、实施部门和使用部门之间业务流程协调有序地开展,实现工程项目设计、施工、监理管理功能,将相关的设计、施工、监理单位纳入到工程建设管理中,完善工程项目建设过程管理体系,通过信息化推动管理的规范化,在信息化的应用过程中不断探索市场环境下工程建设管理的新思路和新方法。 根据工程部业务工作的实际情况,项目首先满足工程建设管理中应用最广泛、问题最突出的基本需求。 项目功能需求包括: ?建立工程外部协作系统与MSS等系统的接口; ?建立设计协作服务、监理协作服务、施工协作服务模块,为邮电设计院、电话监理公司和电信工程公司提供工程部所需的协作服务,保证工程建设实施流程的开展; ?在建立工程协作服务模块的基础上,建立工程外部协作系统与邮电设计院、电话监理公司、电信工程公司信息系统的接口,实现工程部与三家实施单位的信息交互与

数据调用api接口

数据调用api接口 一,漫画分类列表 1,接口说明 返回分类信息对应的漫画数据列表。 2,URL https://www.sodocs.net/doc/7f10030561.html,/android/phone/list.php 3,返回数据支持格式 Json 格式数据 4,Http请求方式 Get方式请求数据 5,是否需要登录 不需要登录 6 表 7,结果实例

{ "total":"3000", //搜索结果总数; "data":[ { "comic_id":"28499", //漫画id "name":"\u6211\u7684\u4eba\u751f",//漫画名称 "cover":"http:\/\/https://www.sodocs.net/doc/7f10030561.html,\/2012\/04\/55962_1335089769_DQq6 hq100Wxh.small.jpg" //漫画封面地址 "accredit" : 1, //作品性质授权,普通=0 ;首发=1;签约=2; "last_update_time": 1297307720 // 漫画最近更新时间 "description":"作品简介" //作品简介250 字节以内 }, { ......同上 }, .....(列表) ] } 8

二,漫画详情 1,接口说明 返回漫画基本信息和章节基本信息 2,URL https://www.sodocs.net/doc/7f10030561.html,/android/phone/comic.php 3,返回数据支持格式 Json数据格式 4,Http请求方式 通过GET方式请求 5,是否需要登录 不需要登录 6 7,返回结果实例 { "comic":{ "name":"\u8336\u53d4\u77ed\u7bc7\u96c6",//漫画名称 "author_name":"U\u8336",//作者名称 "cover":"http:\/\/https://www.sodocs.net/doc/7f10030561.html,\/2012\/04\/1074512_1335331124_Dqcx3zNs3d zn.small.png",//小封面 "ori":"https://www.sodocs.net/doc/7f10030561.html,/xxxx.ori.jpg", // "theme_ids":"\u641e\u7b11, \u9b54\u5e7b",//题材类型 "read_order":"0",//阅读顺序,0表示从左到右,1表示从右到左, "series_status":"0",//连载状态,0表示连载中,1表示已完成,2表示暂停更新 "last_update_time":"1335342264",//最近更新时间 "description":"\u4e0d\u5b9a\u671f\u66f4\u65b0\u00a0\u00a0\u00a0\u987a\u 5e26\u4e00\u63d0\u00a0\u8336\u53d4 ",//漫画简介 "click_total":"973519",//总点击量 "total_tucao":"36130"//总吐槽量

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 菜品星级

完整的接口解决方案说明书

文档编号:T-JKJS 文档版本:0.01 项目编号:XX-DX- PECS 《XX电信工程外部协作系统》 Project Exterior Cooperation System 施工单位接口技术解决方案 编写人:南疯日期:2006-10-30 审核人:日期: 批准人:日期: XXXXXX信息科技股份有限公司 地址:XXXXXXX 邮编:XXXXXX 电话:XXXXXXXX传真:XXXXXX 网站:XXXXXXXXX 修改记录(Revision Chart) 版本号批准人修改人修改0.01南疯2006-10-30 0.02详细修改记录: 序号

1引言 1.1编写目的 1.2覆盖范围 1.3预期读者与阅读建议 1.4文档约定 1.5术语与缩略语 1.6参考文献 2概述 3接口方式 4接口安全 4.1接口认证 4.2数据安全 5事务处理 6性能考虑 7容错处理 8数据格式 8.1约定 8.2施工系统向外协系统发送请求 8.2.1请求查询一个业务数据 8.2.2新增一条记录,得到记录的键值 8.2.3修改一条记录 8.2.4删除一条记录 8.2.5文档上传 8.2.6一条记录中一个文档字段上传多个文件 8.2.7补充上传文档 8.2.8在记录中删除一个文档 8.2.9获得文档的基本信息 8.2.10获得文档的所有兄弟信息 8.2.11获得文档的所有父亲信息 8.2.12下载一个文档 8.2.13获得字典 8.3外协系统向施工系统发送请求 8.3.1发送变更后的数据 8.3.2发送变更后的字典 8.3.3文档发送请求 9信息数据项 9.1数据表 9.2字段信息 9.3字典类型

相关主题