当前位置：文档库 › api接口技术文档

api接口技术文档

一、基本说明 (2)

二、统一Form表单参数 (2)

三、统一sign签名的生成规则 (3)

1、签名待加密字符串为key，timestamp，param组成的Json (3)

2、MD5签名规则 (3)

四、统一返回Json格式 (3)

五、部门接口 (4)

1、部门类ApiDept (4)

2、Url和Param (5)

3、调用示例 (6)

六、人员接口 (7)

1、人员类ApiUser (7)

2、Url和Param (8)

3、调用示例 (9)

一、基本说明

1、协议：http

2、请求方式：post

3、数据提交方式：Form表单提交

4、Accept：text/html

5、ContentType：application/x-www-form-urlencoded

6、返回格式：Json

二、统一Form表单参数

三、统一sign签名的生成规则

1、签名待加密字符串为key，timestamp，param组成的Json

如：

{"key":"xxxxxx","timestamp":1533630832,"param":null}

2、MD5签名规则

32位加密,每个字节转化为大写16进制并且输出2位四、统一返回Json格式

五、部门接口

1、部门类ApiDept

2、Url和Param

3、调用示例

六、人员接口

1、人员类ApiUser

2、Url和Param

3、调用示例

API接口文档

API接口文档最后更新日期：2013-05-16 一、添加域名接口 (6) 1、接口调用地址 (6) 2、传入参数 (6) 3、输出数据 (6) 二、删除域名接口 (7) 1、接口调用地址 (7) 2、传入参数 (7) 3、输出数据 (7) 三、添加用户接口 (8) 1、接口调用地址 (8) 2、传入参数 (8) 3、输出数据 (8) 四、获取用户信息接口 (9) 1、接口调用地址 (9) 2、传入参数 (9) 3、输出数据 (9) 五、搜索用户接口 (10) 1、接口调用地址 (10) 2、传入参数 (10) 3、输出数据 (10) 六、修改用户接口 (11) 1、接口调用地址 (11) 2、传入参数 (11) 3、输出数据 (12) 七、删除用户接口 (13) 1、接口调用地址 (13) 2、传入参数 (13) 3、输出数据 (13) 八、获取邮箱别名接口 (14) 1、接口调用地址 (14) 2、传入参数 (14) 3、输出数据 (14) 九、获取部门列表接口 (15) 1、接口调用地址 (15) 2、传入参数 (15) 3、输出数据 (15) 十、添加部门接口 (17) 1、接口调用地址 (17)

3、输出数据 (17) 十一、修改部门接口 (18) 1、接口调用地址 (18) 2、传入参数 (18) 3、输出数据 (18) 十二、删除部门接口 (19) 1、接口调用地址 (19) 2、传入参数 (19) 3、输出数据 (19) 十三、获取部门成员接口 (20) 1、接口调用地址 (20) 2、传入参数 (20) 3、输出数据 (20) 十四、添加部门成员接口 (21) 1、接口调用地址 (21) 2、传入参数 (21) 3、输出数据 (21) 十五、删除部门成员接口 (22) 1、接口调用地址 (22) 2、传入参数 (22) 3、输出数据 (22) 十六、添加别名接口 (23) 1、接口调用地址 (23) 2、传入参数 (23) 3、输出数据 (23) 十七、修改别名接口 (24) 1、接口调用地址 (24) 2、传入参数 (24) 3、输出数据 (24) 十八、删除别名接口 (25) 1、接口调用地址 (25) 2、传入参数 (25) 3、输出数据 (25) 十九、获取POP接收邮件接口 (26) 1、接口调用地址 (26) 2、传入参数 (26) 3、输出数据 (26) 二十、添加POP接收邮件接口 (27) 1、接口调用地址 (27) 2、传入参数 (27) 3、输出数据 (27) 二十一、修改POP接收邮件接口 (28) 1、接口调用地址 (28)

基于RS 232接口标准的SMT数据采集技术

