API接口设计说明书

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

06
总结与展望
总结
接口解决方案的背景
接口解决方案的核心内容
解决方案的优点
适用场景
随着互联网技术的发展，接口在各种应用中扮演着越来越重要的角色。为了满足不同业务需求，提供稳定、高效、安全的接口服务变得至关重要。
本解决方案主要涉及接口设计、开发、测试、部署和运维等方面，旨在提供一套完整的接口管理流程，确保接口的质量和可靠性。
02 03
接口的作用
接口的主要作用是实现不同系统或应用程序之间的数据共享和交互，提高系统的集成度和可扩展性，同时降低系统间的耦合度，方便系统的维护和升级。
接口的分类
根据不同的分类标准，可以将接口分为多种类型，如按传输方式可分为同步接口和异步接口，按数据传输速率可分为低速接口和高速接口，按数据传输距离可分为短距离接口和长距离接口等。
04
接口管理
接口规范制定
接口定义
明确接口的输入输出参数、请求响应格式、错误码定义等。
接口安全
考虑接口的身份验证、授权、数据加密等安全措施。
接口性能
设定接口的响应时间、吞吐量等性能指标。
接口版本控制
版本号管理
为每个接口版本分配唯一的版本号，以便追踪和管理。
版本兼容性
确保新旧版本之间的兼容性，避免因版本升级导致的问题。
可扩展性原则
为了满足业务不断发展的需求，接口设计应具有良好的可扩展性，方便后续的升级和维护。同时，应遵循开放性和封闭性相结合的原则，保证系统的稳定性和安全性。
安全性原则
为了保证数据的安全性，需要对接口进行身份验证、权限控制等安全措施，防止未经授权的访问和数据泄露。
易用性原则
为了方便开发人员快速开发和调试，接口设计应遵循简单、易用的原则，尽量减少开发人员的工作量和难度。同时，应提供完善的文档和示例代码，方便开发人员学习和使用。

阿里云内容安全API参考（检测服务）说明书

内容安全API参考（检测服务）··法律声明法律声明阿里云提醒您在阅读或使用本文档之前仔细阅读、充分理解本法律声明各条款的内容。

如果您阅读或使用本文档，您的阅读或使用行为将被视为对本声明全部内容的认可。

1. 您应当通过阿里云网站或阿里云提供的其他授权通道下载、获取本文档，且仅能用于自身的合法合规的业务活动。

本文档的内容视为阿里云的保密信息，您应当严格遵守保密义务；未经阿里云事先书面同意，您不得向任何第三方披露本手册内容或提供给任何第三方使用。

2. 未经阿里云事先书面许可，任何单位、公司或个人不得擅自摘抄、翻译、复制本文档内容的部分或全部，不得以任何方式或途径进行传播和宣传。

3. 由于产品版本升级、调整或其他原因，本文档内容有可能变更。

阿里云保留在没有任何通知或者提示下对本文档的内容进行修改的权利，并在阿里云授权通道中不时发布更新后的用户文档。

您应当实时关注用户文档的版本变更并通过阿里云授权渠道下载、获取最新版的用户文档。

4. 本文档仅作为用户使用阿里云产品及服务的参考性指引，阿里云以产品及服务的“现状”、“有缺陷”和“当前功能”的状态提供本文档。

阿里云在现有技术的基础上尽最大努力提供相应的介绍及操作指引，但阿里云在此明确声明对本文档内容的准确性、完整性、适用性、可靠性等不作任何明示或暗示的保证。

任何单位、公司或个人因为下载、使用或信赖本文档而发生任何差错或经济损失的，阿里云不承担任何法律责任。

在任何情况下，阿里云均不对任何间接性、后果性、惩戒性、偶然性、特殊性或刑罚性的损害，包括用户使用或信赖本文档而遭受的利润损失，承担责任（即使阿里云已被告知该等损失的可能性）。

5. 阿里云网站上所有内容，包括但不限于著作、产品、图片、档案、资讯、资料、网站架构、网站画面的安排、网页设计，均由阿里云和/或其关联公司依法拥有其知识产权，包括但不限于商标权、专利权、著作权、商业秘密等。

非经阿里云和/或其关联公司书面同意，任何人不得擅自使用、修改、复制、公开传播、改变、散布、发行或公开发表阿里云网站、产品程序或内容。

神思SS728M05终端API接口函数库用户手册V1.6

