门锁接口说明文档

门锁接口说明文档
门锁接口说明文档

1.普兰德接口(调试同日翔,志翔,品能接口)

a)第一步是复制dll文件,解压缩门锁接口开发包,把dll文件文件夹里得.dll文件复

制到酒店软件的安装目录里面,即Program Files\天星酒店管理系统\ 里。

b)这个接口需要首先在门锁软件里面发一张房卡(要保证可以开门),然后在酒店软

件的系统维护-》参数设置-》门锁接口里面发卡机类型选择“深圳普兰德”,发卡

机串口号无需设置。在“普兰德门锁接口设置”

窗口,点击从房卡”读出酒店代码”按钮,系统会

自动读出酒店代码。然后打开门锁接口开发包找

到里

的Project1.exe文件并且运行,然后

点击

“读取客人卡锁号”按钮,读出门锁号码类似“01020299”,然后在房号对应表里

填入不要输入末尾的99,设

置好所有的房号对照表就可以发卡了。

注意:首先设置好酒店软件里的房间号,然后删除铺了你的门锁设置里的所有的房

间号码,退出这个窗口,然后在重新打开这个窗口,房间号码自动更新。

2.美登可普

a)第一步是复制dll文件,加压缩门锁接口开发包,把dll文件文件夹里得.dll文件复

制到酒店软件的安装目录里面,即Program Files\新锐酒店管理系统\ 里。

b)然后到酒店软件的系统维护,参数设置,门锁接口里面,设置好串口号,选择深圳

普兰德。

c)把每个房间号码在门锁软件里发一遍,没发一张卡,就到美登可普的设置窗口里面,

点击从房卡读出编号,输入对应的酒店软件里面的

房间号码,然后点添加按钮。所有房间号都要依次添加到酒店软件里面,添加完后

就可以发卡了。

3.连发门锁接口

a) 将接口程序解压缩,然后将里面的prdk.exe、prfk.exe、przx.exe、prkrk.txt、dkzh.txt

文件拷贝到酒店管理系统文件目录下。

b) 将联发门锁管理系统安装到装有酒店管理系统的计算机上默认目录(即:c:\lflock )

下。

c) 运行时,先将门锁软件配置完毕,并发行完系统用卡,设置门锁。

d) 酒店软件里的门锁房号一定要是6位长度由楼栋号+楼层号+编号组成

e) 然后在酒店软件的系统维护-》参数设置-》门锁接口里面发卡机类型选择“连发门锁”,

发卡机串口号无需设置。在“连发门锁接口设置”窗口,设置酒店系统房号和门锁房号的对照表。设置完毕即可发卡。

4.嘉华远为3.01

a)首先复制接口动态库到酒店软件的安装目录,源文件:

b)进入酒店软件,点击系统维护,参数设置,门锁接口,选择嘉华远为,进入设置窗

口。

c)

在房号生成器文件夹运行sfcroom.exe文件,在弹出的窗口里面点击生成,会在刚才的文件里面生成roomcd.txt文件。

d)在设置窗口,输入接口函数注册号,点“引入房号对照表”按钮,选择上一步生成

的房号对照表文件。

e)

f)在设置好发卡机的通讯口就可以正常发卡了。

5.力维门锁

a)第一步是复制dll文件,解压缩门锁接口开发包,把dll文件文件夹里得.dll文件复

制到酒店软件的安装目录里面,即Program Files\新锐酒店管理系统\ 里。

b)进入系统维护-》参数设置-》门锁接口,选择力维门锁,然后选择卡类型和接口的

版本。把授权卡放到发卡机上,点读授权卡参数。

c)设置酒店软件房号和门锁编号对照表。

6.力维门锁3.0

a) 复制五个*.dll文件:LevelLock.dll、lv3.dll、EMUSB.dll、RCUSB.dll、RFUSB.dll (都包含在“LEVEL3_CN_Build”文件夹中)到酒店软件的安装目录里面,即Program Files\新锐酒店管理系统\ 里。

b)进入系统维护-》参数设置-》门锁接口,选择力维门锁3.0,然后选择卡类型

和接口的。输入注册码并且选择个扇区编号。

c) 设置对照表

7.爱迪尔门锁

a)第一步是复制dll文件,解压缩门锁接口开发包,把dll文件文件夹里得.dll文件复