基于RS 232 接口标准的SMT 数据采集技术 0 引言随着我国信息化建设的飞速发展，表面贴装技术日益普及，其生产线已经从当初的十几条发展到了现在的数千条，我国也由此一跃成为了世界SMT 第一应用大国。目前国防科研生产领域所拥有的表面贴装生产线已达几百条，但是在表面贴装技术领域中MES 技术的应用却还很少，极大地制约了信息技术的发展和表面贴装技术水平的提高。虽然目前国外存在一些MES，如日本松下公司、JUKI 公司、德国西门子公司等开发研制的，适用于自己贴片机等SMT 设备的MES,，但这些系统存在着仅适用于自己厂家的表面贴装设备等缺点。由于MES 的关键是数据采集技术的实现，因此，针对以上情况，本文提出了一种基于RS 232 接口标准的SMT 数据采集技术。本文首先介绍了RS 232 接口的基本内容，其次给出了SMT 中基于RS 232 接口标准的数据采集流程，最后采用VC++为开发平台对该采集技术进行实验验证。1 RS 232 接口标准目前RS 232 是PC 与通信工业中应用最广泛的一种串行接口，RS 代表推荐标准，232 是标识号。RS 232 采取不平衡传输方式，即单端通信。一个完整的RS 232 接口有22 根线，采用标准的25 芯插头座。除此之外，目前广泛应用的还有一种9 芯的RS 232 接口。它们的外观都是一个D 形，对接的两个接口又分为针式和孔式两种。RS 232 标准中定义了逻辑1 和逻辑0 电压级数，以及标准的传输速率和连接器类型。信号大小在正的和负的3～15 V 之间。RS 232 规定接近0 的电平是无效的，逻辑1 规定为负电平，有效负电平的信号状态称为传号(Marking)，它的功能意义为OFF；逻辑0 规定为正电平，有效正电平的信号状态称为空号(Spacing)，它的功能意义为ON。在RS 232 标准中规定的设备可以分为数据终端设备(DTE)和数据通信设备(DCE)两类，这种分类定义了不同的线路用来发送和接收信号。一般来说，计算机和终端设备有DTE 连接器，调制

ABAP(接口技术)

IDOC IDoc是 SAP 提供系统集成专用的数据/消息格式。它几乎可以传送任何 SAP 应用数据。IDocs以文本字符为基础，因而编制方便。IDocs中的信息从记录类型上分为控制记录、数据记录和状态记录3种。控制纪录主要是文本信息，如IDoc, 类型、发送/接收方信息以及文本标识；数据纪录为管理和实际数据部分；状态纪录用来追踪文本传递各点的状态，如状态码、系统时间、错误标识等。功能：向外部系统发送数据从外部接收数据。创建IDOC: 第一步:WE31 创建IDOC所包含的字段. 第二步:WE30 创建IDOC 把Segment分配给IDOC 第三步:WE81 创建信息类型第四步:WE82 把IDOC类型与信息类型对应. 第五步:WE57 Assign Message & Idoc Type to a Function Module for Data Process 第六步:SM59 Define a RFC connection for Idoc transfer 第七步：WE21 Define a Port ( Assign a RFC destination which created in SM59 ) 第八步：WE41/42 Creat Process Code 第九步：WE20 Define a Partner Profiles( Also creat a Outbound parameters with Port, or Inbound parameters with Process code ) 管理IDOC: WE02 显示IDOC,可以根据时间，IDOC类型查找IDOC，查看成功，出错信息。 WE46 IDOC管理(出\入) WE60 IDOC类型文档(可以查看IDOC结构,和每个字段的描述. WE19 根据IDOC号进行IDOC处理，可以修改IDOC值进行补发动作，处理分为内向和外向。消息配置： WE20 配置伙伴消息进和出IDOC类型 WE21 配置伙伴, BAPI和RFC和ALE和EXIT的区别 BAPI和RFC不是同一个层次上概念，不能说从字面上看到BAPI函数和RFC函数就认为他们之间有必然的联系和区别。打个比如，问一个问题：人可以分为哪几类，答曰：男人和老人，呵~~，大家都知道，男人是基于性别来说的，老人是基于年龄的。BAPI是SAP提供

百度知道开放平台openAPI接口规范文档 V1.0

修改记录 No 修改后版本号修改内容简介修改日期修改人 1 1.0 百度知道OPEN API服务接口2010-11-04 陈霖

目录 1背景 (6) 2规范适用对象说明 (6) 3名词解释 (6) 4请求数据包格式规范 (6) 4.1URL (6) 4.2参数 (7) 4.2.1系统级参数 (7) 4.2.2业务级参数的通用约定 (7) 4.2.3参数签名算法 (7) 5响应数据包格式规范 (8) 5.1XML输出格式 (8) 5.2json输出格式 (9) 5.3错误响应输出格式 (9) 6错误码定义 (10) 7API接口细则 (10) 7.1baidu.zhidao.getCatalogInfo (10) 7.1.1功能 (10) 7.1.2参数 (11) 7.1.3返回值 (11) 7.2baidu.zhidao.getQuestionList (11) 7.2.1功能 (11) 7.2.2参数 (11) 7.2.3返回值 (12) 7.3baidu.zhidao.getQuestionSearch (12) 7.3.1功能 (12) 7.3.2参数 (12) 7.3.3返回值 (13) 7.4baidu.zhidao.getQuestionInfo (13) 7.4.1功能 (13) 7.4.2参数 (13) 7.4.3返回值 (14) 7.5baidu.zhidao.getQuestionAnswer (14) 7.5.1功能 (14) 7.5.2参数 (14) 7.5.3返回值 (15) 7.6baidu.zhidao.getUserInfo (15) 7.6.1功能 (15) 7.6.2参数 (15) 7.6.3返回值 (15) 7.7baidu.zhidao.getUserQuestionList (16) 7.7.1功能 (16) 7.7.2参数 (16)

开发接口文档-API文档模板

XXX项目接口文档版本控制信息获取所有字段获取所有字段请求地址：/session/field/findAll 请求参数响应

请求例子：响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统处理正常！ ","page":0,"pageSize":0,"returnObject":null,"returnValue":{"types":null,"villages":null,"companys":[{"iconColour":"","iconSize":0,"ico nStyle":"","id":4,"name":"XX"},{"iconColour":"","iconSize":0,"iconStyle":"","id":5,"name":"XX"},{"iconColour":"","iconSize":0,"iconSty le":"","id":7,"name":"XX"}]},"totals":0} 文件上传文件上传（ajax）请求地址：/session/file/upload 请求参数响应请求例子：var formData = new FormData(); ("file", [0]); $.ajax({ url : routePath + "/session/file/upload", type : 'POST', data : formData,

processData : false, contentType : false, success : function(result) { result = (result); if == "10000"){ ('上传成功！'); $("#editHeadPortrait").val } } }); 响应例子：returnValue里包含了 fileName和filePath 字段管理-所属类型新增所属类型请求地址：/session/fieldType/save 请求参数响应请求例子：响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统处理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"totals":0}

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)