文档编号归档编号发布状态文档版本SS728M05设备驱动接口函数库用户手册V1.6拟制：陈龙日期：2014-12-26 审核：日期：标准化：日期：批准：日期：山东神思电子目录SS728M05设备驱动接口函数库 (1)用户手册 (1)V1.6 (1)目录 (2)1终端简介 (8)1.1主要功能 (8)1.2主要技术指标 (8)2接口库概述 (9)2.1适用范围 (9)2.2说明 (9)3接口函数 (10)3.1函数返回值 (10)3.1.1通用返回值 (10)3.1.2居民健康卡（兼容山东保健证）错误代码 (11)3.2基本接口函数 (12)3.2.1SS728M05_SDK（SS728M05基本操作接口） (12)3.2.1.1基本函数 (12)3.2.1.1.1ICC_Reader_Open (12)3.2.1.1.2ICC_Reader_Close (12)3.2.1.1.3ICC_Reader_Reset (12)3.2.1.1.4ICC_Reader_PowerOff (13)3.2.1.1.5ICC_Reader_Application (13)3.2.1.1.6ICC_Reader_GetLastError (13)3.2.1.1.7ICC_Reader_Version (14)3.2.1.1.8SS_Reader_Reset (14)3.2.1.1.9SS_Reader_Reset_bBeep (15)3.2.1.1.10SS_Reader_PowerOff (15)3.2.1.1.11SS_Reader_Application (16)3.2.1.1.12SS_Reader_GetLastError (16)3.2.1.1.13SS_Reader_Version (16)3.2.1.1.14SS_Reader_GetVersionID (17)3.2.1.1.15SS_Reader_GetUserInfo (17)3.2.1.1.16SS_Reader_UpdateUserInfo (17)3.2.1.1.17SS_Reader_AutoRecognition (17)3.2.1.1.18SS_Reader_AutoFindCard (18)3.2.1.1.19ss_dev_beep (18)3.2.1.1.20ss_dev_led (18)3.2.1.2居民二代身份证函数 (18)3.2.1.2.1ss_id_ResetID2Card (18)3.2.1.2.4ss_id_query_sex (19)3.2.1.2.5ss_id_query_sexL (19)3.2.1.2.6ss_id_query_folk (20)3.2.1.2.7ss_id_query_folkL (20)3.2.1.2.8ss_id_query_birth (20)3.2.1.2.9ss_id_query_address (20)3.2.1.2.10ss_id_query_number (20)3.2.1.2.11ss_id_query_organ (21)3.2.1.2.12ss_id_query_termbegin (21)3.2.1.2.13ss_id_query_termend (21)3.2.1.2.14ss_id_query_photo_data (21)3.2.1.2.15ss_id_query_photo_file (21)3.2.1.2.16ss_id_query_newaddress (22)3.2.1.2.17ss_id_query_IDBaseInfo_text (22)3.2.1.2.18ss_id_GetSAMno (22)3.2.1.2.19ss_id_GetSAMStatus (23)3.2.1.2.20ss_id_GetFPMsg (23)3.2.1.3M1卡操作函数 (23)3.2.1.3.1ss_CardMifare_Reset (23)3.2.1.3.2ss_CardMifare_Authentication (23)3.2.1.3.3ss_CardMifare_ReadBlock (24)3.2.1.3.4ss_CardMifare_WriteBlock (24)3.2.1.3.5ss_CardMifare_Increment (24)3.2.1.3.6ss_CardMifare_Decrement (24)3.2.1.3.7ss_CardMifare_Copy (25)3.2.1.3.8ss_CardMifare_GetUID (25)3.2.1.4标准社保卡操作作函数 (25)3.2.1.4.1ss_rf_sb_FindCard (25)3.2.1.4.2ss_rf_sb_ReadCardIssuers (25)3.2.1.4.3ss_rf_sb_ReadCardholder (26)3.2.1.4.4ss_rf_sb_ReadFingerprint (26)3.2.1.5济南社保卡操作函数 (26)3.2.1.5.1ss_jn_sb_FindCard (26)3.2.1.5.2ss_jn_sb_QuerryCardNumber (26)3.2.1.64428卡操作函数 (27)3.2.1.6.1ss_sle_reset_card (27)3.2.1.6.2ss_sle4428_read_card (27)3.2.1.7磁条卡操作作函数 (28)3.2.1.7.1SS_CT_ReadInfo (28)3.2.1.7.2SS_CT_ReadInfo_ (28)3.2.1.8居民健康卡基本函数(兼容山东保健证) (28)3.2.1.8.1ss_reader_open (28)3.2.1.8.2ss_reader_close (29)3.2.1.8.5ss_rf_yl_cpu_find_cardB (29)3.2.1.8.6ss_rf_cpu_yl_read_cardInfo (29)3.2.1.8.7ss_rf_cpu_yl_write_cardInfo (29)3.2.1.8.8ss_rf_yl_cpu_read_issuingOrg (30)3.2.1.8.9ss_rf_yl_cpu_write_issuingOrg (30)3.2.1.8.10ss_rf_yl_cpu_read_demographicInfo1 (30)3.2.1.8.11ss_rf_yl_cpu_write_demographicInfo1 (30)3.2.1.8.12ss_rf_yl_cpu_read_hospital (31)3.2.1.8.13ss_rf_yl_cpu_write_hospital (31)3.2.1.8.14ss_rf_cpu_yl_read_photo (31)3.2.1.8.15ss_rf_cpu_yl_write_photo (31)3.2.1.8.16ss_rf_yl_cpu_read_address (32)3.2.1.8.17ss_rf_yl_cpu_write_address (32)3.2.1.8.18ss_rf_yl_cpu_read_linkman (32)3.2.1.8.19ss_rf_yl_cpu_write_linkman (32)3.2.1.8.20ss_rf_yl_cpu_read_demographicInfo2 (33)3.2.1.8.21ss_rf_yl_cpu_write_demographicInfo2 (33)3.2.1.8.22ss_rf_yl_cpu_read_idcardInfo (33)3.2.1.8.23ss_rf_yl_cpu_write_idcardInfo (33)3.2.1.8.24ss_rf_yl_cpu_read_illNum (34)3.2.1.8.25ss_rf_yl_cpu_write_illNum (34)3.2.1.8.26ss_rf_yl_cpu_read_BiometricIdentifier (34)3.2.1.8.27ss_rf_yl_cpu_write_BiometricIdentifier (34)3.2.1.8.28ss_rf_yl_cpu_read_SpecialIdentifier (35)3.2.1.8.29ss_rf_yl_cpu_write_SpecialIdentifier (35)3.2.1.8.30ss_rf_yl_cpu_read_AllergicReaction (35)3.2.1.8.31ss_rf_yl_cpu_write_AllergicReaction (35)3.2.1.8.32ss_rf_yl_cpu_read_Immunization (36)3.2.1.8.33ss_rf_yl_cpu_write_Immunization (36)3.2.1.8.34ss_rf_yl_cpu_read_HospitalEffectiveSign (36)3.2.1.8.35ss_rf_yl_cpu_write_HospitalEffectiveSign (36)3.2.1.8.36ss_rf_yl_cpu_RewriteRecord_HospitalEffectiveSign (37)3.2.1.8.37ss_rf_yl_cpu_EraseRecord_HospitalEffectiveSign (37)3.2.1.8.38ss_rf_yl_cpu_read_OutpatientServiceEffectiveSign (37)3.2.1.8.39ss_rf_yl_cpu_write_OutpatientServiceEffectiveSign (37)3.2.1.8.40ss_rf_yl_cpu_RewriteRecord_OutpatientServiceEffectiveSign (38)3.2.1.8.41ss_rf_yl_cpu_EraseRecord_OutpatientServiceEffectiveSign (38)3.2.1.8.42ss_rf_cpu_yl_read_HospitalInformation1 (38)3.2.1.8.43ss_rf_cpu_yl_write_HospitalInformation1 (38)3.2.1.8.44ss_rf_cpu_yl_read_HospitalInformation2 (39)3.2.1.8.45ss_rf_cpu_yl_write_HospitalInformation2 (39)3.2.1.8.46ss_rf_cpu_yl_read_OutpatientServiceInformation1 (39)3.2.1.8.47ss_rf_cpu_yl_write_OutpatientServiceInformation1 (39)3.2.1.8.48ss_rf_cpu_yl_read_OutpatientServiceInformation2 (40)3.2.1.8.49ss_rf_cpu_yl_write_OutpatientServiceInformation2 (40)3.2.1.8.50ss_rf_cpu_yl_read_FingerprintFile (40)3.2.1.8.51ss_rf_cpu_yl_write_FingerprintFile (41)3.2.1.8.52ss_rf_cpu_yl_GetCardUid (41)3.2.1.8.53ss_rf_cpu_yl_read_HospitalInformation3 (41)3.2.1.8.54ss_rf_cpu_yl_write_HospitalInformation3 (41)3.2.1.8.55ss_rf_cpu_yl_read_OutpatientServiceInformation3 (42)3.2.1.8.56ss_rf_cpu_yl_write_OutpatientServiceInformation3 (42)3.2.1.8.57ss_rf_cpu_yl_read_OutpatientServiceInformation4 (42)3.2.1.8.58ss_rf_cpu_yl_write_OutpatientServiceInformation4 (42)3.2.1.8.59ss_rf_cpu_yl_read_OutpatientExpenses (43)3.2.1.8.60ss_rf_cpu_yl_write_OutpatientExpenses (43)3.2.1.8.61ss_rf_cpu_yl_AppcationLock_ddf1 (43)3.2.1.8.62ss_rf_cpu_yl_AppcationUnLock_ddf1 (43)3.2.1.8.63ss_rf_cpu_yl_AppcationLock_df01 (44)3.2.1.8.64ss_rf_cpu_yl_AppcationUnLock_df01 (44)3.2.1.8.65ss_rf_cpu_yl_AppcationLock_df02 (44)3.2.1.8.66ss_rf_cpu_yl_AppcationUnLock_df02 (44)3.2.1.8.67ss_rf_cpu_yl_AppcationLock_df03 (44)3.2.1.8.68ss_rf_cpu_yl_AppcationUnLock_df03 (45)3.2.1.8.69ss_rf_cpu_yl_CardLock (45)3.2.1.8.70ss_rf_cpu_yl_read_PayInfoFile (45)3.2.1.8.71ss_rf_cpu_yl_write_PayInfoFile (45)3.2.1.8.72ss_rf_VerifyPINSAM1 (45)3.2.1.8.73ss_rf_ResetSAM1AndVerifyPIN (46)3.2.1.8.74ss_rf_cpu_yl_read_Binaryphoto (46)3.2.1.8.75ss_rf_cpu_yl_write_Binaryphoto (46)3.2.1.8.76ss_rf_cup_yl_GetCardVersion (46)3.2.1.8.77ss_rf_SAM_Reset (46)3.2.1.8.78ss_rf_SAM_VerifyPIN (47)3.2.1.8.79ss_rf_SAM_ChangePIN (47)3.2.1.8.80ss_rf_SAM_Public (47)3.2.1.8.81ss_rf_SAM_Terminal (47)3.2.1.8.82ss_rf_SAM_PublicApp (48)3.2.1.8.83ss_rf_SAM_OrgCertificate (48)3.2.1.8.84ss_rf_SAM_Certificate (48)3.2.1.8.85ss_rf_SAM_SM3Digest (48)3.2.1.8.86ss_rf_SAM_SM2SignHash (49)3.2.1.9居民健康卡高级函数 (49)3.2.1.9.1SS_WSB_OpenDevice (49)3.2.1.9.2SS_WSB_CloseDevice (49)3.2.1.9.3SS_WSB_PowerOn (50)3.2.1.9.4SS_DC_ PowerOff (50)3.2.1.9.5SS_DC_SetSpacer (50)3.2.1.9.8SS_WSB_VerifyPIN (51)3.2.1.9.9SS_DC_ChangePIN (51)3.2.1.9.10SS_DC_RSAMPublic (52)3.2.1.9.11SS_DC_RSAMTerminal (52)3.2.1.9.12SS_DC_RSAMPublicApp (52)3.2.1.9.13SS_DC_RSAMOrgCertificate (52)3.2.1.9.14SS_DC_RSAMCertificate (53)3.2.1.9.15SS_WSB_RDDF1EF05 (53)3.2.1.9.16SS_WSB_RDDF1EF06 (53)3.2.1.9.17SS_WSB_RDDF1EF07 (54)3.2.1.9.18SS_WSB_WDDF1EF07 (54)3.2.1.9.19SS_WSB_RDDF1EF08 (54)3.2.1.9.20SS_WSB_WDDF1EF08 (55)3.2.1.9.21SS_WSB_RDF01EF05 (55)3.2.1.9.22SS_WSB_WDF01EF05 (55)3.2.1.9.23SS_WSB_RDF01EF06 (56)3.2.1.9.24SS_WSB_WDF01EF06 (56)3.2.1.9.25SS_WSB_RDF01EF07 (57)3.2.1.9.26SS_WSB_WDF01EF07 (57)3.2.1.9.27SS_WSB_RDF01EF08 (57)3.2.1.9.28SS_WSB_WDF01EF08 (58)3.2.1.9.29SS_WSB_RDF02EF05 (58)3.2.1.9.30SS_WSB_WDF02EF05 (59)3.2.1.9.31SS_WSB_RDF02EF06 (59)3.2.1.9.32SS_WSB_WDF02EF06 (59)3.2.1.9.33SS_WSB_RDF02EF07 (60)3.2.1.9.34SS_WB_WDF02EF07 (60)3.2.1.9.35SS_WSB_RDF02EF08 (60)3.2.1.9.36SS_WSB_WDF02EF08 (61)3.2.1.9.37SS_WSB_SM3Digest (61)3.2.1.9.38SS_WSB_SM2SignHash (61)3.2.1.9.39SS_WSB_RDF03EF05 (62)3.2.1.9.40SS_WSB_WDF03EF05 (62)3.2.1.9.41SS_WSB_EDF03EF05 (62)3.2.1.9.42SS_WSB_RDF03EF06 (63)3.2.1.9.43SS_WSB_WDF03EF06 (63)3.2.1.9.44SS_WSB_EDF03EF06 (63)3.2.1.9.45SS_DC_RSign_DF03EE00 (63)3.2.1.9.46SS_DC_RDF03EE00 (64)3.2.1.9.47SS_DC_WDF03EE00 (64)3.2.1.9.48SS_DC_RSign_DF03ED00 (65)3.2.1.9.49SS_DC_RDF03ED00 (65)3.2.1.9.50SS_DC_WDF03ED00 (65)3.2.1.9.53SS_WSB_RDF03ED00 (66)3.2.1.9.54SS_WSB_WDF03ED00 (67)3.2.1.10指纹采集比对 (67)3.2.1.10.1SS_ZW_Init (67)3.2.1.10.2SS_ZW_Close (68)3.2.1.10.3SS_ZW_GetErrorInfo (68)3.2.1.10.4SS_ZW_GetFPBmpData (68)3.2.1.10.5SS_ZW_GetCharFromSensor (68)3.2.1.10.6SS_ZW_Match2Char (68)3.2.1.10.7SS_ZW_GetCharFromBMP (68)3.2.1.10.8SS_ZW_MatchCharFromSensor (68)3.2.1.10.9MPS_* (69)4附录 (70)4.1门诊、住院记录T AG 定义 (70)1终端简介SS728M05是一款支持身份证、社保卡、居民健康卡、磁条卡等多种卡类型的多合一的读写终端，支持USB 通讯，采用模块化设计，适用于医院等发卡行业。

