接口调用说明文档.doc
XXXX科技有限公司
数据接口
2015-5-26
目录
第1章引言 (3)
1.1 背景 (3)
第2章接口与数据定义 (4)
2.1 曝光台查询接口 (4)
2.1.1 曝光台列表查询 (4)
2.1.2 曝光台详情查询 (5)
2.2 信用公示查询接口定义 (6)
2.2.1 守信公示列表查询 (6)
2.2.2 守信公示详情查询 (7)
2.2.3 失信公示列表查询 (8)
2.2.4 失信公示详情查询 (9)
2.3 企业名称查询接口定义 (10)
2.3.1 Webservice方法定义 (10)
2.3.2 请求参数 (10)
2.3.3 返回数据 (10)
2.4 企业信息查询接口定义 (11)
2.4.1 Webservice方法定义 (11)
2.4.2 请求参数 (11)
2.4.3 返回数据 (11)
第1章引言
1.1背景
为进一步保证业务的正确性及数据的安全统一性，并为后续各方开发工作提供指导，特编写此文档。
本接口通过Webservice方式进行交互，由市公共信用中心提供信息查询Webservice服务，供经授权的调用使用。
第2章接口与数据定义
2.1曝光台查询接口
2.1.1曝光台列表查询
2.1.1.1方法定义
访问地址：http://
曝光台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方法定义
访问地址：http:// https://www.sodocs.net/doc/de1254147.html,:8001/webserviceForApp
曝光台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"}]
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 方法定义 ........................ 错误! 未定义书签。 请求参数. .................................................... 错误! 未定义书签。 返回数据. .................................................... 错误!未定义书签。
帝国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：企业服务代码
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)
博客园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 请求参数 无 返回结果
文件访问接口设计.
课程设计说明书 设计名称：操作系统课程设计 题目：文件访问接口设计 学生姓名：余德威 专业：计算机科学与技术 班级： 13计算机1班 学号： 2013314111 指导教师：任朝晖 日期： 2015 年 9 月 18 日
课程设计任务书 一、设计题目 文件访问接口设计 二、目的与要求 本设计的目的是通过BIOS调用设计简单的文件访问接口，使学生掌握程序接口的设计方法。 要求学生在熟悉比BIOS、DOS操作系统的中断接口及程序接口的基础上，利用C语言设计简单的文件访问接口，最后通过程序验证接口的正确性。三、设计内容 利用C语言设计，具体包括： 1、基本文件内容输入 2、基本文件内容输出 3、创建文件 4、打开文件 5、关闭文件 6、文件缓冲区管理 7、文件句柄管理 8、读顺序文件 9、写顺序文件 10、读随机文件 11、写随机文件 12、文本文件操作验证程序
程序，然后运行验证程序得到预期结果。 四、完成方式 独立完成：完成设计内容全部12个小项或至少3项以上。 五、具体要求 本设计的目的是通过BIOS调用设计简单的文件访问接口，使学生掌握程序接口的设计方法。 要求学生在熟悉比BIOS、DOS操作系统的中断接口及程序接口的基础上，利用C语言设计简单的文件访问接口，最后通过程序验证接口的正确性。六、进度安排 依照教学计划，课程设计时间为：2周。 1.要求讲解、资料查找、系统分析，概要设计（2天） 2.系统详细设计、功能设计（2天） 3.算法实现、编程调试（5天） 4.功能演示、资料整理、课程设计说明书编写。（1天） 七、完成后应上交的材料 课程设计说明书纸质文档 八、总评成绩 指导教师签名日期年月日
项目接口需求及设计说明文档
媒讯集团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来生成客户端代理。
项目接口需求及设计说明文档(模板)
客户化开发需求规格说明书 媒讯集团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来生成客户端代理。
完整的接口解决方案说明书
XXXXXX信息科技股份有限公司
1引言 1.1编写目的 本文档为XX电信工程外部协作系统（以下简称外协系统）与电信工程施工单位内部系统（以下简称施工系统）接口技术解决方案，以此作为外协系统与施工系统实施接口的技术方案依据和项目设计标准。 1.2覆盖范围 XX电信工程外部协作系统项目组 施工系统接口开发技术组 1.3预期读者与阅读建议 XX电信企业信息化部 XX电信工程建设部 XXXX公司开发人员 施工系统开发人员
1.4文档约定 粗体正文表示强调内容 红色正文表示未完成或需要今后考虑的内容 蓝色正文表示待讨论内容 1.5术语与缩略语 1.6参考文献 (XXXX) 2概述 建设XX电信工程外部协作系统的目标，是在工程项目的管理、建设、使用和实施单位之间搭建起数据交换和协同工作的信息平台，延伸与拓展工程建设管理信息化的应用范围，实现通信工程建设过程的信息化管理，促进工程项目的管理部门、建设部门、实施部门和使用部门之间业务流程协调有序地开展，实现工程项目设计、施工、监理管理功能，将相关的设计、施工、监理单位纳入到工程建设管理中，完善工程项目建设过程管理体系，通过信息化推动管理的规范化，在信息化的应用过程中不断探索市场环境下工程建设管理的新思路和新方法。 根据工程部业务工作的实际情况，项目首先满足工程建设管理中应用最广泛、问题最突出的基本需求。 项目功能需求包括： ?建立工程外部协作系统与MSS等系统的接口； ?建立设计协作服务、监理协作服务、施工协作服务模块，为邮电设计院、电话监理公司和电信工程公司提供工程部所需的协作服务，保证工程建设实施流程的开展； ?在建立工程协作服务模块的基础上，建立工程外部协作系统与邮电设计院、电话监理公司、电信工程公司信息系统的接口，实现工程部与三家实施单位的信息交互与
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; } } }
数据调用api接口
数据调用api接口 一，漫画分类列表 1，接口说明 返回分类信息对应的漫画数据列表。 2，URL https://www.sodocs.net/doc/de1254147.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/de1254147.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/de1254147.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/de1254147.html,\/2012\/04\/1074512_1335331124_Dqcx3zNs3d zn.small.png",//小封面 "ori":"https://www.sodocs.net/doc/de1254147.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 菜品星级
SDK通用版接口调用说明
SDK通用版接口调用说明
目录 1请仔细阅读信息安全责任保证条款 (2) 1.1安全信息责任条款 (2) 1.2注意事项：................................................................................. 错误！未定义书签。 1 Webservice接口 (3) 1.1 webservice返回集合对照表 (3) 2、多线程webservice接口 (5) 2.1 mdgxsend 个性短信 (5) 3、多线程http接口 (8) 3.1 多线程群发普通短信 (8) 3.2 多线程群发个性短信 (9) 请仔细阅读信息安全责任保证条款 安全信息责任条款 本人/本公司在使用本软件过程中，将严格遵守国家相关法律、法规、保证本公司信息发布的安全，并切实做到： （1）建立健全本公司信息发布的内部保障制度、信息安全保密制度、用户信息安全管理制度，建立健全本公司信息安全责任制度和信息发布的审批制度，严 格审查本公司产品所发布信息。 （2）严格遵守《互联网信息服务管理办法》，对用户编辑的信息内容进行把关，保证信息内容的健康、合法。 （3）明确本企业的客户群和客户范围，所有通讯受众必须是自愿且明确同意接受企业服务。 （4）若发送未经用户允许的信息等所造成的影响、投诉等一切损失与本软件版权方无关、由本人/本公司承担全部责任；同时，本人/本公司也应承担若因此 给本软件版权方造成的全部损失。 （5）不利用本软件制作、复制、发布、传播含有下列内容的信息： 反对宪法所确定的基本原则的；
?危害国家安全，泄露国家秘密，颠覆国家政权，破坏国家统一的； ?损坏国家荣誉和利益的； ?煽动民族仇恨、民族歧视，破坏民族团结的； ?破坏国家民族宗教政策，宣扬邪教和封建迷信的； ?散布谣言，扰乱社会秩序，破坏社会稳定的； ?散布淫秽、色情、赌博、暴力、凶杀、恐怖或者教唆犯罪的； ?侮辱或者诽谤他人，侵害他人合法权益的； ?含有法律、行政法规禁止的其他内容的； （6）自信息发布六个月内不修改删除信息发送日志内容，日志记录的备份应至少保持6个月以上，在国家机关进行依法查询时，予以提供。 （7）若发现本公司所发布的信息明显属于上述第（5）款所列内容，保证立即停止传输，并向国家有关机关报告。 （8）对本公司所发布的信息一时难以辨别是否属于以上所列内容之一的，应报相关主管部门审核同意后再发布。 （9）对客户的个人信息保密，未经客户同意不得向他人泄漏，但法律规定的除外。本人/本公司保证：在使用本软件进行信息发布活动中，服从监督和管理；若未做到上述一至八条，本人/本公司愿意承担由此引起的一切法律责任，并接受相应的处罚。 注意：发送之前，序列号一定需要先注册，序列号注册了才可以使用发送短信。 1 Webservice接口 1.1 webservice返回集合对照表
WebService接口实例说明文档
WebService接口说明文档 文档说明 本文档主要讲述如何用CSharp创建一个简单的WebService接口，并使用Java调用这个WebService接口。 准备工作 系统环境：安装JDK1.6或更新版本 开发工具：Microsoft Visual Studio2012、MyEclipse10.5、axis2-1.6.2 C Sharp服务端 1.首先，创建一个Web Service项目。依次点击：文件—新建—项目，在弹出的新建项目窗口中选择 Web下的https://www.sodocs.net/doc/de1254147.html, 空 Web应用程序。如下图： 2.接下来我们需要创建我们的WebService接口实现文件。鼠标右击我们的项目，依次点击：添加—新 建项，在弹出窗口中选择Web服务。可修改新建项的文件名，注意文件名后缀后.asmx。如下图：
新建完成后我们的项目结构如下： 3.打开我们新建的MyService.asmx下的MyService.asmx.cs文件，可以看到其中已经有默认的 HelloWorld方法。
我们可以直接运行查看下运行的效果，效果如下图： 点击HelloWorld，再点击调用可以看到页面返回：
4.接下来我们完善我们的WebService接口功能。主要对WebService接口进行参数类型的测试，文本型、 布尔型、数值型、类(Class)等。 新增Add()等运算方法： 新增strcat()连接字符串方法： 新增GetBool()返回布尔值方法： 新增GetTest()返回测试类，并新增Test类 运行我们的项目，可以看到我们的结果如下图：
点击add方法测试： 输入add的参数i和j点击调用按钮，可以看到返回计算结果： 5.到此为止我们C Sharp创建的WebService程序完成。接下来看Java如何调用我们的WebService接口。
接口调用说明文档
XXXX科技有限公司 数据接口 2015-5-26
目录 第1章引言............................................................. 错误!未定义书签。 背景.............................................................. 错误!未定义书签。第2章接口与数据定义................................................... 错误!未定义书签。 曝光台查询接口.................................................... 错误!未定义书签。 曝光台列表查询................................................ 错误!未定义书签。 曝光台详情查询................................................ 错误!未定义书签。 信用公示查询接口定义.............................................. 错误!未定义书签。 守信公示列表查询.............................................. 错误!未定义书签。 守信公示详情查询.............................................. 错误!未定义书签。 失信公示列表查询.............................................. 错误!未定义书签。 失信公示详情查询.............................................. 错误!未定义书签。 企业名称查询接口定义.............................................. 错误!未定义书签。 Webservice方法定义............................................ 错误!未定义书签。 请求参数...................................................... 错误!未定义书签。 返回数据...................................................... 错误!未定义书签。 企业信息查询接口定义.............................................. 错误!未定义书签。 Webservice方法定义............................................ 错误!未定义书签。 请求参数...................................................... 错误!未定义书签。 返回数据...................................................... 错误!未定义书签。