百度知道OPEN API接口规范文档1.0_final

修改记录 No 修改后版本号修改内容简介修改日期修改人 1 1.0 百度知道OPEN API服务接口2010-08-26 耿艳坤

目录 1背景 (4) 2规范适用对象说明 (4) 3名词解释 (4) 4请求数据包格式规范 (4) 4.1URL (4) 4.2参数 (4) 4.2.1系统级参数 (4) 4.2.2业务级参数的通用约定 (5) 4.2.3参数签名算法 (5) 5响应数据包格式规范 (6) 5.1XML输出格式 (6) 5.2json输出格式 (6) 5.3错误响应输出格式 (7) 6错误码定义 (7) 7API接口细则 (8) 7.1baidu.zhidao.getQuestionList (8) 7.1.1功能 (8) 7.1.2参数 (8) 7.1.3返回值 (8) 7.2baidu.zhidao.getQuestionSearch (9) 7.2.1功能 (9) 7.2.2参数 (9) 7.2.3返回值 (9) 7.3baidu.zhidao.getQuestionInfo (10) 7.3.1功能 (10) 7.3.2参数 (10) 7.3.3返回值 (10) 7.4baidu.zhidao.getQuestionAnswer (11) 7.4.1功能 (11) 7.4.2参数 (11) 7.4.3返回值 (12) 7.5baidu.zhidao.question (12) 7.5.1功能 (12) 7.5.2参数 (12) 7.5.3返回值 (12) 7.6baidu.zhidao.answer (13) 7.6.1功能 (13) 7.6.2参数 (13) 7.6.3返回值 (13) 8第三方提供API接口细则 (14) 9附件及参考资料 (15)

共享平台API接口规范文档V0.7s

共享平台API接口规范版本: 0.7s 携程旅行网

目录 1.前言 (4) 1.1功能描述 (4) 1.2阅读对象 (4) 1.3业务术语 (4) 1.4技术服务............................................................................................................... 错误!未定义书签。 2.接口参数说明 (5) 2.1普通政策请求参数 (5) 2.2特惠政策请求参数 (5) 2.3特价政策请求参数 (16) 3.示例Xml请求 (16) 3.1普通政策 (16) 3.2特惠政策 (16) 3.3特价政策 (19) 4.错误代码整理 (21) 4.1错误代码规则说明 (21) 4.2错误固定标识及错误代码分类说明 (21) 4.3目前已知错误代码列表 (21)

版本历史