制到酒店软件的安装目录里面,即Program Files\新锐酒店管理系统\ 里。

b)进入系统维护-》参数设置-》门锁接口,选择爱迪尔门锁,输入门锁软件的数据库

服务器名称,选择门锁软件版本号和发行机类型。输入注册码并且选择个扇区编号。

c)输入酒店房号和门锁软件门锁编号的对照表

8.第吉尔门锁

a)第一步运行

b)进入系统维护-》参数设置-》门锁接口,选择第吉尔门锁,选择门锁软件的数据库

路径,选择接口版本。

,如果是2009版本,需要输入接注册号,并且点击注册。

接口注册号有门锁商提供.

c)设置房号和门锁软件编号对照表

9.同创新佳门锁

a)第一步复制icdll.dll文件到酒店软件的安装目录里面,即Program Files\新锐酒店管

理系统\ 里

b)进入系统维护-》参数设置-》门锁接口,选择同创新佳门锁,设置门锁软件数据库类

型,版本号,和门锁软件路径

c)设置对照表

10.微兰特门锁

a)第一步复制mbt2005.dll文件到酒店软件的安装目录里面,即Program Files\新锐酒

店管理系统\ 里

b)进入系统维护-》参数设置-》门锁接口,选择维兰特门锁,设置门锁软件数据库服务

器名称,门锁软件登陆用户名和密码。

c)设置对照表,门锁软件房号必须和锁管软件中的编号一致

11.樱花门锁

a)第一步是复制dll文件,解压缩门锁接口开发包,把dll文件文件夹里得.dll文件复

制到酒店软件的安装目录里面,即Program Files\新锐酒店管理系统\ 里。

b)进入系统维护-》参数设置-》门锁接口,选择樱花门锁,然后选择卡类型。把授权

卡放到发卡机上,点读客户卡参数。

c)设置酒店软件房号和门锁编号对照表。

12.卡诺门锁

a)第一步是复制dll文件,解压缩门锁接口开发包,把dll文件文件夹里得.dll文件复

制到酒店软件的安装目录里面,即Program Files\新锐酒店管理系统\ 里。

b)进入系统维护-》参数设置-》门锁接口,选择卡诺门锁,设置代理商识别号.代理

商识别号是用于保护用户的卡片数据不被未授权修改,该参数可由管理

软件的“帮助”菜单中的“关于门锁管理系统”对话框取得.

c)客房编号是由智能锁管理系统(以下简称“管理软件”)在配置楼栋、楼

层和客房信息的时候统一生成的

13.

资深酒店软件与第吉尔门锁接口调试方法

第吉尔门锁接口调试方法(PB版本) 一、安装第吉尔门锁的发卡程序(安装目录:d:\DigilockTM),必须保证制卡系统能正常发 卡、查询卡、回收卡,确保可以正常打开房门。如图: 二、安装第吉尔门锁接口,接口程序要安装在发卡系统内(安装目录为d:\DigilockTM\), 切记此接口程序安装完成后,禁止删除。否则门锁接口及门锁发卡软件无法使用。 , 三、设定门锁系统参数,对门锁接口程序配置 1、安装完成后,打开接口程序安装目录DEMO_VB程序 图一 2、选择DEMO_VB,然后输入数据库路径,读特别卡,输入16位接口注册码(注册码由门锁厂方提供),(注意串口号),接口注册成功后,退出。 Database =X:\DigiLockTm\Data\DigiLock.MDB (X代表盘符) 16位注册码:2E3482FB35D7480B

3、在门锁接口程序中,把DEMO目录下的PB9文件夹下面的全部文件全部复制粘贴到d:\DigilockTM\目录下,打开DEMO_pb9.EXE进行接口发卡,读卡测试:如图 发卡成功(注意串口) 读卡成功 4、用前面所发的房卡去开8501门,如果门正常打开,则可以进行与酒店管理系统相连接了,如打不开,则需要查看接口返回值对应的信息 四、进入安装门锁的客户端酒店管理系统,系统管理模块,IC卡设置中选择“通用门锁”, 注意IC卡密码为空及IC卡酒店号码000000 五、覆盖资深开发程序到酒店管理系统的安装目录下:

六、进入酒店管理系统安装目录,打开zisunic.ini修改port=值,设定完成后,保存,如果 发卡机的端口为COM1口,则PORT=1,如果为发卡机端口为COM2口,如图 七、在酒店管理系统—接待系统—维护---客房----房间配置中输入门锁系统房号(8位)。例如:8201房间相对应的门锁系统房号为01028201 前2位楼栋号,3,4位楼层号,后4 位房号 八、进入客房管理系统,随便选择一个房间办理入住,后右键“制卡”,系统提示“发 卡成功”去开门,如果能正常打开房门,表示开发开门程序成功! 九、卡可以正常开门后,则需要在房态盘上进行“请宾客卡”和“清除宾客卡”功能进 行测试。如图 十、函数错误返回值对照表: -1 接口注册失败 -99 端口错误 -128 读卡错误 -129 写卡错误 -201 发卡系统未用特别卡激活 -202 16位注册号输入错误,请再次核对。 -203 16位注册号错误,请将特别卡编号和接口所在目录下Setting.ini 文件发给供应商核实。 -300 卡片不符合门锁标准 -310 卡片不符合门锁标准 -410 需要到发卡系统进行查询 -420 需要到发卡系统进行查询 -430 需要到发卡系统进行查询 -500 复位卡(不能用作发卡) -600 特别IC卡(不能用作发卡) -700 空白卡,不是宾客卡 -800 找不到 Setting.INI -810 不能打开 Setting.INI -820 数据库路径错误 -830 数据库路径错误 -840 打开数据库错误 -850 更新数据库错误

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 方法定义 ........................ 错误! 未定义书签。 请求参数. .................................................... 错误! 未定义书签。 返回数据. .................................................... 错误!未定义书签。

王力指纹锁中文说明书

1.1指纹锁作为高科技产品,安装的好坏直接影响到门锁的正常操作及使用寿命,建议您聘请对锁具有相当经验的师傅进行安装,并根据产品附件中门板开孔图样板进行操作,客户定做的配置指纹密码锁拉手的门已经按指纹密码锁拉手的标配开孔了,就可以直接安装;如果没有开孔的要现场开孔。特别说明:门上开了指纹密码锁拉手孔后再装上其他拉手,会出现拉手盖不住拉手孔的现象,请经销商开孔时要慎重。在使用过程中发现锁有任何异常,请及时和当地的经销商或本公司的售后服务部门联系,以便快速解决问题。 1.2如果您的房间正在装修,我们建议您将产品卸下,装上普通配置的拉手代用,待装修完成后再把产品重新装上,这样做的目的是:1.避免装修过程中腐蚀性物质或装修中使用的酒精、油漆等化学物质未干透时会向空气中散发腐蚀性气体腐蚀锁体,加速产品表面处理老化,影响外观及降低产品使用寿命; 2.避免门的油漆未干或施工的材料影响锁的灵活转动。 1.3在门锁安装调试完成后,请您在第一时间内清空门锁内所有密码及指纹,再注册自己的管理密码、用户密码及指纹,防止别人盗用您的密码,留下安全隐患。1.4门锁使用一段时间后,电池电量偏低时,每次开门蜂鸣器会发出“嘀~嘀~”低压报警提示,此时请及时更换电池并注意正负极的安装,以确保锁的正常使用。1.5若您要出远门或长期不使用锁,请带上机械钥匙,并取出电池,以确保锁的使用寿命。1.6指纹较平较细或年龄较小的用户,建议您用大拇指注册指纹,且同一用户注册2枚以上指纹,提高指纹采集时的成功率。 1.7锁的指纹容量为100枚用户指纹,含1枚管理指纹(编号为00)和99枚用户指纹(编号为01~99);密码容量为10组(8位数),含1组管理密码(2位密码编号00+6位任意数字)和9组用户密码(2位密码编号01~09+6位任意数字)。新增用户时,请将用户详细信息记录于《注册信息登记表》,方便以后管理。 1.8本锁出厂设置:初始管理密码为00123456,用户密码库、指纹库为空。 1.9提示音/指示灯说明:每次操作成功时,蜂鸣器“嘀~”长鸣,绿色指示灯闪烁一次;,红色指示灯闪烁一次后退出。”--数码显示屏短鸣,嘀嘀操作失败时,蜂鸣器“”“10 / 1 10 / 2 3.1基本功能 1.1.1 开门功能 钥匙开门密码开门指纹开门1.1.2 常开功能 启动常开功能:登入<管理指纹>数码显示屏显示“FP”字样,在锁闭前(5秒之内)按任意数字键,进入常开状态(绿色指示灯每三秒钟闪一次)。 开门,便可取消常开状态。管理指纹> 取消常开功能:再次登入< 1.1.3 反锁功能 WL-Z01款指纹锁:门关上后主锁舌自动弹出上锁。在门内旋转反锁旋纽,实现门内锁死功能,此时在门外无论采用哪种方式都不能开门;在门外用钥匙逆时针旋转。1.1.4 警示功能 (1)低压报警 当电池欠压,在每次对锁或指纹操作时蜂鸣器会发出3声报警,此时系统还能继续工作,但应及时更换电池。(2)防拆报警 当强行拆除或打开锁体外壳时,系统会发出连续的急促音,输入正确密码或指纹可解除报警。(3)*按键锁定功能* 连续3次输入错误密码,键盘将自动锁闭15分钟,按任意数字键,都有报警音。10 / 3 。输入正确的指纹可以解除自锁(若门已打开可用拆缷电池的方法快速解除)1.2 操作与管理 1.2.1 开门方法 本锁支持三种单独开门方式:密码开门、指纹开门、机械钥匙开门。 ①密码开门:输入开门密码,验证通过后绿色指示灯亮,数码显示屏显示“00”,蜂鸣器长鸣一声后,转

