接口规则说明书

合集下载

中国结算系统接口规格说明书

中国结算系统接口规格说明书

上海证券交易所技术文档上海证券交易所市场端软件使用和登录规范说明V0.7上海证券交易所二○一六年九月文档版本历史表版本号作者操作日期说明0.7 技术公司技术开发总部修改2016-9-26 新增EzTrans2016版0.6 技术公司技术开发总部修改2016-08-201、报盘软件新增操作系统WindowsServer 20122、新增EzStep2016版0.5 技术开发部修改2015-12-30 1、新增ezoes2015版本2、A股、B股报盘子系统整合为报盘子系统3、修订软件对数据库兼容标准0.4 技术开发部修改2015-11-24 1、新增ezstep2015版本2、修订EzSTEP应急工具关联软件版本0.3 技术开发部、通信公司修改2015-4-27 1、新增FAST行情数据包TTL值描述2、新增网络接入规范描述3、新增软件对操作系统及数据库的兼容标准4、新增债券平台客户端5、停止对ETFPUT提供技术支持6、停止对RPTGET提供技术支持7、停止对SR提供技术支持8、请尽快升级ezstep2014版,其他版本在近期无法正常登录综业平台9、后续EzOES只提供AB子系统软件包,不再单独发布A和B子系统软件包10、新增EzOES配置附录A11、新增行情接入地址附录B12、新增下线软件附录C0.2 技术开发部修改2014-12-17 1、新增EzSR港交所SPV专用版2、新增各软件的运行环境说明3、添加生产与测试环境号定义4、添加软件端口号说明5、新增EzStep2014版6、新增EzTrader2014Update2版7、新增EzTrans2014Update3版0.1 技术开发部创建2014-11-19 N/A文档摘要本文档是上海证券交易所市场端软件使用和登录规范说明特别申明●本文档为本所市场端软件使用和登录规范说明,所涉相关业务规定以本所业务规则为准。

●本所保留对本文档的解释与修改权。

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

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

【参数说明】
1、DB_Handle 数据库句柄
【返回值说明】
DB_ERROR_POINT_INVALID
参数 DB_Handle 所指向的数据库无效
DB_ERROR_RECORD_POSITION 记录位置无效
DB_ERROR_MUST_POST_RECORD 记录正处于编缉状态
DB_ERROR_FILE_INVALID
第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_NO_ERROR
执行成功
【使用方法】
移动数据库记录指针时使用,当前数据库文件一定要在打开状态。
【提示】
如果当前记录处于编缉状态(执行了追加,更改,删除,恢复操作),记录指针是不允
许移动的。
DB_post_Rec(DB_HANDLE DB_Handle)函数则将当前记录的修改写入文件,并恢
【功能】移动数据库记录指针到下一条记录
【声明头文件】dbms.h
【参数说明】
1、DB_Handle 数据库句柄
【返回值说明】
DB_ERROR_POINT_INVALID
参数 DB_Handle 所指向的数据库无效
DB_ERROR_RECORD_POSITION 记录位置无效
DB_ERROR_FILE_INVALID
复当前记录的浏览状态

ECB数据仓库API接口使用指南说明书

ECB数据仓库API接口使用指南说明书