gooflow设计器API说明书

花生米AJAX-UI系列之:基于JQUERY的WEB在线流程图设计器GOOFLOW0.4版(2013-10-19)[特点]●跨浏览器，可兼容IE7--IE10，FireFox，Chrome，Opera等几大内核的浏览器，且不需要浏览器再加装任何控件。

●多系统兼容性、可移植性:由于只包括前台UI,因此二次开发者可很方便将本插件用在任何一种需要流程图的B/S系统应用上，流程图的详细实现逻辑完全交于后台程序开发者自己实现;对于后台,只要能返回/接收能被本插件解析的JSON格式数据即可.所以本插件可用于不同的服务器语言建立的后台上.●跨领域:流程图设计器不止用在电信领域,在其它需要IT进行技术支持的领域中都有重大作用.●以下从纯技术实现层面具体描述:●页面顶部栏、左边侧边栏均可自定义；●当左边的侧边栏设为不显示时，为只读状态，此时的视图区可当作是一个查看器而非编辑器。

●侧边工具栏除了基本和一些流程节点按钮外，还自定义新的节点按钮，自定义节点都可以有自有的图标、类型名称，定义后在使用可可在工作区内增加这些自定义节点。

●顶部栏可显示流程图数据组的标题，也可提供一些常用操作按钮。

●顶部栏的按钮，除了撤销、重做按钮外，其余按钮均可自定义点击事件。

●可画直线、折线；折线还可以左右/上下移动其中段。

●具有区域划分功能，能让用户更直观地了解哪些节点及其相互间的转换，是属于何种自定义区域内的。

●具有标注功能，用橙红色标注某个结点或者转换线，一般用在展示流程进度时。

●能直接双击结点、连线、分组区域中的文字进行编辑●在对结点、连线、分组区域的各种编辑操作，如新增/删除/修改名称/重设样式或大小/移动/标注时，均可捕捉到事件，并触发自定义事件，如果自定义事件执行的方法返回FALSE，则会阻止操作。