帝国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:企业服务代码

电子门锁接口说明

调用函数库: 提供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 →公共门标志,1能开公共门,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

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)

概要设计说明书范例及模板

《XXXXXX》概要设计说明书 张三、李四、王五

1.引言 1.1编写目的 在本机票预定系统项目的前一阶段,也就是需求分析阶段中,已经将系统用户对本系统的需求做了详细的阐述,这些用户需求已经在上一阶段中对航空公司、各旅行社及机场的实地调研中获得,并在需求规格说明书中得到详尽得叙述及阐明。 本阶段已在系统的需求分析的基础上,对机票预定系统做概要设计。主要解决了实现该系统需求的程序模块设计问题。包括如何把该系统划分成若干个模块、决定各个模块之间的接口、模块之间传递的信息,以及数据结构、模块结构的设计等。在以下的概要设计报告中将对在本阶段中对系统所做的所有概要设计进行详细的说明。 在下一阶段的详细设计中,程序设计员可参考此概要设计报告,在概要设计对机票预定系统所做的模块结构设计的基础上,对系统进行详细设计。在以后的软件测试以及软件维护阶段也可参考此说明书,以便于了解在概要设计过程中所完成的各模块设计结构,或在修改时找出在本阶段设计的不足或错误。 1.2项目背景 机票预定系统将由两部分组成:置于个旅行社定票点的前台客户程序,以及置于航空公司的数据库服务器。本系统与其他系统的关系如下: 1.3定义 1.3.1 专门术语 SQL SERVER: 系统服务器所使用的数据库管理系统(DBMS)。 SQL: 一种用于访问查询数据库的语言 事务流:数据进入模块后可能有多种路径进行处理。 主键:数据库表中的关键域。值互不相同。 外部主键:数据库表中与其他表主键关联的域。 ROLLBACK: 数据库的错误恢复机制。 1.3.2 缩写

系统:若未特别指出,统指本机票预定系统。 SQL: Structured Query Language(结构化查询语言)。 ATM: Asynchronous Transfer Mode (异步传输模式)。 1.4参考资料 以下列出在概要设计过程中所使用到的有关资料: 1.机票预定系统项目计划任务书浙江航空公司1999/3 2.机票预定系统项目开发计划《**》软件开发小组1999/3 3.需求规格说明书《**》软件开发小组1999/3 4.用户操作手册(初稿)《**》软件开发小组1999/4 5.软件工程及其应用周苏、王文等天津科学技术出版社1992/1 6.软件工程张海藩清华大学出版社1990/11 7.Computer Network A.S.Tanenbaun Prentice Hall 1996/01 文档所采用的标准是参照《软件工程导论》沈美明著的“计算机软件开发文档编写指南”。 2.任务概述 2.1 目标 2.2 运行环境 系统将由两部分程序组成,安装在各旅行社客户机上的客户程序及航空公司内的数据服务器程序。 根据调研得知所有旅行社的计算机配置均在Pentium 133级别以上,客户程序应能够在Pentium 133级别以上, Win NT环境下运行。 2.3 需求概述 浙江航空公司为方便旅客,需开发一个机票预定系统。为便于旅客由旅行社代替航空公司负责为旅客定票,旅行社把预定机票的旅客信息,包括姓名、性别、工作单位、身份证号码、旅行时间、旅行目的地,输入机票预定系统的客户端程序,系统经过查询航空公司内的航班数据服务器后,为旅客安排航班,印出取票通知。旅客在飞机起飞前一天凭取票通知和帐单交款后取票,系统校对无误后即印出机票给旅客。 要求系统能有效、快速、安全、可靠和无误的完成上述操作。并要求客户机的界面要简单明了,易于操作,服务器程序利于维护。 2.4 条件与限制 3.总体设计 3.1 处理流程 下面将使用(结构化设计)面向数据流的方法对机票预定系统的处理流程进行分