Package‘ecb’April20,2023Type PackageTitle Programmatic Access to the European Central Bank's StatisticalData WarehouseVersion0.4.2Date2023-04-20Description Provides an interface to the'European Central Bank's StatisticalData Warehouse'API<https://sdw.ecb.europa.eu/>,allowing for programmaticretrieval of a vast quantity of statistical data.License CC0URL https://sdw.ecb.europa.eu/Suggests knitr,rmarkdown,dplyr,lubridate,ggplot2,testthat,zooImports curl,rsdmx,xml2,httrVignetteBuilder knitrRoxygenNote7.1.1NeedsCompilation noAuthor Eric Persson[aut,cre]Maintainer Eric Persson<*******************>Repository CRANDate/Publication2023-04-2016:32:34UTCR topics documented:convert_dates (2)get_data (2)get_dataflows (4)get_description (4)get_dimensions (5)Index61convert_dates Format date variable retrieved from the SDW into a proper date vari-ableDescriptionFormat date variable retrieved from the SDW into a proper date variableUsageconvert_dates(x)Argumentsx A vector of datesValueA date-formatted vectorExampleshicp<-get_data("ICP.M.U2.N.000000.4.ANR")hicp$obstime<-convert_dates(hicp$obstime)str(hicp)get_data Retrieve data from the ECB Statistical Data Warehouse APIDescriptionRetrieve data from the ECB Statistical Data Warehouse APIUsageget_data(key,filter=NULL,...)Argumentskey A character string identifying the series to be retrievedfilter A named list with additionalfilters(see details)...Arguments passed to GET(e.g.timeout(10)to add maximum request time)DetailsThe filter option of get_data()takes a named list of key-value pairs.If left blank,it returns all data for the current version.Availablefilter parameters:•startPeriod&endPeriod–YYYY for annual data(e.g.:2013)–YYYY-S[1-2]for semi-annual data(e.g.:2013-S1)–YYYY-Q[1-4]for quarterly data(e.g.:2013-Q1)–YYYY-MM for monthly data(e.g.:2013-01)–YYYY-W[01-53]for weekly data(e.g.:2013-W01)–YYYY-MM-DD for daily data(e.g.:2013-01-01)•updatedAfter–A timestamp to retrieve the latest version of changed values in the database since a certainpoint in time–Example:filter=list(updatedAfter=2009-05-15T14:15:00+01:00)•firstNObservations&lastNObservations–Example:filter=list(firstNObservations=12)retrieves thefirst12observationsof all specified series•detail–Possible options:full/dataonly/serieskeysonly/nodata–dataonly is the default–Use serieskeysonly or nodata to list series that match a certain query,without returningthe actual data–An alternative to using serieskeys/nodata is the convenience function get_dimensions(),which returns a list of dataframes with dimensions and explanations(see extended exam-ple below).–full returns both the series values and all metadata.This entails retrieving much moredata than with the‘dataonly‘option.•includeHistory(not currently implemented)–false(default)returns only version currently in production–true returns version currently in production,as well as all previous versions See the SDW API for more details.ValueA data frameExamples#Get monthly data on annualized euro area headline HICPhicp<-get_data("ICP.M.U2.N.000000.4.ANR")head(hicp)4get_description get_dataflows Retrieve data frame of all datasets in the ECB Statistical Data Ware-houseDescriptionRetrieve data frame of all datasets in the ECB Statistical Data WarehouseUsageget_dataflows(...)Arguments...Arguments passed to GET(e.g.timeout(10)to add maximum request time) ValueA dataframeExamplesdf<-get_dataflows()head(df)get_description Get full,human-readable description of a seriesDescriptionGet full,human-readable description of a seriesUsageget_description(key)Argumentskey A character string identifying the series to be retrievedValueA character vectorExamplesget_description("ICP.M.DE.N.000000+XEF000.4.ANR")get_dimensions5 get_dimensions Retrieve dimensions of series in the ECB’s SDWDescriptionRetrieve dimensions of series in the ECB’s SDWUsageget_dimensions(key,...)Argumentskey A character string identifying the series to be retrieved...Arguments passed to GET(e.g.timeout(10)to add maximum request time)ValueA list of data frames,one for each series retrievedExampleshicp_dims<-get_dimensions("ICP.M.U2.N.000000.4.ANR")hicp_dims[[1]]Indexconvert_dates,2get_data,2get_dataflows,4get_description,4get_dimensions,56。

汉印云打印 开放API 接口文档 使用说明书

汉印云打印 开放API 接口文档 使用说明书

【汉印云打印】开放API接口文档版本(1.1)2018年10月汉印云打印平台.接口文档V1.1目录1.概述: (1)2.打印接口: (1)2.1API接口地址 (1)2.2API请求方式 (1)2.3API调用方法 (1)2.4系统级和应用级的参数 (2)2.5签名加密算法如下: (3)2.6加密示例: (3)2.7需要传递给API的参数是: (3)3.APP调用功能: (4)3.1添加打印机 (4)3.2删除打印机 (5)3.3打印订单 (6)3.4查询打印机状态 (7)3.5查询打印完成情况 (8)4.内容排版标记参数 (10)5.注意事项 (13)6.版本信息: (14)1.概述:汉印云打印平台是以互联网为基础,整合云打印机资源,构建漫游共享的打印平台,向所有用户提供随时随地高质量、标准化的打印服务,包含了云平台、API、云打印服务器、云打印机等,产品广泛应用于快递业、超市、餐饮、社区店、生鲜店等,并致力于成为国内一线互联网云平台。