●具有操作事务序列控制功能，在工作区内的各种有效操作都能记录到一个栈中，然后可以进行撤销（undo()）或重做（redo()），像典型的C/S软件一样。

(完整版)详细设计说明书实例

信息发布系统(详细设计说明书)编写单位：JAVA实践小学期第22组设计人员：版本： 1.0编写日期：2010/9/5目录第一部分、引言 (2)1.1编写目的 (2)1.2背景 (3)1.3定义 (3)3.1程序描述 (5)3.2整体结构 (5)3.3性能 (5)3.4输入输出项 (5)3.5算法 (5)3.6主要类的设计 (5)3.7存储分配 (7)3.8注释 (7)3.9限制条件 (7)3.10测试计划 (7)3.11尚未解决的问题 (7)4.1程序描述 (7)4.2功能 (7)4.3性能 (8)4.4输入输出项 (8)4.5限制条件 (8)5设计特点 (8)5.1 通信便捷 (8)5.2 开发速度快 (8)第六部分、项目分工 (8)附录： (9)第一部分、引言1.1编写目的本说明书在概要设计的基础上，对信息发布系统的各模块、程序分别进行了实现层面上的要求和说明。

软件开发小组的产品实现成员应该阅读和参考本说明进行代码的编写、测试。

1.2背景说明：A、软件系统的名称:信息发布系统B、任务提出者：JA V A实践小学期开发者：第22组成员C、实现完成的系统将可用在所有JA V A虚拟机的个人PC上.为使用者提供信息发布，浏览，评论的方式，沟通各个用户.1.3定义服务器端API ：服务器端设计者通过规范的API文档，提供给客户端，以方便客户端的开发，使得同时进行，提高效率，节约时间。

两端通过protocol（协议类）进行通信。

Gson：Google提供的一个类库。

通过使用这个类库，可以把把对象转换成json格式的字符串，以方便在网络中的传输。

也可反向将字符串转换成对象，这样带有方法地操作对象，可以有效，方便地保证信息的沟通。

Json：JavaScript Object Notation，是一种轻量级的数据交换格式。

易于人阅读和编写，同时也易于机器解析和生成。

它基于JavaScript的一个子集，JSON采用完全独立于语言的文本格式，这些特性使得JSON成为理想的数据交换语言。

2023-接口开发文档规范说明书完整版-1

接口开发文档规范说明书完整版接口开发文档是一个项目的重要部分，特别是在需要与其他系统进行交互的情况下。

一个高质量的接口开发文档可以确保项目开发的顺利进行，并且在项目交付后便于其他开发人员进行集成和维护。

本文将分步骤介绍接口开发文档的规范说明书。

1.开头部分首先，接口开发文档应该包含一些基础信息，如项目名称、接口版本、开发者等等。

这部分内容应该包含以下信息：项目名称：将项目的名称写在接口文档的首界面中。

接口版本: 版本及更新时间应当明确。

开发者: 项目开发所需要的开发者信息，例如开发人员的姓名、联系方式等。

编写目标：确保编写接口开发文档的目标要与最终的产品实际一致。

2.设计原则在这一部分，我们应该介绍一些接口设计的原则，可以帮助开发者更好地理解整个接口以及为接口的设计和开发提供指导。

这部分内容可能包括：安全性：在设计时需考虑到接口安全性，例如使用https等安全传输协议。

易用性: 接口开发需要考虑接口的易用性，并尽量让用户便于使用。

在文档中应该明确 usage 的接口使用方式。

性能优化：在接口设计时需要考虑优化接口的性能，尽量减小接口的请求数据量以及优化响应时间。

3.接口参数在接口文档中，应该清晰地罗列出接口参数及其作用。

这部分信息应该包含：请求参数: GET、POST 的参数列表，以及参数类型。

响应参数：接口返回的 JSON 数据结构及其数据列表范例，StatusCode 对应 HTTP 状态码。

4.错误码接口调用时，可能会出现各种错误，例如参数错误、权限问题、系统错误等。

在文档中，应该明确描述这些错误及其对应的错误码。

错误码: 需要提供错误码表，防止接口调用者猜错码。

错误说明: 建议错误说明越详细越好，包括错误的原因以及如何解决（如果可以）。

5.完整示例最后，接口文档应该提供一个完整示例，以便开发者更好地理解如何使用接口以及响应的数据格式。

示例：建议以 RESTfulAPI 的方式来提供示例。

华为云数据仓库服务(DWS) 8.1.3.310 API 参考文档说明书

保留一切权利。

非经本公司书面许可，任何单位和个人不得擅自摘抄、复制本文档内容的部分或全部，并不得以任何形式传播。

商标声明和其他华为商标均为华为技术有限公司的商标。

本文档提及的其他所有商标或注册商标，由各自的所有人拥有。

注意您购买的产品、服务或特性等应受华为云计算技术有限公司商业合同和条款的约束，本文档中描述的全部或部分产品、服务或特性可能不在您的购买或使用范围之内。

除非合同另有约定，华为云计算技术有限公司对本文档内容不做任何明示或暗示的声明或保证。

由于产品版本升级或其他原因，本文档内容会不定期进行更新。

除非另有约定，本文档仅作为使用指导，本文档中的所有陈述、信息和建议不构成任何明示或暗示的担保。

目录1 使用前必读 (1)1.1 概述 (1)1.2 调用说明 (1)1.3 终端节点 (1)1.4 基本概念 (1)2 API概述 (3)3 如何调用API (5)3.1 构造请求 (5)3.2 认证鉴权 (8)3.3 返回结果 (9)4 快速入门 (11)5 API说明 (17)5.1 集群管理接口 (17)5.1.1 创建集群 (17)5.1.2 查询集群列表 (22)5.1.3 查询集群详情 (29)5.1.4 查询节点类型 (37)5.1.5 删除集群 (39)5.1.6 重启集群 (41)5.1.7 扩容集群 (42)5.1.8 重置密码 (44)5.1.9 集群工作负载管理 (46)5.1.9.1 查询工作负载管理计划列表 (46)5.1.9.2 查询工作负载管理计划 (49)5.1.9.3 切换工作负载计划阶段 (52)5.1.9.4 启动工作负载计划 (53)5.1.9.5 停止工作负载计划 (55)5.2 快照管理接口 (56)5.2.1 创建快照 (56)5.2.2 查询快照列表 (58)5.2.3 查询快照详情 (60)5.2.4 删除手动快照 (63)5.2.5 恢复集群 (64)5.3 数据库监控管理接口 (67)5.3.1 查询DWS集群状态 (67)5.3.2 查询DWS集群中数据库使用情况 (72)5.3.3 查询DWS集群各节点磁盘IO使用情况 (74)5.3.4 查询DWS集群各节点磁盘IO使用情况（聚合类型） (77)5.3.5 查询DWS集群各节点文件系统使用情况 (81)5.3.6 查询DWS集群各节点文件系统使用情况（聚合类型） (83)5.3.7 查询DWS集群节点各网卡流量 (87)5.3.8 查询DWS集群查询执行情况 (90)5.3.9 查询DWS集群会话执行情况 (94)5.3.10 查询DWS硬件资源使用情况 (96)5.3.11 查询DWS集群硬件资源使用情况（聚合类型） (99)6 附录 (103)6.1 状态码 (103)6.2 错误码 (105)6.3 创建VPC (113)6.4 获取资源集ID (113)6.5 获取租户ID (114)6.6 获取集群ID (114)6.7 获取Endpoint (115)1使用前必读1.1 概述欢迎使用数据仓库服务GaussDB(DWS)。