三星智能电子门锁使用说明

电子智能化装备 A、电子门锁使用说明 (1)、特点: 本工程各户的入户门锁,采用的是三星电子门锁,具有以下功能:卡开启功能、 密码开启功能、自动上锁功能、睡眠锁闭功能、声音提示功能、火灾报警功能。(2)、组成: 室外部分室内部分感应卡钥匙锁芯锁销挡片 说明书应急钥匙AA电池 (3)、锁体图示: 自动滑盖 密码按键应急电源接口 卡感应区

应急机械钥匙孔 开启执手 内封闭盖 卡储存按钮自动/手动选择按钮 遥控器注册键密码注册键 OPEN按钮应急按钮 锁芯指示按钮 手柄 (4)、初始化方法(管理密码、密码、卡、钥匙) 删除所有(管理密码密码卡钥匙)注册信息 方法1:同时按卡注册按钮和遥控器注册按钮5秒→滑盖自动上移后输入初始管理密码→按“*”结束 方法2:同时按卡注册按钮和遥控器注册按钮5秒→滑盖自动上移后输入“4560852580”→按“*”结束 (5)、管理密码注册方法 同时按住open键和密码注册键→滑盖自动上移后输入要注册新管理密码→“*” →再输一次→“*”结束

注意事项:■在输入过程中,工作指示灯因输入错误而闪烁并发出“滴沥滴沥“的报警音时应从头开始重新输入。 ■出厂的管理密码设为“1234”,管理密码只能更改,不能删除(6)、更改管理密码 同时按住open键和密码注册键→滑盖自动上移后输入原来的管理密码后再按“*” →输入要注册的管理密码后按“*”→再输入一次要注册的管理密码→按“*”结 束 (7)、密码注册方法 按一下密码注册键→滑盖自动上移后输入管理密码再按“*”→输入要注册的密码 后按“*”→再输一次要注册的密码→按“*”结束。 注意事项:■在输入过程中,工作指示灯因输入错误而闪烁并发出“滴沥滴沥“的报警音时应从头开始重新输入。 ■请定期更改密码,密码最好超过6位数。 (8)、删除个别密码 按住密码注册键5秒→滑盖自动上移后输入管理密码再按“*”→输入要删除的密码后按“*”→再输入一次要删除的密码→按“*”结束。 (9)、删除所有已注册的密码 按住密码注册键5秒→滑盖自动上移后输入管理密码再按“*”→再输入一次管理 密码→按“*”结束。 (10)、出入卡注册 按一下注册键→输入管理密码后按“*”→将要注册的出入卡抵在卡的接触部位 若要连续注册多张卡,请在5秒内连续将出入卡抵在卡的接触部位。 (11)、删除所有已注册的出入卡 按住卡注册键5秒→输入管理密码→按“*”结束 ■本操作执行后将删除所有卡的注册信息,不能进行个别出入卡的删除。 特别说明:其它技术细节请见《三星电子锁使用说明书》