1.前言 1.1 功能描述为了提高代理商在携程网的政策投放效率，满足其业务需求，由携程机票研发部门开发了一套代理商政策导入接入API。本文档是为了描述相应的接口规范。 1.2 阅读对象面向具有一定技术实力的代理商公司相应的技术人员 1.3 业务术语 1.4 接口API导入必读 API导入入口： https://www.wendangku.net/doc/726661641.html,/Flight-Product-TradeAPI/PolicyWS.asmx

接口参数： username: 用户名 password: 密码（格式: MD5(UTF-8(“username#password”)）) execType: 执行类型，只支持FullADD(全量上传), ADD(增量上传) gzipRequestBytes: 请求报文字节数组，是对报文进行GZIP后产生的字节流接口响应格式：返回的是对报文GZIP后的base64位格式的文本编码目前每日最大请求次数是500次 1.5 技术服务前期请直接联系相应的票台关联业务人员 2.接口参数说明 2.1 普通政策请求参数

企业数据采集接口规范

广东省食品药品监督管理局国家电子监管系统省局端系统企业数据采集接口规范建设单位：广东省食品药品监督管理局监理单位：广州市信佰信息技术咨询有限公司承建单位：深圳市天驰医药信息技术开发有限公司 2012年12月12日

修改情况记录：

目录 1. 概述 (4) 1.1. 接口内容 (4) 1.2. 实现方式 (4) 1.3. 安全控制 (4) 2. 术语与缩写解释 (4) 3. 系统入口 (5) 4. 接口详细说明 (5) 4.1. 接口功能列表 (5) 4.2. 响应数据格式公共约定 (5) 4.3. 下载经营品种库 (7) 4.4. 下载往来企业库 (10) 4.5. 上传文件 (12) 4.6. 下载文件处理情况 (14) 附录一企业上传xml数据文件格式 (16) 库存记录 (16) 不合格药品记录 (17) 生产入库 (17) 采购入库 (18) 批发退货入库 (18) 零售退货入库 (19) 批发出库 (20) 零售出库 (20) 退货出库 (21) 毁损出库 (21) 抽检出库 (22) 附录二xml数字签名 (23) 附录三附件说明 (24)

1.概述本文档描述《广东省食品药品监督管理局国家电子监管系统省局端系统》平台与广东省内药品流通相关企业内部系统之间的接口规范。 1.1. 接口内容提供企业经营品种库药品标准数据及其更新信息下载；提供企业往来企业库企业标准数据及其更新信息下载；接收企业上传已数字签名xml格式数据文件；提供企业上传文件处理情况。 1.2. 实现方式标准HTTPS GET/POST。 1.3. 安全控制要求客户端数字证书以实现服务器端与客户端双向身份验证。备注：目前仅支持网证通数字证书，且必须在药监局已备案。 2.术语与缩写解释

java开发接口文档模板

竭诚为您提供优质文档/双击可除java开发接口文档模板篇一：java的接口与实例一、定义 java接口（interface），是一系列方法的声明，是一些方法特征的集合，一个接口只有方法的特征没有方法的实现，因此这些方法可以在不同的地方被不同的类实现，而这些实现可以具有不同的行为（功能）。接口定义的一般形式为： [访问控制符]interface{ 类型标识符final符号常量名n=常数；返回值类型方法名([参数列表]); … } 二、接口的特点 1、java接口中的成员变量默认都是 public,static,final类型的(都可省略),必须被显示初始化,即接口中的成员变量为常量(大写,单词之间用"_"分隔) 2、java接口中的方法默认都是public,abstract类型

的(都可省略),没有方法体,不能被实例化 3、java接口中只能包含public,static,final类型的成员变量和public,abstract类型的成员方法 4、接口中没有构造方法,不能被实例化 5、一个接口不能实现(implements)另一个接口,但它可以继承多个其它的接口 6、java接口必须通过类来实现它的抽象方法 7、当类实现了某个java接口时,它必须实现接口中的所有抽象方法,否则这个类必须声明为抽象类 8、不允许创建接口的实例(实例化),但允许定义接口类型的引用变量,该引用变量引用实现了这个接口的类的实例 9、一个类只能继承一个直接的父类,但可以实现多个接口,间接的实现了多继承. 三、接口的用法 1、精简程序结构，免除重复定义比如，有两个及上的的类拥有相同的方法，但是实现功能不一样，就可以定义一个接口，将这个方法提炼出来，在需要使用该方法的类中去实现，就免除了多个类定义系统方法的麻烦。举例：鸟类和昆虫类都具有飞行的功能，这个功能是相同的，但是其它功能是不同的，在程序实现的过程中，就可以定义一个接口，专门描述飞行。下图是分别定义鸟类和昆虫类，其都有飞行的方法。

api接口文档

API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件的以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。API除了有应用“应用程序接口”的意思外，还特指API的说明文档，也称为帮助文档。 API：应用程序接口（API：Application Program Interface）应用程序接口（是一组定义、程序及协议的集合，通过API 接口实现计算机软件之间的相互通信。API 的一个主要功能是提供通用功能集。程序员通过调用API 函数对应用程序进行开发，可以减轻编程任务。API 同时也是一种中间件，为各种不同平台提供数据共享。根据单个或分布式平台上不同软件应用程序间的数据共享性能，可以将API 分为四种类型：远程过程调用（RPC）：通过作用在共享数据缓存器上的过程（或任务）实现程序间的通信。标准查询语言（SQL）：是标准的访问数据的查询语言，通过数据库实现应用程序间的数据共享。文件传输：文件传输通过发送格式化文件实现应用程序间数据共享。

信息交付：指松耦合或紧耦合应用程序间的小型格式化信息，通过程序间的直接通信实现数据共享。当前应用于API 的标准包括ANSI 标准SQL API。另外还有一些应用于其它类型的标准尚在制定之中。API 可以应用于所有计算机平台和操作系统。这些API 以不同的格式连接数据（如共享数据缓存器、数据库结构、文件框架）。每种数据格式要求以不同的数据命令和参数实现正确的数据通信，但同时也会产生不同类型的错误。因此，除了具备执行数据共享任务所需的知识以外，这些类型的API 还必须解决很多网络参数问题和可能的差错条件，即每个应用程序都必须清楚自身是否有强大的性能支持程序间通信。相反由于这种API 只处理一种信息格式，所以该情形下的信息交付API 只提供较小的命令、网络参数以及差错条件子集。正因为如此，交付API 方式大大降低了系统复杂性，所以当应用程序需要通过多个平台实现数据共享时，采用信息交付API 类型是比较理想的选择。 API 与图形用户接口（GUI）或命令接口有着鲜明的差别：API 接口属于一种操作系统或程序接口，而后两者都属于直接用户接口。有时公司会将API 作为其公共开放系统。也就是说，公司制定自己的系统接口标准，当需要执行系统整合、自定义和程序应用等操作时，公司所有成员都可以通过该接口标准调用源代码，该接口标准被称之为开放式API。

数据采集接口网关

数据采集接口网关Gateway ForeverCredit Gateway数据采集接口网关是北京华恒信远专门为工业标准通讯接口OPC Server软件、数据采集接口软件配套定制开发的一款嵌入式硬件产品，内置两个标准RS-232串口（其中一个串口可以通过跳线设置成RS-485）和两个RJ45以太网口，型号为Gateway-227B，如下图所示：此外，还有Gateway-240B、Gateway-230B等嵌入式工控机型号，如下图所示。该设备操作系统有Windows、Linux两种，其功能与特点如下： 1、OPC服务器：可连接DCS、PLC等控制系统，读写实时数据，包装成OPC Server工业标准通讯接口，提供给实时数据库系统、先进控制系统和MES系统集成商； 2、安全隔离：当数据采集接口网关为实时数据库系统提供实时数据时，它一般位于自动化控制系统和实时数据库服务器之间，由于数据采集接口网关采用了内置单向数据传输技术，可达到自动化控制系统和实时数据库服务器之间的安全隔离目的。 3、该产品操作系统、数据采集程序等均固化，不可修改。一旦被修改，重新启动后，自动恢复到初始状态，可防止病毒以及黑客软件攻击。 4、结构先进、安装方便，该产品高度1U，可以直接安装在

标准机柜中，独特的散热技术，1U机箱有多个磁悬浮风扇散热。 5、数据采集冗余设计：支持双机双网冗余通讯。 6、可作为、PI、PHD等实时数据库系统的数据采集终端，也可写数据至关系数据库，为MIS、ERP等管理信息系统提供生产实时数据。网闸FC-Safety FC-Safety管控单向物理隔离网闸，又称管控单向物理隔离网关，是专门为企业过程控制系统和管理信息系统之间进行单向物理隔离而开发的一款网络安全隔离设备。在石油、石化、钢铁、冶金、电力、化工等流程型企业的工业自动化过程中，DCS、PLC、电力综合自动化等过程控制系统越来越广泛地应用在流程型企业的生产控制过程中。流程型企业信息化建设在国内越来越普及，由于担心控制网被攻击，企业往往要求企业信息

api接口文档

接口：接口泛指实体把自己提供给外界的一种抽象化物，用以由内部操作分离出外部沟通方法，使其能被内部修改而不影响外界其他实体与其交互的方式。在计算机中，接口是计算机系统中两个独立的部件进行信息交换的共享边界。这种交换可以发生在计算机软、硬件，外部设备或进行操作的人之间，也可以是它们的结合。 API： API是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。用来提供应用程序与开发人员基于某软件或硬件得以访问的一组例程，而又无需访问源码，或理解内部工作机制的细节。简介：操作系统是用户与计算机硬件系统之间的接口，用户通过操作系统的帮助，可以快速、有效和安全、可靠地操纵计算机系统中的各类资源，以处理自己的程序。为使用户能方便地使用操作系统，OS 又向用户提供了如下两类接口：用户接口：操作系统专门为用户提供了“用户与操作系统的接口” ，通常称为用户接口。该接口支持用户与OS 之间进行交互，即由用户向OS 请求提供特定的服务，而系统则把服务的结果返回给用户。程序接口：操作系统向编程人员提供了“程序与操作系统的接口” ，简称程序接口，又称应用程序接口API。该接口是为程序员

在编程时使用的，系统和应用程序通过这个接口，可在执行中访问系统中的资源和取得OS 的服务，它也是程序能取得操作系统服务的唯一途径。大多数操作系统的程序接口是由一组系统调用(system call)组成，每一个系统调用都是一个能完成特定功能的子程序。应用程序接口又称为应用编程接口，是一组定义、程序及协议的集合，通过API接口实现计算机软件之间的相互通信。API 的一个主要功能是提供通用功能集。API同时也是一种中间件，为各种不同平台提供数据共享。程序设计的实践中，编程接口的设计首先要使软件系统的职责得到合理划分。良好的接口设计可以降低系统各部分的相互依赖，提高组成单元的内聚性，降低组成单元间的耦合程度，从而提高系统的可维护性和可扩展性。

如何进行SSI接口的数据采集

如何进行SSI接口的数据采集？(Part I) 对于SSI接口的传感器可以采用并行和串行两种采集方法，分别对应 SSI208P和SSI-UART两种产品。 1、SSI接口转并口模块 SSI208P，主要应用于同步串行接口（SSI）光电编码器高速数据采集系统的板级开发。SSI208P模块将同步串行接口数据转换成并行接口数据，内部集成了SSI 同步时钟发生器、脉冲计数器、数据串并转换、接口控制逻辑、输出控制以及收发驱动器（TTL-RS422电平转换）等功能单元，用户无须了解SSI数据格式，该模块自动将SSI数据转换成8位并行数据，简化了SSI编码器与DSP、单片机、PC104等控制器的接口。(1)产品特性单3.3V供电，工作电流小于100mA；通信速率可配置，最高达2MHz；24脚双列直插封装，尺寸25.4*25.4*6（mm）；8位数据总线，可接8~32位编码器；16位数据更新率大于100KHz；内部时钟，固定时序；内置422差分驱动。(2)产品介绍该模块具有内部时钟，能自动将SSI数据转换成并行数据，对SSI接口数据的读取操作就类似于对A/D、D/A或存储器读取数据的操作一样方便。SSI208P模块通信速率可配置为250KHz、500KHz、1MHz、2MHz，当通信速率配置为2MHz时，对于16位精度的编码器，系统数据更新率不低于100KHz。此外，该模块对采集的数据长度（编码器精度）可以进行配置，最高可以采集32位数据，分4次输出，该模块可以满足高精度高速伺服控制系统的需求。(3)外形尺寸25.4×25.4×6(mm).关于该模块的详细资料见SSIP208P说明书。 2、SSI接口转串口模块 SSI-UART模块可以将SSI同步串行数据转换成通用异步串行(UART，可配置为RS-232/RS485/RS422方式)数据，工控领域常用的PC机、工控机、DSP、单片机等控制系统上一般都配备有通用异步串行接口，使用SSI-UART模块可以方便地实现SSI编码器与这些控制系统的连接。 (1) 功能及参数 ●SSI数据转换为RS-232通用异步串行数据； ●SSI时钟速率选择（125KHz、250KHz、500KHz、1MHz）； ●支持格雷码和二进制码数据格式转换； ●支持编码器地址配置； ●可配置编码器供电电压5V或24V； ●供电方式：直流18-30V； ●电流：不大于60mA； ●工作温度：－40℃~－75℃；

开心网API接口说明文档

开心网API接口说明文档以下是为大家整理的开心网ApI接口说明文档的相关范文，本文关键词为开心,ApI,接口,说明,文档,oauth,认证,获取,授权，您可以从右上方搜索框检索更多相关文章，如果您觉得有用，请继续关注我们并推荐给您的好友，您可以在综合文库中查看更多范文。 1.oauth认证 ①获取未授权的Requesttoken 需要第三方应用程序的ApIKey和ApIsecrect才能在相应的接口地址申请未授权的Requesttoken。ApIKey和ApIsecrect是第三方应用与

开心网申请获得的，在使用Kaixin_android_sdk之前，先要把/kaixin_android_sdk/src/com/kaixin/connect/Kainxin.java中的consumeR_KeY和consumeR_secRecT替换成为你申请的ApIKey和ApIsecretKey。示例代码： Kaixinkaixin=Kaixin.getInstance();Try{ //获取未授权的RequestToken If(kaixin.getRequsetToken(context,”….”)){uriuri= uri(Kaixin.Kx_AuThoRIZe_uRL+”?oauth_token”+kaixin,getRequestToken() ); startActivity(newIntent(…),uri);}} ApI提供了获得未授权的RequestToken的方法，就是getRequestToken();传两个参数，第一个是当前的上下文，第二个是callbackuRL(重定向的uRL地址)。返回类型是boolean值，false就是没有申请成功。 ②请求用户授权RequestToken uri中的保存的是请求用户授权的接口地址。（1）此页面中会要求用户登录，然后选择同意或者拒绝对应用授权。（2）授权成功后: A:web应用会重定向到oauth_callback所指定的uRL（含返回参数）b:客户端应用(oauth_callback=oob)会在网页中给出授权码，用户需要手工将验证码输入到应用中才能完成授权流程。

开发接口文档-API文档模板

XXX项目接口文档版本控制信息 1获取所有字段 1.1获取所有字段请求地址：/session/field/findAll 响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统处理正常！ ","page":0,"pageSize":0,"returnObject":null,"returnValue":{"types":null,"villages":null,"companys":[{"iconColour":"", "iconSize":0,"iconStyle":"","id":4,"name":"XX"},{"iconColour":"","iconSize":0,"iconStyle":"","id":5,"name":"XX"},{"icon Colour":"","iconSize":0,"iconStyle":"","id":7,"name":"XX"}]},"totals":0}

2文件上传 2.1文件上传（ajax）请求地址：/session/file/upload formData.append("file", this.files[0]); $.ajax({ url : routePath + "/session/file/upload", type : 'POST', data : formData, processData : false, contentType : false, success : function(result) { result = JSON.parse(result); if(result.code == "10000"){ layer.msg('上传成功！'); $("#editHeadPortrait").val(result.returnValue.filePath); } } }); 响应例子：returnValue里包含了 fileName和filePath 3字段管理-所属类型 3.1新增所属类型请求地址：/session/fieldType/save

数据采集规范

附件: 农村电子商务和社区商业信息系统数据采集规范（试行）农村电子商务和社区商业信息系统由商务部市场建设司委托中国国际电子商务中心建设和维护，主要用于对电子商务进农村综合示范工作进展和资金使用等信息数据进行收集、分析和利用。一、系统功能架构信息系统目前包括商务部用户、省级商务主管部门用户、示范县用户和企业用户等四类用户。省级商务主管部门用户功能包括数据审核、报表查询、数据汇总、报送汇总、用户管理等功能。示范县用户功能包括数据上报、报表查询、数据汇总、用户管理等功能。企业用户功能包括数据上报、报表查询、用户管理等功能。二、数据采集指标农村电子商务和社区商业信息系统数据采集指标包括日报指标、月报指标和年度指标。（一）日报数据采集指标。日报数据主要采集站点交易数据，具体指标包括：站点代买商品类别、代买总金额、代买总订单数、销售商品类别、销售总金额、销售总订单数。（数据表格见表一）（二）月报数据采集指标。月报数据主要采集电子商务进农村综合示范工作进展和资金

拨付等信息，具体包括：农村电子商务物流配送体系建设情况、农村电子商务公共服务体系建设情况、支持开展农村产品电子商务情况、农村电子商务培训情况。（数据表格见表二）（三）年报数据采集指标。年报数据主要包括地区生产总值、社会消费品零售总额、面积、乡镇数量、行政村数量、常住人口、城镇人口、农村人口、居民人均可支配收入等指标。（数据表格见表三）（四）数据采集频率。日报数据由示范县综合示范项目承办单位通过数据传输接口，自动传输至全国平台。月报数据由示范县每月初填报上月月度进展信息。年报数据由示范县每年年初填报上一年年度县域经济发展数据。三、日报数据接口设计规范与假定约束（一）数据接口设计规范。协议规范：访问和数据返回都采用WebService 协议的方式；格式规范：数据的传输参数和返回的结果数据串都以XML 的形式表达；安全控制：本接口需要农村电子商务和社区商业信息系统中各企业的企业编码来进行身份验证。性能控制参数： 1.服务时间段：控制访问的服务时间段；目前为0-24 点 2.两次访问的时间间隔：避免用户频繁访问；访问间隔不能小于3秒钟（二）假定约束。

用USB做为数据采集接口

用USB故为数据采集接口 USB（通用串行总线）已成为消费类应用中的低成本PC接口标准。但最近它成为数据采集应用中一种流行接口。 USB1.1 与USB2.0 USB2.0是USB规范的最新版本。为了保持与现有器件向后的兼容，USB2.0操作规范是USB1.1规范的高级形式。USB2.0可以做USB1.1的每件工作，它与USB1.1是完全兼容的。另外，USB2.0支持更快的传输。USB2.0的最高数据传输率是 480Mb/s，这比USB1.1所支持的最高速度快40倍。数据传输模式 USB可用在大量的应用中，为此，USB开发者已建立了4种不同的数据模式：控制、中断、集群和同步模式。每种模式都有优、缺点，而应用通常将确定采用哪种模式。控制模式控制传输用于配置，而所有装置都必须支持控制传输。可以配置数据采集装置所需的非常有限的数据传输能力只用于控制模式，尽管大多数据装置利用其他数据传输模式。中断模式中断传输通常用在必须在将定时间传输数据，如很多数据采集应用或键盘、鼠标接口。每个USB端口提供多种中断传输管道。保用定时使中断模式用在大多数数采集应用中是理想的。一个单数据采集装置，可用多中断传输来提供较高的数据传输率。由于有大量中断和总线带宽受限制，所以用多中断降低可连接到专门USB端口上的独立装置数量。集总模式集总模式通常用在传输率不受限制时，如到打印机的写入。集总传输将采用分配给其他传输类型的带宽，所以将不会减慢极限工作。若总线是忙的，则集总传输将得到最低优先级。随着大多数数据丢失，所以，对于大多数数据采集应用不推荐用集总模式。同步模式同步传输正在流行于音频或视频中恒定数据率传输。这对于重新传输已被接收带误差的数据是不可能的，所以，它不适合于必须是精确的数据。这限制同步模式在大多数数据采集应用中的采用。总的来说，中断模式最适合大多数数据采集应用。同步模式被大多数应用所排除，因为它不能提供数据完整性。集总和控制模式可用于实现很多数据采集装置。但是，由于它们不能提供保用的数据传输率，所以，若数据采集装置不能提供非常大的数据缓冲器，则会有实际丢失数据的危险。在用户调研不同供应商数据采集装置时，要询问是采用哪一种传输模式。若装置所采用的模式不是中断模式，用户在计划连接到多个装置到一个给定USB端口时，应询问可能的系统限制。数据传输率现在，USB B范允许系统在三个不同数据传输率下运行。USB2.0和1.1支持在低速和全速下数据传输。除这些数率外，USB2.0支持总线速度在高速。表1列出理论最高传输率和有关低速、全速和高速传输的其它性能指标。

开发接口文档API文档模板

X X X项目接口文档版本控制信息 1获取所有字段 1.1获取所有字段请求地址：/session/field/findAll 请求参数响应响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统处理正常！ ","page":0,"pageSize":0,"returnObject":null,"returnValue":{"types":null,"villages":null,"companys":[{"iconColour":"", "iconSize":0,"iconStyle":"","id":4,"name":"XX"},{"iconColour":"","iconSize":0,"iconStyle":"","id":5,"name":"XX"},{"icon Colour":"","iconSize":0,"iconStyle":"","id":7,"name":"XX"}]},"totals":0} 2文件上传

2.1文件上传（ajax）请求地址：/session/file/upload 请求参数响应请求例子：var formData = new FormData(); ("file", [0]); $.ajax({ url : routePath + "/session/file/upload", type : 'POST', data : formData, processData : false, contentType : false, success : function(result) { result = (result); if == "10000"){ ('上传成功！'); } } });