XXAPI接口设计说明书'公司2016年11月25日文档管理信息表【文档变更记录表目录文档变更记录表.......................................... 错误!未定义书签。

目录................................................... 错误!未定义书签。

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

编写目的 .................................... 错误!未定义书签。

背景 ........................................ 错误!未定义书签。

定义 ........................................ 错误!未定义书签。

参考资料 .................................... 错误!未定义书签。

综述.................................................... 错误!未定义书签。

统一的输入输出参数........................... 错误!未定义书签。

必须登录才能访问的接口....................... 错误!未定义书签。

错误返回码列表 .............................. 错误!未定义书签。

用户接口................................................ 错误!未定义书签。

用户注册（user/signup）...................... 错误!未定义书签。

用户登录（user/signin）...................... 错误!未定义书签。

优惠券接口.............................................. 错误!未定义书签。

详细设计说明书

详细设计说明书
详细设计说明书是一份技术文档，用于描述软件系统或产品的
设计细节、功能实现方案、接口定义、数据结构等内容。

该文档通
常由开发团队的技术人员编制，为后续软件开发、测试、维护等工
作提供指导。

详细设计说明书一般包括以下内容：
1. 系统概述：包括系统架构、模块划分、工作流程等内容。

2. 功能需求：详细描述系统各项功能需求及其实现方式，包括
用例图、活动图、时序图等。

3. 接口定义：描述系统内外部接口及其格式、传输方式，包括
数据传输协议、API 接口、UI 接口等。

4. 数据结构及存储：描述数据结构设计和存储方式，包括数据
库表结构、数据字典等。

5. 系统性能：描述系统性能指标、测试方案、性能优化措施等。

6. 系统安全：描述系统安全威胁、安全机制设计、安全测试等。

7. 项目计划：包括开发时间表、任务分配、里程碑等。

8. 其他：还可以根据项目需要添加其他内容，例如使用的技术、算法实现等。

总之，详细设计说明书是软件开发过程中不可或缺的一步，它
确保了开发团队的设计符合需求，减少了沟通成本，提高了开发效率。

K3CloudWebAPI接口说明书V0

K3Cloud WebAPI 接口说明书_V2.0目录1. 概述 (3)1.1. 目的 (3)1.2. 范围 (3)1.3. 适用对象 (3)1.4. 参考资料 (3)2. 问题与解决策略 (3)3. 目标和约束 (4)4. WebAPI架构 (4)4.1. 采用的技术 (4)4.1.1. Kingdee.BOS.WebApi.FormService.dll (4)4.1.2. Kingdee.BOS.WebApi.ServicesStub.dll (4)4.1.3. Kingdee.BOS.WebApi.Client.dll (4)4.1.4. 开发工具 (4)5. WebAPI接口详细描述 (5)5.1.1. 登陆验证接口 (5)5.1.2. 查看表单数据接口 (8)5.1.3. 保存表单数据接口 (9)5.1.4. 批量保存表单数据接口 (11)5.1.5. 提交表单数据接口 (14)5.1.6. 审核表单数据接口 (16)5.1.7. 反审核表单数据接口 (17)5.1.8. 删除表单数据接口 (18)5.1.9. 表单数据查询接口 (19)5.1.10. 自定义WebAPI接口 (21)6. 附录（集成相关知识分享） (24)1.1. 目的为异构系统访问K/3Cloud系统数据提供通用的接口。

当企业规模逐渐增大时，作为支撑业务运营的IT建设也变得越来越重要，不过往往企业的IT 建设过程中会发现某一家软件供应商基本不能完全覆盖企业所有的业务运营流程，这样的结果就是，企业上的IT系统很多很全，从ERP到HR、CRM、PDM、OA等，貌似所有的业务都覆盖到了，但实际上因为这些系统的不集成，而形成了企业很多新的信息孤岛，非常不利于企业的后续的管理和战略发展。

K/3Cloud从现今和往后的发展趋势来看，也不可避免会遇到上述问题，毕竟企业经营的多样化，并不是所有的业务都能在K/3Cloud中完成，所以我们必须在产品架构上支持更好的与外部系统进行协同。

神思SS728M05终端API接口函数库用户手册V1.6