本文档提供了面向互联网开放的API接口,可有效的实现汉印云打印平台和应用开发者之间的对接,帮助用户和开发者方便地使用云平台的架构和功能。

2.打印接口:本节介绍如何发送数据到汉印云API并通过云平台输出打印指令,以及对应的状态返回码。

2.1API接口地址/api/values2.2API请求方式POST2.3API调用方法发送打印数据到汉印云API请求以及参数应该用POST方法发送。

汉印云API将根据收到的信息验证请求的有效性反馈对应的状态码。

2.4系统级和应用级的参数发送打印数据到汉印云请求必须包含以下参数(系统级参数和应用级参数)。

系统级参数应用级参数2.5签名加密算法如下:Sign=MD5(UserID+PrinterNo+TimeStamp+ApiKey),串在一起后进行MD5加密然后再转成大写,括号里面的参数只需要传入值。

2.6加密示例:000001hcs100171600521498469357ED93DC463FA44A7F8BD1919AE282C 310这是未加密前串在一起的排列,然后把这串字符进行MD5加密得到的结果就是sign的值Sign=MD5(UserID+PrinterNo+TimeStamp+ApiKey)2.7需要传递给API的参数是:UserID、PrinterNo、TimeStamp这3个参数是需要提交给API的。

RTsapiBar接口文档说明书

RTsapiBar接口文档说明书

一、概述RTsapiBar是在Tsapi Release2规范基础上,实现的一个呼叫控制条的Windows组件(ActiveX)。

每个通话抽象出一个对象叫做call,这个对象在交换机的资源中是唯一的,所以每个呼叫对象有一个唯一标识id叫做callid。

每个通话通常有若干个话机组成,tsapi模型中叫做连接(Connection),连接可以用话机号码来表示。

Call和Connection组成了tsapi呼叫模型,两者均有生命周期,呼叫控制的每个阶段都会有特有的状态和事件通知。

二、环境2.1软件环境操作系统:win xp/win2000/win2003IDE:VC++6.0(更高),VB,Delphi6.0(更高),C++ Builder,C#,WEB等均可2.2 硬件环境CPU:PIII/PIII以上内存:512MB2.3 安装本实现包包含以下内容:1 RTsapi.dll2 RTsapi.ini3 RTsapiBar.ocxc/s应用开发安装方法:regsvr32 “RTsapiBar.ocx存放硬盘路径\RTsapiBar.ocx”。

在IDE中插入RtsapiBar进行界面开发即可。

Web应用开发安装方法:将RTsapiBar.cab包放到网站的某个目录下面。

假如将这个包放在网站的根目录下面网页中可以这样引入RtsapiBar:<OBJECTID="RTsapiBar"WIDTH=850HEIGHT=32codebase="RTsapiBar.cab#version=1,0,0,0"CLASSID="CLSID:6663C5E2-E0D8-4EA9-8871-1E4A28F6F1FA"><PARAM NAME="_Version" VALUE="65536"><PARAM NAME="_ExtentX" VALUE="21167"><PARAM NAME="_ExtentY" VALUE="847"><PARAM NAME="_StockProps" VALUE="0">…控件常用属性</OBJECT>三、属性介绍:3.1 ServIP类型:字符串CTI服务器IP地址。

中信银行电子商务BB银企直联接口说明书V

