接口说明
调用函数库：
提供Windows下的32位动态连接库proRFL.DLL
函数使用详细说明
//-----------------------------------------------------------------------------------// 功能：读DLL版本，不涉及USB口操作
C++原型：int __stdcall GetDLLVersion(uchar *bufVer)
返回：DLL版本
//-----------------------------------------------------------------------------------// 功能：打开USB
C++原型：int __stdcall initializeUSB(uchar d12)
参数说明：
d12 → USB类型，对于proUSB固定为1
返回：0表示成功，否则失败
注意：以下的函数均要用到此参数，均固定为1
//-----------------------------------------------------------------------------------// 功能：发卡器鸣叫一声
C++原型：int __stdcall Buzzer(uchar d12,unsigned char t)
参数说明：
d12 → USB类型，对于proUSB固定为1
t →鸣叫时间，乘以10毫秒
返回：0表示成功，否则失败
//-----------------------------------------------------------------------------------//
功能：发行“客人卡”，又称“宾客卡”或“房卡”
C++原型：int __stdcall GuestCard(uchar d12,int dlsCoID,uchar CardNo,uchar dai,uchar LLock,uchar pdoors,uchar BDate[10],uchar EDate[10],uchar LockNo[8],uchar *cardHexStr)
参数说明：
d12 → USB类型，对于proUSB固定为1
dlsCoID →酒店标识，可以从现有卡片读取
CardNo →同一分钟内发卡最多16张，每发一张卡加1
Dai →客人代，0--255，用于后卡覆盖前卡，一般情况下固定为0 LLock →反锁标志，1能开反锁，0不能开反锁
pdoors →公共门标志，必须固定为0
BDate →发卡时间10位数字字符串，包含年月日时分，各占两位例：'0905201345'表示2009/05/20 13:45
EDate →退房时间10位数字字符串，包含年月日时分，各占两位LockNo →锁号8位数字字符串，从门锁软件的房间定义里获取cardHexStr →返回的卡数据字符串
返回：0表示成功，否则失败
//-----------------------------------------------------------------------------------// 功能：读取卡片数据
C++原型：int __stdcall ReadCard(uchar d12,uchar *buffData) d12 → USB类型，对于proUSB固定为1
buffData →返回的卡数据字符串，有数据头551501表示成功，
从第25个字符开始的8个字符是卡的唯一号，也称为卡的ID号
返回：0表示成功，否则失败
//-----------------------------------------------------------------------------------// 功能：注销卡片
C++原型：int __stdcall CardErase(uchar d12,int dlsCoID,unsigned char *cardHexStr)
d12 → USB类型，对于proUSB固定为1
dlsCoID →酒店标识，可以从现有卡片读取
cardHexStr →返回的卡数据字符串
返回：0表示成功，否则失败
//-----------------------------------------------------------------------------------// 功能：挂失卡片
C++原型：int __stdcall LimitCard(uchar d12,int dlsCoID,uchar CardNo,uchar dai,uchar BDate[10],uchar LCardNo[4],uchar
*cardHexStr)
参数说明：
d12 → USB类型，对于proUSB固定为1
dlsCoID →酒店标识，可以从现有卡片读取
CardNo →同一分钟内发卡最多16张，每发一张卡加1
Dai →代，0--255，用于后卡覆盖前卡，一般情况下固定为0 BDate →发卡时间10位数字字符串，包含年月日时分，各占两位例：'0905201345'表示2009/05/20 13:45
uchar LCardNo →遗失卡的卡流水号，4个字节，由发卡时间、卡类型、卡号等组成
cardHexStr →返回的卡数据字符串
返回：0表示成功，否则失败
//-----------------------------------------------------------------------------------// 功能：读取卡类型
C++原型：int __stdcall GetCardTypeByCardDataStr(unsigned char
*cardHexStr, unsigned char *CardType)
cardHexStr → ReadCard函数返回的卡数据字符串
返回：0表示成功，否则失败
CardType==’0’ 授权卡
Ca rdType==’1’ 记录卡
CardType==’2’ 房号设置卡
CardType==’3’ 时间设置卡
CardType==’4’ 限制卡,也称为挂失卡
CardType==’5’ 组号设置卡
CardType==’6’ 客人卡
CardType==’7’ 退房卡
CardType==’8’ 组控卡
CardType==’9’ 未知卡,没有此卡类型
CardType==’A’ 应急卡
CardType==’B’ 总卡
CardType==’C’ 楼栋卡
CardType==’D’ 楼层卡
CardT ype==’E’ 未知卡,没有此卡类型
CardType==’F’ 空白卡
//-----------------------------------------------------------------------------------// 功能：读取客人卡的锁号
C++原型：int __stdcall GetGuestLockNoByCardDataStr(int dlsCoID,unsigned char *cardHexStr, unsigned char *LockNo) dlsCoID →当前酒店的酒店标识
cardHexStr → ReadCard函数返回的卡数据字符串
返回：0表示成功，否则失败,
1—卡数据串无效
2—非本酒店卡
3—不是客人卡
LockNo：锁号，有8位数字字符串组成，同GuestCard函数
//-----------------------------------------------------------------------------------// 功能：读取客人卡的离店时间
C++原型：int __stdcall GetGuestETimeByCardDataStr(int dlsCoID,unsigned char *cardHexStr, unsigned char *ETime)
dlsCoID →当前酒店的酒店标识
cardHexStr → ReadCard函数返回的卡数据字符串
返回：0表示成功，否则失败,
1—卡数据串无效
2—非本酒店卡
3—不是客人卡
ETime：离店时间，有10位数字字符串组成，分别为年月日时分，各占两位
//-----------------------------------------------------------------------------------// //---------------------------------开台和结账函数说明-------------------------// function ReadWriteCardFlag (fUSB:
Byte;carddata:PChar;FLAG:integer):Integer; stdcall;
external 'proMFL.DLL';-----delphi声明方式；
fUSB参数，当打开USB成功时候，这个值为1；
carddata参数，返回M1卡固有的ID 8位字符数据；
FLAG参数：当此值为1时候表示开台；当此值为0时，表示结账；当此值为3时候表示只读固有ID8位字符数据卡号；
Web Services业务接口规范说明书
XXXX系统 Web Services业务接口规范说明书 拟制 审核 会签 批准 【公司名称】
版本历史
目录 1.范围 (1) 2.术语、定义和缩略语 (1) 2.1 术语、定义 (1) 2.2 缩略语 (1) 3.接口设计 (1) 3.1 接口公共参数 (1) 3.1.1请求参数 (1) 3.1.2返回参数 (2) 3.2 业务功能接口 (3) 3.2.1业务模块1 (3) 4.MD5加密 (6) 5.参考文献 (6)
1.范围 本规范文档主要适用于XXXX系统和其它业务系统信息数据的接入。 2.术语、定义和缩略语 2.1术语、定义 2.2缩略语 3.接口设计 3.1接口公共参数 接口服务器通过：http://IP:port/EIP/WebService/ 连接服务器，同时对外提供业务功能接口，接收的参数和返回的参数都用一定的xml格式进行封装。 3.1.1请求参数 1.请求类型为String类型
3.请求参数体param定义 参数体param中的具体请求参数，根据不同的业务而不同，详见各业务接口。 3.1.2返回参数 1.返回类型为String类型
帝国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目录下使用，为保密，请自行修改文件名；
接口设计规范
目录 1接口类型 (2) 1.1人机接口 (2) 1.2软件-硬件接口 (2) 1.3软件接口 (2) 1.4通信接口 (2) 2接口设计规范 (2) 2.1基本内容 (2) 2.2规格说明 (3) 2.2.1人机接口 (3) 2.2.2软件-硬件接口 (3) 2.2.3软件接口 (3) 2.2.4通信接口 (3) 3接口设计文档提纲 (3)
1接口类型 1.1人机接口 人机接口是指计算机系统为完成人与机器之间互相传送信息而提供的功能的接口，包括硬件及程序。 1.2软件-硬件接口 软件-硬件接口是指软件系统中软件与硬件之间的接口。例如软件与接口设备之间的接口。 1.3软件接口 软件接口是软件系统中程序之间的接口。包括软件系统与其他系统或子系统之间的接口、程序模块之间的接口、程序单元之间的接口等。 1.4通信接口 通信接口是指处理机和标准通信子系统之间的接口。包括为实现数据通信用来完成接口功能的部件、装置及有关软件。 2接口设计规范 2.1基本内容 1、接口的名称标识 2、接口在该软件系统中的地位和作用 3、接口在该软件系统中与其他程序模块和接口之间的关系 4、接口的功能定义 5、接口的规格和技术要求，包括它们各自适用的标准、协议或约定 6、各个接口的数据特性 7、各个接口的资源要求，包括硬件支持、存储资源分配等 8、接口程序的数据处理要求
9、接口的特殊设计要求 10、接口对程序编制的要求 2.2规格说明 2.2.1人机接口 准确地说明人机接口的设计条件、设计特征、编程要求等技术内容。包括人机交互环境、人机接口部件、信息传输方式及传输特性、信息格式、数据处理、存储资源分配和程序编制要求等。 2.2.2软件-硬件接口 逐个描述每一个软件-硬件间接口的设计特性。包括接口硬件说明、接口功能说明、接口信息说明、接口处理方法、接口控制方式、接口时间特性、存储资源分配和程序编制要求等。 2.2.3软件接口 逐个说明本软件系统与其他软件系统间接口的设计特征。包括接口功能说明、接口约定、数据特性、数据处理方法、接口程序运行控制、接口时间特性、存储资源分配和程序编制要求等。 2.2.4通信接口 逐个描述各个通信接口的设计特性。包括硬件描述、接口功能说明、通信协议、报文处理、存储资源分配、程序接口设计和程序编制要求等。 3接口设计文档提纲 1概述........................................................................................................................................................... 错误！未定义书签。 1.1编写目的......................................................................................................................................... 错误！未定义书签。 1.2参考资料......................................................................................................................................... 错误！未定义书签。 1.3术语和缩写词................................................................................................................................ 错误！未定义书签。2软件系统综述......................................................................................................................................... 错误！未定义书签。3接口设计.................................................................................................................................................. 错误！未定义书签。 3.1接口框图......................................................................................................................................... 错误！未定义书签。 3.2接口一览表.................................................................................................................................... 错误！未定义书签。 3.3人机接口......................................................................................................................................... 错误！未定义书签。 3.4软件-硬件接口 .............................................................................................................................. 错误！未定义书签。
接口文档规范
XXX接口说明书(版本：V1.0)
修订记录
1简介 1.1文档目的 接口文档是前端与后端交互密不可分的环节，接口的规范性会直接影响双方对接过程中的效率和质量。本着快速高效开发的目的性，避免对接过程中的错误率。 1.2接口规范 (1) 遵循RESTful API设计风格 (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:[
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
软件需求说明书编写规范
{产品名称} 软件需求规格说明书 编写人： 编写日期：年月日
目录 1.产品描述 (3) 1.1.编写目的 (3) 1.2.产品名称 (3) 1.3.名词定义（可选） (3) 2.产品需求概述 (3) 2.1.功能简介 (3) 2.2.运行环境 (3) 2.3.条件与限制（可选） (3) 3.功能需求 (3) 3.1.功能划分（可选） (3) 3.2.功能1 (4) 3.3.功能N (4) 3.4.不支持的功能 (4) 4.数据描述 (4) 5.性能需求（可选） (4) 6.运行需求（可选） (4) 6.1.用户界面 (4) 6.2.硬件接口 (4) 6.3.软件接口 (5) 6.4.通信接口 (5) 7.其它需求（可选） (5) 8.特殊需求（可选） (5) 9.不确定的问题（可选） (5) 10.编写人员及编写日期 (5) 11.附录 (5) 11.1.引用文件 (5) 11.2.参考资料 (5)
1.产品描述 1.1.编写目的 【说明编写本软件需求规格说明书的目的，指出预期的读者。】 1.2.产品名称 【本项目的名称，包括项目的全名、简称、代号、版本号。】 1.3.名词定义（可选） 【对重要的或是具有特殊意义的名词（包括词头和缩写）进行定义，以便读者可以正确地解释软件需求说明。】 2.产品需求概述 2.1.功能简介 【对产品的基本功能做一个简介，包括： 1.本产品的开发意图、应用目标及作用范围。 2．概略介绍了产品所具有的主要功能。可以用列表的方法给出，也可以用图形表示主要的需求分组以及它们之间的联系，例如数据流程图的顶层图或类图等。 3．说明本产品与其他相关产品的关系，是独立产品还是一个较大产品的组成部分。 可以用表示外部接口和数据流的系统高层次图，或者方框图说明。】 2.2.运行环境 1.硬件环境： 【详细列出本软件运行时所必须的最低硬件配置、推荐硬件配置(如主机、显示器、外部设备等)以及其它特殊设备。】 2.软件环境： 【如操作系统、网络软件、数据库系统以及其它特殊软件要求。】 2.3.条件与限制（可选） 【说明本软件在实现时所必须满足的条件和所受的限制，并给出相应的原因。 必须满足的条件包括输入数据的范围以及格式。 所受的限制包括软件环境、硬件环境等方面的内容。例如：必须使用或者避免的特定技术、工具、编程语言和数据库；企业策略、政府法规或工业标准；硬件限制，例如定时需求或存储器限制；经费限制、开发期限；项目对外部因素存在的依赖。例如其它项目开发的组件。等等】 3.功能需求 【功能需求描述系统特性，即产品所提供的主要服务。可以通过使用实例、运行模式、用户类、对象类或功能等级等不同方法来描述，还可以把它们组合起来使用。 功能需求的表述形式可以参见《需求分析和管理指南》第8.2节。】 3.1.功能划分（可选） 【此部分从用户的角度描述将软件划分成不同的部分，并给出总体功能结构。对于复杂
接口清单说明
获取当前登录用户待办、已办工作流列表。 方法： class getWorkFlowList(String userName,String type,int beginIndex,int endIndex) 参数说明： userName：用户名 Type：获取工作流类型1：待办2：已办3：传阅消息 beginIndex：查询开始行 endIndex：查询结束行 输出说明： 获取当前登录用户可以发起的流程的列表。 以当前用户发起并提交一个流程。 方法： class submitBillFlow(String userName,String billId) 参数说明： UserName:提交用户名 billId：单据ID
流程传阅接口。 方法： class circulatedFlow(String assignId,String personId,String msg) 参数说明： assignId：任务ID，可通过待办、已办列表获取 personId：传阅人ID，支持多人ID用;隔开 Msg：传阅意见 流程传阅反馈(接收到传阅消息可提出意见提交反馈结果) 方法： class sendPassCommen(String billId,String procinstId,String personName ,String msg) 参数说明： billId：单据ID，可通过传阅列表获取 procinstId：流程实例，可通过传阅信息列表获取 personName ：传阅发起人，可通过传阅列表获取 Msg：传阅反馈意见 获取传阅意见(通过流程实例)。 方法： class gegtCirculatedMsg(String procinstId) 参数说明： procinstId：流程实例ID，可通过待办、已办列表获取 输出说明：
系统参数配置说明书
系统参数配置说明书
一、浏览器使用建议 本系统建议使用IE浏览器，若使用IE8浏览器请将浏览器设置为非兼容模式。使用IE8兼容模式上传附件页面会出现如下图所示： 正常界面如下图所示，出现“”按钮可正常使用。 设置步骤如下： 1.打开IE浏览器，点击右上角的“”按钮。如下图所示：
2.将兼容性视图的勾选去掉，如下图所示： 二、下载安装Flash插件 在本系统中上传附件时出现如下界面的情况时，需要下载Flash插件并且安装。 安装成功后重启IE浏览器，上传附件页面出现“”按钮时可正常使用。 三、将“申报系统”设为信任站点（若系统可正常使用，可不进行设置） 1、打开IE浏览器，并在地址栏中输入网址，显示界面如下图所示：
2、点击浏览器的菜单条“工具—〉Internet选项”，其界面如下图所示： 3、选中“安全（标签）—〉受信任的站点—〉站点”，其界面如下图所示：
将输入框中输入“工业产品质量控制和技术评定实验室申报管理系统”的网址（如: https://www.360docs.net/doc/fc1165021.html,/lab/），并点击“添加”按钮，该网址进入下面的列表框中，最后点击“确认”按钮。 注意：在输入网址前，应该取消Checkbox的选中状态。 4、设置“受信任站点”的安全级别； 在Internet选项窗体中选择“安全（标签）—〉受信任的站点—〉自定义级别”，出现的界面如下图（右）所示： 请按照下面的要求，对“ActiveX控件和插件”进行安全设置： ActiveX控件自动提示：启用
●对标记为可安全执行脚本的ActiveX控件执行脚本：启用 ●对没有标记为可安全的ActiveX控件进行初始化和脚本运行：启用 ●二进制和脚本行为：启用 ●下载未签名的ActiveX控件：提示 ●下载未签名的ActiveX控件：启用 ●运行ActiveX控件和插件：启用 后面的内容保持现状，不进行调整。 提示：针对“ActiveX控件和插件”，仅对“下载未签名的ActiveX控件”为“提示”，其余全部为“启用”状态。 点击“确认”按钮，会弹出确认对话框，选中“是”，并在“Internet选项”窗体中点击“确认”按钮，则设置立即生效。 至此，信任站点的设置全部完成。 四、设置Word格式附件的打开方式（若系统可正常使用，可不进行设置） 1、打开“资源管理器”或“我的电脑”并在菜单中选择“工具—〉文件夹选项”， 如下图所示：
完整的接口解决方案说明书
文档编号：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字典类型
接口设计规范V1.0 - 参考
服务端与手机平台 接口协议 BespRout 2014年11月
文档修改/审批记录
目录 1.概述 (4) 2.涉及接口 (4) 3.接口总体要求 (4) 3.1.系统间接口的原则 (4) 3.2.处理流程 (4) 3.3.接口实现方式 (5) 4.XXX服务端接口 (5) 4.1.XX模块-根据XX下载相关的配置文件 (5) 4.2.XX模块-生成指定XX的文件配置 (6) 4.3.APP启动-初使化参数 (7) 5.附件 (8) 5.1.备注说明 (8)
1. 概述 本文档提供接口给手机端使用，为手机端提供业务平台数据 2. 涉及接口 本文档涉及的外围系统接口包括：无 3. 接口总体要求 3.1.系统间接口的原则 接口设计遵循如下原则： ?安全可靠性原则：系统应提供良好的安全性和可靠性策略，支持多种安全而 可靠的技术手段，制定严格的安全可靠的管理措施； ?开放性原则：提供开放式标准接口，提供与其它系统的互联互通； ?灵活性原则：提供灵活的接口设计，便于接口的变动。 ?可扩展性原则：支持新业务的扩展以及接口容量与接口性能的提高； ?可管理性原则：提供良好的管理机制，保证在运行过程中提供给管理员方便 的管理方式以处理各种情况； ?统一性原则：应当保证系统的接口方式、接口形式、使用的协议等标准、统 一。 3.2.处理流程 接口处理流程
3.3. 接口实现方式 手机APP 应用 与服务端采用基于HTTP 的REST 协议完成，数据传输默认为JSON 4. XXX 服务端接口 测试地址前缀: http://192.168.3.208:8088/xxx/xxx 4.1. XX 模块-根据XX 下载相关的配置文件
API接口设计说明书
XXAPI 接口设计说明书 公司 2016年11月25日 文档管理信息表 主题XX api接口设计说明书 版本V0.1 内容 关键字 参考文档 创建时间 创建人 最新发布日期 文档变更记录表 修改人修改时间修改内容 创建
目录 文档变更记录表 .................................................................................................................................................................................. 目录 .................................................................................................................................................................................................... 引言 ...................................................................................................................................................................................................... 编写目的 背景 定义 参考资料 综述 ...................................................................................................................................................................................................... 统一的输入输出参数 必须登录才能访问的接口 错误返回码列表 用户接口 .............................................................................................................................................................................................. 用户注册（user/signup） 用户登录（user/signin） 优惠券接口 .......................................................................................................................................................................................... 我的优惠券（coupon/mycoupon）
理正标准数据接口说明及格式
理正标准数据接口 一、 功能 通过该接口将理正标准接口数据读入到的数据库中 地层统计表、勘探点一览表、土工试验综合成 果表、 数表等成果、生成与静探有关的成果图等。 二、 接口格式 1、接口文件中包含的数据 接口中可输入的数据表包括钻孔表数据、土层表数据、静探表、取样表数据、湿陷 性黄土数据、 固结和固结试验项目数据、 颗分和颗分试验项目数据、 直剪和直剪试验 项目数据、 三轴和三轴试 验项目数据。各数据表及数据表中的先后内容如下表： （包括室内试验数据和静探数据） ，从而生成 物理力学指标统计表、物理力学指标设计参
2、 接 口 文 件 具 体 格 式 ； 钻孔 数 据 #ZK#钻孔编号勘探点类型 X 坐标丫坐标偏移量孔口标高水面标高勘探深度探井深度钻 孔直径 勘探开始日期 勘 探 结 束日期 ;土层数据 #TC#岩 土名称层底深度地层厚度主层编号亚层编号地质时代地质成因颜色密实度湿 度可塑性浑圆度均匀性 风化程度岩层倾向岩层倾角矿物成分结构构造包含物气味 描述完整程度坚硬程度破碎程度节理发育节理间距 #TC#岩 土名称层底深度地层厚度主层编号 ；静探数据 #JT#试验点底深度静探类型锥头阻力侧壁摩阻力比贯入阻力 #JT#试验点底深度静探类型锥头阻力侧壁摩阻力 比贯入阻力 ；取样数据 #QY#取样编号 度最大密度 自然抗压强度 剪切强度无侧限抗压强度（原状） 无侧限抗压强度（重塑） 灵敏度透水率剪切波速纵波 波速动弹性模量动剪切模量动泊松比回弹模量 ;湿陷性黄土数据 #SX#湿陷浸水压力 湿陷系数5 S 压力湿陷系数5 .2s 压力湿陷系数5 .3s 自重湿陷系数 湿陷 起始压力 #sx#显陷浸水压力 取样深度取样长度取样类型质量密度土粒比重含水量液限塑限最小密 水上休止角水下休止角渗透系数水平渗透系数垂直渗透系数单轴抗压强度 饱和抗压强度抗拉强度抗剪强度软化系 数桩侧摩阻力桩端摩阻力十字板
接口文档规范
XXX接口说明书 (版本： 文档编号保密等级 作者最后修改日期 审核人最后审批日期 批准人最后批准日期
修订记录 日期版本修订说明修订人
1简介 1.1文档目的 接口文档是前端与后端交互密不可分的环节，接口的规范性会直接影响双方对接过程中的效率和质量。本着快速高效开发的目的性，避免对接过程中的错误率。 1.2接口规范 (1) 遵循RESTful API设计风格 (2) 数据格式采用json格式 (3) 返回统一结构数据 例如： 结构：data（数据）、errorCode（状态码）、msg（提示信息） { data:{}, .] 订单列表 orderList orderId string 否订单id orderName string 否订单名称
isStudent boolean 是false false 是否学生（是：true，否： false） 返回参数： 参数名类型示例值默认值描述 data array […]返回的数据 data id string 用户id gender number 1 1 用户性别（男：1，女：2）invoiceTitle string 抬头 address string 地址 billList array [...] 订单列表数据 billList id string 订单id billName string 订单名称 billStauts number 1 1 订单状态（待开票：1，回款： 2，核销：3） address string 客户地址 userInfo object {} 用户信息 userInfo name name 用户姓名 age number 用户年龄 gender string 1 1 用户性别（男：1，女：2）errorCode number 状态信息 msg string 信息提示 返回示例值: { data:[ { id:'1', gender:2, invoiceTitle:'帝国快运', address:'陕西省西安市雁塔区科技路24号', billList:[ { id:'001', billName:'测试数据', billStauts:1, address:'雁塔区' }, { id:'002', billName:'测试数据02',
接口设计模板
<系统名称>接口设计说明书 ****科技有限公司
修改历史
目录 1概述 (1) 2子系统说明1 (1) 2.1接口名NO.1 (1) 2.2接口名NO.2 (1)
1概述 [概述说明本文档的描述的内容、目的、使用场合等。] 2子系统说明1 2.1接口名NO.1 示例如下： 接口功能： 验证用户是否合法。 除部分特别说明不需要用户验证的接口外，此接口必须首先调用，否则会出现“未授权”的异常错误。在验证成功之后才能成功调用其它接口，该接口验证通过的用户信息将保存到IHDUserSession类的实例中，作为其它接口调用的用户信息。 此接口在内部需要通过以下几点的验证： 1.CA验证，验证USBKey是否合法（只有系统策略中设置了需要CA验证选项后才 会进行CA的验证）； 2.域用户验证，验证登录用户名和密码是否是域用户，通过Windows集成身份验证 实现； 3.用户数据库合法性验证，验证登录用户是否存在于USERS表中； 4.计算机合法性验证，验证登录计算机是否存在于COMPUTER表中，计算机的验证 通过计算机名，硬盘序列号，网卡物理地址，IP地址这四项的组合进行验证，具 体组合可以系统策略中配置； 5.如果验证未通过，返回false，并在客户端日志中记录登录失败的原因 接口声明： *** 相关数据表： **** 输入参数： **** 输出参数： *** 返回值及异常： 参见错误！未找到引用源。错误！未找到引用源。 返回值不变。 捕获到异常，请对异常进行分析。如果异常类型是***。 2.2接口名NO.2
接口功能： 接口声明： 相关数据表：输入参数： 输出参数： 返回值及异常：
曝光常用系统参数说明
第一部分WAFER EXPOSURE PARAMETERS 如何打开系统参数： ●6型，7型，8型机用命令“Gped sys_ param_file” ●其他曝光机在主界面上选择“SETUP”，再选择“SET SYSTEM PARAMETERS”。 1Judgement for focus shot :on/off 简单说明： 一般情况下，在NIKON曝光程序对应的SHOT MAP 中有两种符号“+”和“* ”。其中 “* ”代表对应的BLOCK的中心在距离圆片边缘3mm以内。曝光时，此BLOCK可以执行AUTO FOCUS 。“+”代表对应的BLOCK的中心在距离圆片边缘3mm以外。曝光时，此BLOCK不可以执行AUTO FOCUS。 “*”对应的SHOT 称为：focus shot。 “+”对应的SHOT 称为：fixed focus shot。 ON:Performs focus shot/fixed focus shot judgment during exposure and determines the shot on the basis of the result. OFF: Sets all the shots for which”+” has been specified on the shot map data of exposure data as fixed focus shots .However,focus shots are judged again. 此参数功能举例说明： 下图产品SS169的曝光图。在曝光时，最右边一列的红色的“*”是经常发生边缘聚焦的位置。（因为此位置距离边缘太近了，在执行AUTO FOCUS 时，容易得到错误的信息）针对这种情况，我们可以把“*”改成“+”。并且把系统参数设置为Judgement for focus shot :off. （8型机默认“*”和“+” 之间的区别，不用修改系统参数） * * * * * * * * * * * + + * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * + * * * * * * * * * * * * * * 上述功能NIKON资料："change a focus shot (*)to a fixed focus shot (+) on the shot map and to skip auto focus operation,set the "judgement of focus shot"system parameter to "off".If it isset to "on" the focus shot change on the shot map is ignored. 2 Shift focus position: intrashot/shot shift 简单说明 当一个BLOCK不能执行AUTO FOCUS 功能时，他就会执行SHIFT FOCUS 。此功能就是用来确定在什么位置执行Shift focus intrashot: Exeuted at a point in the shot where focusing is possible .A new focusing position is set within the area ih the shot where focusing is possible,and then focusing is done there.(After focusing ,the stage retures to the exposure position and exposure the shot is exposed)
接口说明
phpcms v9文章模型栏目接口第三版使用手册 一、简介 1、本接口应用于phpcms v9.2.4 - v9.3.3版文章模型栏目文章发布； 2、本接口支持非默认站点发布； 3、本接口支持自动获取关键词、自动提取缩略图、自动摘要、自动分页、自定义字段等功能，详见发布接口部分说明； 4、支持网站后台栏目生成HTML设置； 5、发布时请使用具有管理权限的用户帐号； 6、本接口基于phpcms v9 UTF8版制作，适用于phpcms v9 GBK/utf-8等版本，应用于其他版本时请自行测试调整； 7、在phpcms v9 utf8版使用本接口时，请在发布规则中选择编码为UTF-8； 8、接口文件无须任何改动即可使用，如果你希望增加校验或其他功能，请仔细修改； 9、2个接口文件请复制在phpcms v9网站根目录下使用； 二、安装接口 在接口文件夹中找到接口文件，如图： 请将etchk_cms.php、etpost_cms.php等接口文件上传到指定目录，请使用二进制方式上传，如图： 三、配置发布规则 1、将范例发布规则文本导入ET2发布配置，或使用软件内置发布规则范例，如图：
2、将检查网址和发布网址中的“您的网站”改为您要发布的网站网址，如图： 3、在检查网址填上您的栏目ID，如图： 4、在检查网址填上您的站点ID，站点ID如留空则默认为1，如图： 5、在参数取值页，填上您要发布的栏目ID和站点ID，如图： 6、在网站后台内容管理-栏目管理处，可以看到各栏目的catid号，如图：
7、在网站后台-设置-站点管理中，可以查看站点ID，如图： 8、填上您的账号、密码，注意格式和账号权限，如图：
接口说明_POE说明书
POE模块说明 一、POE简介 POE被称为基于局域网的供电系统(POL, Power over LAN )或有源以太网( Active Ethernet)，有时也被简称为以太网供电，这是利用现存标准以太网传输电缆的同时传送数据和电功率的最新标准规范，并保持了与现存以太网系统和用户的兼容性。 POE有两个通用标准： 1.IEEE 80 2.3at：最新POE供电标准，为大功率终端的需求而诞生，最大可以提供30W的输出功率。 2.IEEE 802.3af ：首个POE供电标准，规定了以太网供电标准，是现在POE应用的主流实现标准，最大可以输出13W的功率。 POE标准为使用以太网传输电缆输送直流电到POE兼容的设备定义了两种方法： 1.中间跨接法(Mid -Span)：使用以太网电缆中没有被使用的空闲线对来传输直流电，需要8芯网线来供电，4芯数据线，4芯供电线。 2.末端跨接法(End-Span)：在传输数据所用的芯线上同时传输直流电,其输电采用与以太网数据信号不同的频率。总共只需要4芯线，既传数据，也可以供电。 我司开发的POE模块支持IEEE 802.3at标准也兼容IEEE 802.3af标准，采用标准的38*38大小，同时支持mid-span及end-span两种方法，可以与我们现有的电源板直接对接，有着极好的兼容性，使用方便。
二、接口说明 1.1 POE 模块正面接口 图1 POE 正面图 表1 POE 正面详细接口列表 图中代号 接口详细编号 接口定义 接口定义 实现功能 P1 1 NC 空脚 2 NC 空脚 3 GND 地 4 +12Vin +12V 电源输入 输入 P2 1 +48 48V 正极 输入 2 +48_GND 48V 负极 输入 3 GND 地 4 +12Vin +12V 电源输出 输出
项目接口需求及设计说明文档
媒讯集团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来生成客户端代理。