文档编号归档编号发布状态文档版本SS728M05设备驱动接口函数库用户手册V1.6拟制：陈龙日期：2014-12-26 审核：日期：标准化：日期：批准：日期：山东神思电子目录SS728M05设备驱动接口函数库 (1)用户手册 (1)V1.6 (1)目录 (2)1终端简介 (8)1.1主要功能 (8)1.2主要技术指标 (8)2接口库概述 (9)2.1适用范围 (9)2.2说明 (9)3接口函数 (10)3.1函数返回值 (10)3.1.1通用返回值 (10)3.1.2居民健康卡（兼容山东保健证）错误代码 (11)3.2基本接口函数 (12)3.2.1SS728M05_SDK（SS728M05基本操作接口） (12)3.2.1.1基本函数 (12)3.2.1.1.1ICC_Reader_Open (12)3.2.1.1.2ICC_Reader_Close (12)3.2.1.1.3ICC_Reader_Reset (12)3.2.1.1.4ICC_Reader_PowerOff (13)3.2.1.1.5ICC_Reader_Application (13)3.2.1.1.6ICC_Reader_GetLastError (13)3.2.1.1.7ICC_Reader_Version (14)3.2.1.1.8SS_Reader_Reset (14)3.2.1.1.9SS_Reader_Reset_bBeep (15)3.2.1.1.10SS_Reader_PowerOff (15)3.2.1.1.11SS_Reader_Application (16)3.2.1.1.12SS_Reader_GetLastError (16)3.2.1.1.13SS_Reader_Version (16)3.2.1.1.14SS_Reader_GetVersionID (17)3.2.1.1.15SS_Reader_GetUserInfo (17)3.2.1.1.16SS_Reader_UpdateUserInfo (17)3.2.1.1.17SS_Reader_AutoRecognition (17)3.2.1.1.18SS_Reader_AutoFindCard (18)3.2.1.1.19ss_dev_beep (18)3.2.1.1.20ss_dev_led (18)3.2.1.2居民二代身份证函数 (18)3.2.1.2.1ss_id_ResetID2Card (18)3.2.1.2.4ss_id_query_sex (19)3.2.1.2.5ss_id_query_sexL (19)3.2.1.2.6ss_id_query_folk (20)3.2.1.2.7ss_id_query_folkL (20)3.2.1.2.8ss_id_query_birth (20)3.2.1.2.9ss_id_query_address (20)3.2.1.2.10ss_id_query_number (20)3.2.1.2.11ss_id_query_organ (21)3.2.1.2.12ss_id_query_termbegin (21)3.2.1.2.13ss_id_query_termend (21)3.2.1.2.14ss_id_query_photo_data (21)3.2.1.2.15ss_id_query_photo_file (21)3.2.1.2.16ss_id_query_newaddress (22)3.2.1.2.17ss_id_query_IDBaseInfo_text (22)3.2.1.2.18ss_id_GetSAMno (22)3.2.1.2.19ss_id_GetSAMStatus (23)3.2.1.2.20ss_id_GetFPMsg (23)3.2.1.3M1卡操作函数 (23)3.2.1.3.1ss_CardMifare_Reset (23)3.2.1.3.2ss_CardMifare_Authentication (23)3.2.1.3.3ss_CardMifare_ReadBlock (24)3.2.1.3.4ss_CardMifare_WriteBlock (24)3.2.1.3.5ss_CardMifare_Increment (24)3.2.1.3.6ss_CardMifare_Decrement (24)3.2.1.3.7ss_CardMifare_Copy (25)3.2.1.3.8ss_CardMifare_GetUID (25)3.2.1.4标准社保卡操作作函数 (25)3.2.1.4.1ss_rf_sb_FindCard (25)3.2.1.4.2ss_rf_sb_ReadCardIssuers (25)3.2.1.4.3ss_rf_sb_ReadCardholder (26)3.2.1.4.4ss_rf_sb_ReadFingerprint (26)3.2.1.5济南社保卡操作函数 (26)3.2.1.5.1ss_jn_sb_FindCard (26)3.2.1.5.2ss_jn_sb_QuerryCardNumber (26)3.2.1.64428卡操作函数 (27)3.2.1.6.1ss_sle_reset_card (27)3.2.1.6.2ss_sle4428_read_card (27)3.2.1.7磁条卡操作作函数 (28)3.2.1.7.1SS_CT_ReadInfo (28)3.2.1.7.2SS_CT_ReadInfo_ (28)3.2.1.8居民健康卡基本函数(兼容山东保健证) (28)3.2.1.8.1ss_reader_open (28)3.2.1.8.2ss_reader_close (29)3.2.1.8.5ss_rf_yl_cpu_find_cardB (29)3.2.1.8.6ss_rf_cpu_yl_read_cardInfo (29)3.2.1.8.7ss_rf_cpu_yl_write_cardInfo (29)3.2.1.8.8ss_rf_yl_cpu_read_issuingOrg (30)3.2.1.8.9ss_rf_yl_cpu_write_issuingOrg (30)3.2.1.8.10ss_rf_yl_cpu_read_demographicInfo1 (30)3.2.1.8.11ss_rf_yl_cpu_write_demographicInfo1 (30)3.2.1.8.12ss_rf_yl_cpu_read_hospital (31)3.2.1.8.13ss_rf_yl_cpu_write_hospital (31)3.2.1.8.14ss_rf_cpu_yl_read_photo (31)3.2.1.8.15ss_rf_cpu_yl_write_photo (31)3.2.1.8.16ss_rf_yl_cpu_read_address (32)3.2.1.8.17ss_rf_yl_cpu_write_address (32)3.2.1.8.18ss_rf_yl_cpu_read_linkman (32)3.2.1.8.19ss_rf_yl_cpu_write_linkman (32)3.2.1.8.20ss_rf_yl_cpu_read_demographicInfo2 (33)3.2.1.8.21ss_rf_yl_cpu_write_demographicInfo2 (33)3.2.1.8.22ss_rf_yl_cpu_read_idcardInfo (33)3.2.1.8.23ss_rf_yl_cpu_write_idcardInfo (33)3.2.1.8.24ss_rf_yl_cpu_read_illNum (34)3.2.1.8.25ss_rf_yl_cpu_write_illNum (34)3.2.1.8.26ss_rf_yl_cpu_read_BiometricIdentifier (34)3.2.1.8.27ss_rf_yl_cpu_write_BiometricIdentifier (34)3.2.1.8.28ss_rf_yl_cpu_read_SpecialIdentifier (35)3.2.1.8.29ss_rf_yl_cpu_write_SpecialIdentifier (35)3.2.1.8.30ss_rf_yl_cpu_read_AllergicReaction (35)3.2.1.8.31ss_rf_yl_cpu_write_AllergicReaction (35)3.2.1.8.32ss_rf_yl_cpu_read_Immunization (36)3.2.1.8.33ss_rf_yl_cpu_write_Immunization (36)3.2.1.8.34ss_rf_yl_cpu_read_HospitalEffectiveSign (36)3.2.1.8.35ss_rf_yl_cpu_write_HospitalEffectiveSign (36)3.2.1.8.36ss_rf_yl_cpu_RewriteRecord_HospitalEffectiveSign (37)3.2.1.8.37ss_rf_yl_cpu_EraseRecord_HospitalEffectiveSign (37)3.2.1.8.38ss_rf_yl_cpu_read_OutpatientServiceEffectiveSign (37)3.2.1.8.39ss_rf_yl_cpu_write_OutpatientServiceEffectiveSign (37)3.2.1.8.40ss_rf_yl_cpu_RewriteRecord_OutpatientServiceEffectiveSign (38)3.2.1.8.41ss_rf_yl_cpu_EraseRecord_OutpatientServiceEffectiveSign (38)3.2.1.8.42ss_rf_cpu_yl_read_HospitalInformation1 (38)3.2.1.8.43ss_rf_cpu_yl_write_HospitalInformation1 (38)3.2.1.8.44ss_rf_cpu_yl_read_HospitalInformation2 (39)3.2.1.8.45ss_rf_cpu_yl_write_HospitalInformation2 (39)3.2.1.8.46ss_rf_cpu_yl_read_OutpatientServiceInformation1 (39)3.2.1.8.47ss_rf_cpu_yl_write_OutpatientServiceInformation1 (39)3.2.1.8.48ss_rf_cpu_yl_read_OutpatientServiceInformation2 (40)3.2.1.8.49ss_rf_cpu_yl_write_OutpatientServiceInformation2 (40)3.2.1.8.50ss_rf_cpu_yl_read_FingerprintFile (40)3.2.1.8.51ss_rf_cpu_yl_write_FingerprintFile (41)3.2.1.8.52ss_rf_cpu_yl_GetCardUid (41)3.2.1.8.53ss_rf_cpu_yl_read_HospitalInformation3 (41)3.2.1.8.54ss_rf_cpu_yl_write_HospitalInformation3 (41)3.2.1.8.55ss_rf_cpu_yl_read_OutpatientServiceInformation3 (42)3.2.1.8.56ss_rf_cpu_yl_write_OutpatientServiceInformation3 (42)3.2.1.8.57ss_rf_cpu_yl_read_OutpatientServiceInformation4 (42)3.2.1.8.58ss_rf_cpu_yl_write_OutpatientServiceInformation4 (42)3.2.1.8.59ss_rf_cpu_yl_read_OutpatientExpenses (43)3.2.1.8.60ss_rf_cpu_yl_write_OutpatientExpenses (43)3.2.1.8.61ss_rf_cpu_yl_AppcationLock_ddf1 (43)3.2.1.8.62ss_rf_cpu_yl_AppcationUnLock_ddf1 (43)3.2.1.8.63ss_rf_cpu_yl_AppcationLock_df01 (44)3.2.1.8.64ss_rf_cpu_yl_AppcationUnLock_df01 (44)3.2.1.8.65ss_rf_cpu_yl_AppcationLock_df02 (44)3.2.1.8.66ss_rf_cpu_yl_AppcationUnLock_df02 (44)3.2.1.8.67ss_rf_cpu_yl_AppcationLock_df03 (44)3.2.1.8.68ss_rf_cpu_yl_AppcationUnLock_df03 (45)3.2.1.8.69ss_rf_cpu_yl_CardLock (45)3.2.1.8.70ss_rf_cpu_yl_read_PayInfoFile (45)3.2.1.8.71ss_rf_cpu_yl_write_PayInfoFile (45)3.2.1.8.72ss_rf_VerifyPINSAM1 (45)3.2.1.8.73ss_rf_ResetSAM1AndVerifyPIN (46)3.2.1.8.74ss_rf_cpu_yl_read_Binaryphoto (46)3.2.1.8.75ss_rf_cpu_yl_write_Binaryphoto (46)3.2.1.8.76ss_rf_cup_yl_GetCardVersion (46)3.2.1.8.77ss_rf_SAM_Reset (46)3.2.1.8.78ss_rf_SAM_VerifyPIN (47)3.2.1.8.79ss_rf_SAM_ChangePIN (47)3.2.1.8.80ss_rf_SAM_Public (47)3.2.1.8.81ss_rf_SAM_Terminal (47)3.2.1.8.82ss_rf_SAM_PublicApp (48)3.2.1.8.83ss_rf_SAM_OrgCertificate (48)3.2.1.8.84ss_rf_SAM_Certificate (48)3.2.1.8.85ss_rf_SAM_SM3Digest (48)3.2.1.8.86ss_rf_SAM_SM2SignHash (49)3.2.1.9居民健康卡高级函数 (49)3.2.1.9.1SS_WSB_OpenDevice (49)3.2.1.9.2SS_WSB_CloseDevice (49)3.2.1.9.3SS_WSB_PowerOn (50)3.2.1.9.4SS_DC_ PowerOff (50)3.2.1.9.5SS_DC_SetSpacer (50)3.2.1.9.8SS_WSB_VerifyPIN (51)3.2.1.9.9SS_DC_ChangePIN (51)3.2.1.9.10SS_DC_RSAMPublic (52)3.2.1.9.11SS_DC_RSAMTerminal (52)3.2.1.9.12SS_DC_RSAMPublicApp (52)3.2.1.9.13SS_DC_RSAMOrgCertificate (52)3.2.1.9.14SS_DC_RSAMCertificate (53)3.2.1.9.15SS_WSB_RDDF1EF05 (53)3.2.1.9.16SS_WSB_RDDF1EF06 (53)3.2.1.9.17SS_WSB_RDDF1EF07 (54)3.2.1.9.18SS_WSB_WDDF1EF07 (54)3.2.1.9.19SS_WSB_RDDF1EF08 (54)3.2.1.9.20SS_WSB_WDDF1EF08 (55)3.2.1.9.21SS_WSB_RDF01EF05 (55)3.2.1.9.22SS_WSB_WDF01EF05 (55)3.2.1.9.23SS_WSB_RDF01EF06 (56)3.2.1.9.24SS_WSB_WDF01EF06 (56)3.2.1.9.25SS_WSB_RDF01EF07 (57)3.2.1.9.26SS_WSB_WDF01EF07 (57)3.2.1.9.27SS_WSB_RDF01EF08 (57)3.2.1.9.28SS_WSB_WDF01EF08 (58)3.2.1.9.29SS_WSB_RDF02EF05 (58)3.2.1.9.30SS_WSB_WDF02EF05 (59)3.2.1.9.31SS_WSB_RDF02EF06 (59)3.2.1.9.32SS_WSB_WDF02EF06 (59)3.2.1.9.33SS_WSB_RDF02EF07 (60)3.2.1.9.34SS_WB_WDF02EF07 (60)3.2.1.9.35SS_WSB_RDF02EF08 (60)3.2.1.9.36SS_WSB_WDF02EF08 (61)3.2.1.9.37SS_WSB_SM3Digest (61)3.2.1.9.38SS_WSB_SM2SignHash (61)3.2.1.9.39SS_WSB_RDF03EF05 (62)3.2.1.9.40SS_WSB_WDF03EF05 (62)3.2.1.9.41SS_WSB_EDF03EF05 (62)3.2.1.9.42SS_WSB_RDF03EF06 (63)3.2.1.9.43SS_WSB_WDF03EF06 (63)3.2.1.9.44SS_WSB_EDF03EF06 (63)3.2.1.9.45SS_DC_RSign_DF03EE00 (63)3.2.1.9.46SS_DC_RDF03EE00 (64)3.2.1.9.47SS_DC_WDF03EE00 (64)3.2.1.9.48SS_DC_RSign_DF03ED00 (65)3.2.1.9.49SS_DC_RDF03ED00 (65)3.2.1.9.50SS_DC_WDF03ED00 (65)3.2.1.9.53SS_WSB_RDF03ED00 (66)3.2.1.9.54SS_WSB_WDF03ED00 (67)3.2.1.10指纹采集比对 (67)3.2.1.10.1SS_ZW_Init (67)3.2.1.10.2SS_ZW_Close (68)3.2.1.10.3SS_ZW_GetErrorInfo (68)3.2.1.10.4SS_ZW_GetFPBmpData (68)3.2.1.10.5SS_ZW_GetCharFromSensor (68)3.2.1.10.6SS_ZW_Match2Char (68)3.2.1.10.7SS_ZW_GetCharFromBMP (68)3.2.1.10.8SS_ZW_MatchCharFromSensor (68)3.2.1.10.9MPS_* (69)4附录 (70)4.1门诊、住院记录T AG 定义 (70)1终端简介SS728M05是一款支持身份证、社保卡、居民健康卡、磁条卡等多种卡类型的多合一的读写终端，支持USB 通讯，采用模块化设计，适用于医院等发卡行业。