中信银行电子商务BB银企直联接口说明书V
报文,删除“交易类型”字段,增加“查
询类型”字段
扈浩
2010-4-29
V1.0
刘坚
修改3.1〜3.8的请求报文,删除“币种”
字段
扈浩
2010-4-29
V1.0
刘坚
修改商户附属账户交易明细查询的响应
报文,删除“币种”字段
扈浩
2010-4-30
V1.0
扈浩
修改第一章、第二章部分文字描述
扈浩
2010-5-20
V1.0
刘坚
修改“冻结编号”字段长度为22;
修改“柜员交易号”字段长度为14;
修改出金交易的请求报文,“收款账号”
字段长度为32;
修改商户附属账户冻结信息查询交易的
请求报文,删除“冻结类型”字段。
扈浩
2010-5-27
V1.0
刘坚
修改商户附属账户交易明细查询的响应
报文,增加“交易时间”字段;
修改商户附属账户冻结信息查询的响应 报文,增加“冻结时间”与“解冻时间” 字段。
扈~~—亍万军
增加3.9〜3.13报文接口;
修改订单交易结果查询的响应报文,增加
“交易金额”、“货币代码”、“付款账号”、
“收款账号”等字段。
扈浩
2011-9-27
V2.1
罗锡飞
修改出金(3.5)的请求报文,增加“预约 标志”、“预约日期”、“预约时间”字段。
扈浩
2011-12-01
3.24.2响应报文39
3.25会员注册40
3.25.1请求报文40
3.25.2响应报文42
3.26附属账户签约状态查询43
3.26.1请求报文43
3.26.2响应报文43

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

API接口说明书模板

API接口说明书模板

API接口说明书Word模板API接口说明书某某系统接口说明书北京某某科技有限公司2020年7月目录某某系统接口说明书1引言1.1编写目的1.2范围1.3参考资料2APP接口说明2.1接口名称2.1.1请求地址2.1.2参数说明2.1.3返回结果说明2.1.4示例1引言1.1编写目的本报告的目的为了明确某某艺术馆App调用系统服务器的接口,为安排App的开发提供依据。

1.2范围本报告主要围绕App应用提出的基本需求,为下一步的App开发系统提供基础的API接口。

2APP接口说明2.1接口名称2.1.1请求地址2.1.3返回结果说明2.1.4示例URL:http://www.***.com/d/app/focusAd?type=1&locale=zh 返回结果:[{"id":18,"picUrl":"focusad/08f5c8d1-7671-4514-cfc0-7a76e4e64836.jpg","title":"独立风骨","type":1,"createtime":1434532509000,"effTs":14345325 09000,"des":"","isUsing":1,"sortNum":1,"toUrl":"http://w ww.***.com/guest/88242"},{"id":16,"picUrl":"focusad/fd e16538-50f1-48f6-ef14-b17c78772fa1.jpg","title":"华南理工大学","type":1,"createtime":1433154304000,"effTs":14331543 04000,"des":"舞跃华南","isUsing":1,"sortNum":1,"toUrl":"http://www.***com/c ontent/expoEvent16/1"},{"id":19,"picUrl":"focusad/b1782a75-429f-476f-cc75-8c3601e85ddb.jpg","title":"中央美术学院"}]。

  1. 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
  2. 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
  3. 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。

1.固定资产、其他物资
1)资产卡片生成
采购端采购物资入库之后,系统根据审核确认之后的入库信息生成实物资产卡片。

入库单的信息徐包含费用类型、NC资产卡片的组织机构、资产类型、资产二级分类、资产三级分类、采购入库单号(或合同编号)等信息。

采购入库单
NC资产卡片
采购入库单根据判断规则自动生成资产卡片,规则如下:
注:1使用年限是用户根据物资类型划分是大于1年还是小于1年,其中使用年限的维护方案以采购系统为主。

2)NC资产卡片字段生成:
1、费用类型:
采购系统生成卡片时默认费用类型(费用类型有理赔费用,非理赔费用,理赔非理赔共用)为“非理赔费用”,后期费用类型的判断在资产系统通过领用单和变动单完成。

2、NC资产卡片的组织机构:
NC资产卡片的组织机构来源于采购端的采购组织(例如总公司代上海采购,那么采购组织就是上海)。

可以理解为所有买来的资产全部都堆在一个虚拟仓库中,但是虚拟仓库中的资产有不同的采购机构,资产的调拨、盘点、领用等业务是围绕着采购组织进行的。

3、资产类型、资产二级分类、资产三级分类:
根据接口的判断规则,系统自动根据资产的分类判断资产类型,资产二级分类,资产三级分
注:“交通运输设备”中的“汽车用品”属于低值易耗品
4、资产的使用年限是和oracle同步后,由oracle回传。

5、使用部门、使用人是资产领用后NC资产卡片才会显示,所以在新增卡片的时候这2个
2)NC资产卡片字段生成:
1、费用类型,NC资产卡片的组织机构和固定资产一致不再赘述。