接口文档规范

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:[

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

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

门锁接口调试说明

1.接口说明 实现了一卡通 实现了注销卡 2.需要的配置 程序配置文件保存在C:\cshis\csmis.ini中,其格式为: [消费卡参数] 酒店标识= 房号转换= 测试= 有驱发卡器= 使用一卡通= 其中 酒店代码:应该可以在门锁给的demo程序中就能读出来 测试:配Y则显示制卡前信息,配N则屏蔽该断点 使用一卡通:配Y则实现一卡通,配N则不实现 有驱发卡器= 选择有驱发卡器时配大写Y,选择USB时配N 房号转换:注意房号转换是中软房号与门锁demo中锁号的转换,转换后的锁号是8位的,中软房号与门锁房号之间没有转换规则,那么房号转换=*,并建表转换 房号转换表: 表名:lockno 字段:rm_num char 录入中软房号 字段:lock_num char 录入门锁锁号(8位) 3.需要的数据结构 (1)表名:card_info 字段:rm_num char[6] new_no int 只建表,不用录数 (2)表名:cardno1 字段:new_no int 字段:arr_dt char(12) 只建表,不用录数 4.调试注意事项 制卡成功:不能开门的原因: 6声: 楼号,层号或房间号不对,请核对以上信息; 7声: 时间无效,请确定时间是否在有效范围; 8声: 说明其他信息都正确,可从我公司的门锁软件中发一张<授权卡>设置门锁,后可开门; 15声: 酒店标识不对,请按第1点说明找到正确的酒店标

其他注意事项: 1,从接口Demo中发出的卡无法在我们的门锁软件上正确查询; 2,从酒店管理软件中发出的卡无法在我公司的门锁软件上正确查询; 3,做完接口之后只能用其中的一个系统发卡,如果两套系统交互发卡,则有可能发生开不了门的现象. 5.

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

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

项目接口文档

接口使用说明书 2016年9月

版本控制文档信息 文档变更记录

目录 1.接口概述 (4) 1.1. 概述 (4) 1.2. 基本规则 (4) 1.2.1. 域名 (4) 1.2.2. 通用接口调用参数说明 (4) 2.接口定义 (6) 2.1. 登录注册 (6) 2.1.1. 登录接口 (6) 2.1.1.1. 账号密码登录 (6) 2.1.1.2. 微信登录............................................................................. 错误!未定义书签。 2.1.2. 注册和修改接口..................................................................... 错误!未定义书签。 2.1.2.1. 完善个人信息接口............................................................. 错误!未定义书签。 2.1.2.2. 获取个人资料..................................................................... 错误!未定义书签。 2.1.2. 3. 上传/修改企业信息 ........................................................... 错误!未定义书签。 2.1.2.4. 上传/修改工作经历 ........................................................... 错误!未定义书签。 2.1.2.5. 设置/修改提现密码 ........................................................... 错误!未定义书签。 2.1. 3. 短信部分接口......................................................................... 错误!未定义书签。 2.1. 3.1. 发送短信验证码接口......................................................... 错误!未定义书签。 2.1.4. 服务部分接口......................................................................... 错误!未定义书签。 2.1.4.1. 上传/修改个人服务信息 ................................................... 错误!未定义书签。 2.1.4.2. 获取服务列表..................................................................... 错误!未定义书签。 2.1.4. 3. 获取服务详情..................................................................... 错误!未定义书签。 2.1.4.4. 评价列表(全部服务或单个服务) ...................................... 错误!未定义书签。 2.1.4.5. 预约..................................................................................... 错误!未定义书签。 2.1.4.6. 服务评价............................................................................. 错误!未定义书签。 2.1.5. 我的账户................................................................................. 错误!未定义书签。 2.1.5.1. 获取用户收入/支出记录 ................................................... 错误!未定义书签。 2.1.5.2. 分页获取收入/支出记录 ................................................... 错误!未定义书签。 2.1.5. 3. 添加收入/支出记录 ........................................................... 错误!未定义书签。 2.1.6. 红包部分接口......................................................................... 错误!未定义书签。 2.1.6.1. 领取红包............................................................................. 错误!未定义书签。 2.1.6.2. 发放红包............................................................................. 错误!未定义书签。 2.1.7. 精英汇部分接口..................................................................... 错误!未定义书签。 2.1.7.1. 获取精英列表..................................................................... 错误!未定义书签。 2.1.7.2. 精英详情............................................................................. 错误!未定义书签。 2.1.8. 任务接口................................................................................. 错误!未定义书签。 2.1.9. 其他接口................................................................................. 错误!未定义书签。 2.1.9.1. 消息..................................................................................... 错误!未定义书签。 2.1.9.2. 省市区获取......................................................................... 错误!未定义书签。 2.1.9. 3. 行业类型获取..................................................................... 错误!未定义书签。 2.1.9.4. 上传多媒体资源................................................................. 错误!未定义书签。

相关文档
最新文档