接口文档规范

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:[{label:'待开票'value:1001},{label:'回款'value:1003}](8) “操作类型”的接口必须返回msg信息内容(9) 返回的展示型数据应具有可用性例如：createTime：生成时间（建议格式）{createTime:'2018-8-20 17:00:00'}建议：由于前台处理数据能力较弱，故后台返回的数据尽可能便于前台使用。

接口设计说明书(软件设计文档范例)

并定位至最后一条记录.
默认值：
C 字符型字段为空格
N 数值型字段为 0
D 日期型字段为 1970-01-01
L 逻辑型字段为 F
DB_Delete_Rec
【函数原型】int DB_Delete_Rec(DB_HANDLE DB_Handle)
【功能】给当前记录添加删除标记
【声明头文件】dbms.h
【参数说明】
DB_Is_Deleted
【函数原型】int DB_Is_Deleted(DB_HANDLE DB_Handle)
【功能】判断当前记录是否已被删除。
【声明头文件】dbms.h
【参数说明】
1、DB_Handle 数据库句柄
【返回值说明】
DB_ERROR_POINT_INVALID
参数 DB_Handle 所指向的数据库无效
第3页
LK9000 编程接口说明书
高立开元公司
【返回值说明】【使用方法】
对已删除的记录进行过滤后，使用 DB_Go_Next、DB_Go_Prev、DB_Go_Top、 DB_Go_Bottom、DB_Scan、DB_Seek_First、DB_Seek_Next 将不会定位到已删除的记录上。DB_Go_RecNo 除外。
执行成功
【使用方法】
追加新记录时调用该函数。
【提示】
记录指针会自动指向新添加的记录，并进入编缉状态，此时记录指针不可移动。
DB_post_Rec(DB_HANDLE DB_Handle)函数则将当前记录的修改写入文件，并恢
复当前记录的浏览状态.
DB_Unpost_Rec(DB_HANDLE DB_Handle)函数则可以放弃了对追加记录的修改，