2、资产类型、资产二级分类、资产三级分类:
根据接口的判断规则,系统自动根据物料的分类判断资产类型,资产二级分类,资产
三级分类,这些字段是oracle生成的必填项,他们用于和oracle同步时的资产卡片生成。

3、oracle卡片编号、使用年限是和oracle同步后,由oracle回传。

4、除了以上比较特殊重要的字段外,其他剩余的资产基础信息字段例如规格、型号、资产名称、金额、供应商等都是由采购端自有的,他们直接从采购端同步过来。

3)资产卡片的业务流程:
当第一笔无形资产支付成功后,费控系统将支付成功信息反馈给采购系统。

采购系统根据记录了付款成功、是否上线、是否是无形资产、采购合同号等信息的付款单生成资产系统NC无形资产卡片。

同时NC资产卡片会记录采购系统的合同单号。

当采购端付款申请确认了是否上线之后,对应的资产系统会将无形资产卡片会自动同步到oracle系统中去。

当无形资产第二笔分期付款支付成功的时候,采购端根据付款信息自动生成资产系统已付金额变动单来调整原无形资产卡片的已付金额。

只有支付成功的单据才能调用已付金额变动单,若发生支付失败(退票)问题,费控系统将支付失败的信息回传给采购系统,采购系统调用已付金额变动单,单据中的金额为支付失败(退票)的负数,同时已付款变动单备注栏记录支付失败。

若第一笔金额支付退票,无形资产的卡片原值为0,原值为0的无形资产不能和oracle同步。

4)无形资产计提流程 当付款申请支付成功后,若用户在付款申请中确认了无形资产上线,资产系统将对应的资产卡片传往oracle 系统,oracle 进行已付金额的折旧。

3. 房产
1)NC 资产卡片生成:
房产在单项采购中采购,待采购合同生效后,采购合同自动推送NC 资产卡片的生成。

同时NC 资产卡片会记录采购合同号。

当确认房产投入使用后,由财务手动的将资产系统中
的房产卡片同步到oracle中,之后oracle会自动开始计提折旧。

2)NC资产卡片字段生成:
1、费用类型,NC资产卡片的组织机构和固定资产一致不再赘述。

2、资产类型、资产二级分类、资产三级分类:
根据接口的判断规则,系统自动根据物料的分类判断资产类型,资产二级分类,资产三级分类,这些字段是oracle生成的必填项,他们用于和oracle同步时的资产卡片生成。

3、oracle卡片编号、使用年限是和oracle同步后,由oracle回传。

4、除了以上比较特殊重要的字段外,其他剩余的资产基础信息字段例如规格、型号、资产名称、金额、供应商等都是由采购端自有的,他们直接从采购端同步过来。

3)资产卡片的业务流程:
采购合同审核通过后,采购合同自动推送NC资产卡片的生成。

采购端将付款申请发送到费控系统支付,当支付成功后费控系统生成“在建工程”的凭证,费控系统将支付成功的信息以及费控单号回传给采购系统中的付款单,然后付款申请推送生成房产卡片的已付金额变动单。

房产部分会存在装修费支出作为房产卡片的原值的一部分,针对这类问题,在装修合同中需标明是否是自有房产,如果是,系统会根据该装修生成对应房产的原值变动单。

2)NC资产卡片字段生成:
1、费用类型,NC资产卡片的组织机构和固定资产一致不再赘述。

2、资产类型、资产一级分类、资产二级分类:
根据接口的判断规则,系统自动根据物料的分类判断资产类型,资产二级分类,资产
3、oracle卡片编号、使用年限是和oracle同步后,由oracle回传。

4、除了以上比较特殊重要的字段外,其他剩余的资产基础信息字段例如规格、型号、
资产名称、金额、供应商等都是由采购端自有的,他们从采购端同步过来。

3)资产卡片的业务流程:
装修、租赁资产金额的合同金额来源于采购合同金额。

付款的时候,采购端将付款申请发送到费控系统支付,费控系统将支付成功的信息以及费控单号回传给采购系统,然后付款单推送生成装修、租赁资产卡片的已付金额变动单。

相关文档
最新文档