Cuteinfo 交换平台(Net 版) 客户端 API 接口说明书 V10 - API接口说明书

setUsername getUsername
setUserTokenID
类型 string string 返回类
型 void string
string
getUserTokenID UserToken UserToken
void 无无
作用用户名称用户令牌
参数类型及参数
string username 无
API 接口说明书 V1.0
2.4.1 UUserToken 类
类名说明命名空间变量
方法
UUserToken 对用户名称和用户令牌进行封装
mon.pojo
名称 username userTokenID
方法名称
1.1 阅读对象....................................................................................................................... 2 1.2 项目背景....................................................................................................................... 2 2 环境准备 .................................................................................................................................. 2 2.1 概述............................................................................................................................... 2 2.2 .NET 开发环境............................................................................................................. 2 2.3 使用该包说明............................................................................................................... 2 2.4 定义............................................................................................................................... 2

apg利用说明书

4.4操纵...................................................................................................................................... 12
1引言
1.1编写目的
3.5故障处置要求 ........................................................................................................................ 6
3.6其他专门要求 ........................................................................................................................ 7
4运行环境规定 ............................................................................................................................. 11
4.1设备...................................................................................................................................... 11
（2）游戏市场：此刻游戏种类千差万别，网络游戏、单机游戏层出不穷，但几乎没有以抗日为主题开发的，这是一个商机。
（3）咱们此刻是大三的学生，已经学习和正在学习一些相关知识，如软件工程、汇编、游戏开发等，应该有能力开发出一个简单的游戏。

api 标准

api 标准
API标准通常包括以下几个方面：
1.接口设计：API的接口设计应遵循标准化、可预测和可扩展的原则，这意味
着接口应易于使用和理解，提供一致的接口行为，并能够支持各种不同的用例和场景。

2.命名规范：API的命名应遵循一致的命名规则和准则，以便开发人员能够轻
松地识别和理解接口的名称和功能。

命名规范可以包括使用有意义的名称、避免使用模糊的缩写或简写等。

3.数据格式：API应使用标准的数据格式，以确保数据的准确性和一致性。

这
包括使用正确的数据类型、数据单位和数据精度等。

4.通信协议：API应使用标准的通信协议，以确保数据的可靠传输和安全传输。

这包括使用HTTP、tcp、UDP等协议，以及使用SSL、TLS等加密协议来保护数据的机密性和完整性。

5.错误处理：API应提供适当的错误处理机制，以处理请求或响应中的错误情
况。

这包括返回适当的错误代码和错误信息，以便调用者能够理解和解决问题。

6.安全：API应遵循安全最佳实践，以确保数据的机密性、完整性和可用性。

这包括使用访问控制、身份验证和授权机制等来保护API的安全性。

7.性能：API应具有适当的性能表现，以满足业务需求和用户体验。

这包括处
理请求的响应时间、吞吐量等性能指标。

8.维护和文档：API应提供适当的维护和文档支持，以帮助开发人员了解和使
用API。

这包括提供清晰的文档说明、示例代码和问题支持等。

软件设计说明书(含使用说明)

软件设计说明书目录1. 引言 (2)2. 系统架构设计 (2)3. 模块设计 (3)4. 接口规范 (5)5. 流程图和数据流图 (5)6. 系统性能和安全性设计 (5)7. 术语表 (5)1. 引言在线教育平台软件设计说明书旨在详细描述系统的软件架构、模块设计、数据库设计和接口规范等关键设计方面的内容。

本文档将帮助开发团队理解系统设计，并指导开发过程中的实施。

2. 系统架构设计a. 客户端架构- 前端框架：选择适合的前端框架，如React、Angular或Vue.js，用于构建用户界面。

- 前端路由：设计前端路由，实现不同页面之间的导航和跳转。

- 前端状态管理：使用合适的状态管理库，如Redux或Vuex，管理前端应用状态。

b. 服务器架构- 后端框架：选择适合的后端框架，如Node.js、Django或Spring Boot，用于处理业务逻辑。

- RESTful API：设计和实现符合RESTful原则的API接口，用于前后端数据交互。

- 身份验证和授权：实施安全的身份验证和授权机制，保护系统的安全性。

c. 数据库设计- 数据库类型：选择适合的数据库类型，如关系型数据库（如MySQL）或非关系型数据库（如MongoDB）。

- 数据表设计：设计数据库表结构，确保数据的一致性和完整性。

- 数据库索引和查询优化：优化数据库查询性能，提升系统的响应速度。

3. 模块设计a. 用户管理模块- 注册和登录：设计用户注册和登录功能，包括验证和存储用户凭据。

- 用户资料管理：实现用户个人资料的查看、编辑和更新功能。

- 角色和权限管理：设计角色和权限模型，限制用户访问和操作的范围。

b. 课程管理模块- 课程创建和编辑：实现教师创建和编辑课程的功能，包括添加章节、上传资料等。

- 课程浏览和搜索：设计学生浏览和搜索课程的功能，按照不同条件进行过滤和排序。

- 课程讨论和问答：提供学生和教师之间的在线交流和讨论功能。

c. 在线教学模块- 直播课堂：实现教师在线授课和学生参与的直播课堂功能，支持实时互动。

Rockchip RKNN API 用户指南说明书

Rockchip User Guide RKNN_APIV1.3.0目录1 主要功能说明 (3)2 系统依赖说明 (3)2.1L INUX平台依赖 (3)2.2A NDROID平台依赖 (3)3 API使用说明 (4)3.1RKNN API详细说明 (4)3.1.1 rknn_init & rknn_init2 (5)3.1.2 rknn_destroy (6)3.1.3 rknn_query (6)3.1.4 rknn_inputs_set (10)3.1.5 rknn_run (11)3.1.6 rknn_outputs_get (11)3.1.7 rknn_outputs_release (13)3.1.8 rknn_find_devices (13)3.2RKNN数据结构定义 (14)3.2.1 rknn_input_output_num (14)3.2.2 rknn_tensor_attr (14)3.2.3 rknn_input (15)3.2.4 rknn_output (16)3.2.5 rknn_perf_detail (17)3.2.6 rknn_perf_run (17)3.2.7 rknn_init_extend (17)3.2.8 rknn_run_extend (17)3.2.9 rknn_output_extend (18)3.2.10 rknn_sdk_version (18)3.2.11 rknn_devices_id (18)3.2.12 rknn返回值错误码 (19)3.3RKNN API基本调用流程 (19)4 DEMO使用说明 (25)4.1L INUX A RM D EMO (25)4.1.1 编译说明 (25)4.1.2 运行说明 (26)4.2L INUX X86D EMO (27)4.2.1 编译说明 (27)4.2.2 运行说明 (27)4.3A NDROID D EMO (28)4.3.1 编译说明 (28)4.3.2 运行说明 (29)5 附录 (30)5.1API迁移说明 (30)5.1.1 v0.9.1到v0.9.2 (30)1主要功能说明本API SDK为基于Linux/Android的神经网络NPU硬件的一套加速方案，可为采用RKNN API 开发的AI相关应用提供通用加速支持。