接口规则说明书

上海证券交易所技术文档上海证券交易所市场端软件使用和登录规范说明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
复当前记录的浏览状态

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接口文档版本(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是在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地址。

报文，删除“交易类型”字段，增加“查
询类型”字段
扈浩
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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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":"中央美术学院"}]。

系统概述 .....................................................................................................................................5 PROP数据交换系统的概念 ...................................................................................................5 PROP数据交换系统的组成 ...................................................................................................6 PROP数据交换系统的特点 ...................................................................................................7
初始化环境函数PROP_InitEnv............................................................................................19 2. 连接PMX函数PROP_Connect..............................................................................................20 3. 发送函数PROP_ Send ..........................................................................................................21 4. 接收函数PROP_Recv ...........................................................................................................23 5. 侦听函数PROP_ Listen ........................................................................................................24 6. 接受连接函数PROP_ Accept................................................................................................26 7. 关闭连接函数PROP_ Close .................................................................................................26 8. 释放环境函数PROP_ FreeEnv.............................................................................................27 9. 释放函数PROP_ Free...........................................................................................................27 10. 检测函数PROP_ Ping.......................................................................................................28 11. 连接句柄I/O状态检测函数PROP_ Select .......................................................................29

政务数据API接口使用说明书（文件类）北京市政务数据资源网2019.5版本号：1.2目录1接口概述- 1 -2接口使用流程- 1 -2.1选择数据- 1 -2.2查看数据详细信息- 1 -2.3查看API接口说明文档- 2 -2.4登录用户个人中心- 2 -2.5获取API唯一标识码（key）- 3 -2.6使用接口- 4 -3接口调用规范- 4 -3.1接口描述- 4 -3.2请求方式- 4 -3.3接口组成- 4 -3.4数据返回- 4 -3.5完整URL - 4 -3.6输入参数- 5 -3.7输出参数- 5 -4接口调用示例- 5 -4.1输入示例- 5 -4.2输出示例- 5 -1接口概述静态文件类API接口是北京市政务数据资源网面向企业、开发者等用户，通过web方式获取北京市政务数据资源网静态文件的接口。

2接口使用流程2.1选择数据进入网站首页，通过“数据→按主题”或“数据→按机构”选择需求数据。

图1 选择数据资源2.2查看数据详细信息点击数据名称进入此数据“接口→使用说明”页面。

图2 数据详细信息页面2.3查看API接口说明文档点击“API下载”按钮查看此接口说明文档。

图3 接口说明文档2.4登录用户个人中心登录网站进入用户“个人中心”。

（如无帐号，需进行注册）图4 用户个人中心2.5获取API唯一标识码（key）点击进入“API唯一标识码”栏目，获取用户API唯一标识码（key）。

图5 API唯一标识码特别提示：API唯一标识码（key）用于调用本站API接口时进行身份认证，包含您的个人身份信息，请勿转告他人，以免影响您正常使用本站API接口。

2.6使用接口使用API唯一标识码（key），依据数据“接口说明文档”使用本网站静态文件类API接口。

（接口调用规范详见下章）3接口调用规范规范用于指导用户合理调用网站静态文件。

3.1接口描述本接口返回特定的静态文件下载链接。

3.2请求方式本接口请求方式为基于http的get方式。

2.3
为说明数据流向描述功能模块实现对应需求的数据流程图,说明数据经过处理后的输出传输情况。可选
3
3.1
综述WebService接口相关的技术，如简介认证、压缩、数据规约及需要描述的一些规定等，根据需要增加下级目录说明，下述目录为建议性.1.2
本节可根据需要增删。
说明认证机制
3.1.3
说明格式约定等
3.2
如提供给银行的“查询电费”功能，一些需要说明的信息在此说明;如果功能比较复杂，可以根据需要设立下级子功能的目录结构。Webservice服务的使用表格描述。
3.2.1
如果功能简单，此级目录可以不要，使用Webservice服务表格描述。
Webservice接口服务表格如下:
修改编号
更改时间
更改的
图表和章节号
更改简要描述
更改人
批准人
注：更改人除形成初稿，以后每次修改在未批准确认前均需采用修订的方式进行修改。
1
1.1
无相关图表的章节中，可自行根据需要加入图表说明，下同。
要达到的目的简述，例如说明需要支持的功能目标等。
1.2
文档的适用范围，比如是在全公司适用还是在某个产品部适用等。预期的读者是哪些等。
方法名称
说明服务的CODE和名称
描述
发布路径
输入参数
参数代码
参数名称
数据类型
参数说明
输出参数
参数代码
参数名称
数据类型
参数说明
错误信息
部署情况
示例
使用开发代码举例说明如何调用
1.3
列出本文件中用到的专门术语的定义，例如中间库在本项目中的的含义，如果没有需特别要说明的，可删除此章节

1.1.1连接服务器接口
1.1.1.1接口功能
客户端检测服务端是否可达.
接口采用webservice技术。当客户端需要连接服务端并确保连接可达时,将通过webservice的方式向服务器发送检测请求，服务端响应客户端的请求，把处理结果返回给客户端。
接口调用方法为http：//url/isServerAvailable.
String
32
timestamp
时间戳,用于防重放攻击
String
18
1.1.1.3应答参数
接口参数说明如下：
名称
说明
数据类型
长度（字节）
result
结果:
1：成功
-1：失败
-2：参数错误
—3:hashCode错误
Int
1
info
返回结果的说明,该字段可选
String
128
hashCode
把所有的简单类型的字段按顺序组合后+key计算md5
方法名：isServerAvailable
1.1.1.2请求参数
包含的参数说明如下：
名称
说明
数据类型
长度(字节)
loginName
接口验证账号
String
30
loginPwd
接口验证密码
String
30
hashCode
除loginName，loginPwd，hashCode外的所有字段+Key 组合后计算md5
String
32
timestamp
时间戳，用于防重放攻击
String
18

专芯发展•用芯服务•创芯未来产品特点●300µA 供电电流●确保最大120Kbps 数据传输率●确保最小3V/µs 压摆率●增强的ESD 规范：•IEC61000-4-2标准中±15kV 空气放电标准•IEC61000-4-2标准中±8kV 接触放电标准●可使用SOP-16和TSSOP-16封装产品应用●电池供电设备●掌上设备●周边设备●数据通信设备产品概述CBM3232是一种基于EIA/TIA-232标准和V.28/V.24标准的通讯接口，其供电电压为3.3V、具有低功耗需求，高数据传输率能力。

CBM3232有两个接收器和一个驱动器。

该设备可以确保以RS-232标准输出电平水平的情况下以120Kbps 数据传输率运行。

典型应用包括笔记本计算机、轻型便携掌上电脑、电池供电的设备、手持式设备、电子周边设备和打印机。

专芯发展•用芯服务•创芯未来目录产品特点..........................................................................................................................................1产品应用..........................................................................................................................................1产品概述..........................................................................................................................................1目录..................................................................................................................................................2引脚配置..........................................................................................................................................3引脚描述..........................................................................................................................................3绝对最大额定参数..........................................................................................................................4电气特性..........................................................................................................................................5逻辑输入电气特性..........................................................................................................................5发送电气特性..................................................................................................................................5应用电路..........................................................................................................................................7电容值(µF).....................................................................................................................................7典型运行特性..................................................................................................................................8静电保护..........................................................................................................................................9封装尺寸及结构............................................................................................................................12SOP-16......................................................................................................................................12TSSOP-16..................................................................................................................................13包装/订购信息.. (14)引脚配置引脚描述绝对最大额定值符号参数值单位V CC供电电压-0.3至6V V+复合终端电压(VCC-0.3)至7VV-反向终端电压0.3至-7VV++|V-|13V T IN发送器输入电压范围-0.3至6VR IN接收器输入电压范围±25V T OUT发送器输出电压范围±13.2V R OUT接收器输出电压范围-0.3to(VCC+0.3)VT a工作温度-40至85℃Ts储存温度-65至150℃t SHORT发送器输出短路接地时间持续*超出上述绝对最大额定值可能会导致器件永久性损坏。

西部数码A P I接口说明文档The documentation of WEST263 API(Application Programming Interface)版本号：v2.0作者: 西部数码发行日期：2015/1/25命令索引目录上传域名实名认证文件 (5)1．API接口地址 (7)2．参数说明 (7)2．1公共参数 (7)一、虚拟主机相关 (9)1.1开通正式/试用虚拟主机 (9)1.2修改FTP密码 (10)1.3主机续费 (10)1.4试用主机转正 (11)1.5主机升级 (11)1.6获取FTP密码 (12)1.7判断FTP是否使用 (13)1.8获取主机相关信息 (13)1.9虚拟主机绑定域名 (15)2.10删除绑定域名 (15)2.11虚拟主机流量充值 (16)2.22开通赠送MYSQL数据库 (16)二、域名相关接口 (17)2.1注册域名 (17)2.2修改域名密码 (20)2.3续费域名 (21)2.4开通URL转发 (21)2.5域名查询接口 (22)2.6添加域名解析记录 (22)2.7修改域名解析记录 (23)2.8删除域名解析记录 (24)2.9列举域名解析记录 (24)2.10提交域名转入 (25)2.11查询域名转入状态 (26)2.12修改域名DNS (27)2.13获取域名信息 (28)2.14上传域名实名认证文件 (29)2.15获取CN域名上传状态 (31)2.16获取域名资料上传状态 (32)三、数据库相关接口 (32)3.1开通赠送数据库 (32)3.2开通正式的数据库 (33)3.3修改数据库密码 (34)3.4续费数据库 (35)3.5试用转正 (35)四、邮局相关接口 (37)4.1开通收费/试用邮局 (37)4.2修改邮局密码 (37)4.3邮局续费 (38)五、其他功能 (39)5.1获取产品对应的机房列表 (39)5.2获取产品列表 (39)5.3获取FTP密码 (40)5.4获取邮局密码 (41)5.5获取数据库密码 (41)5.6获取可用金额 (42)5.7获取域名密码 (42)5.8升级企业邮局 (43)5.9升级数据库 (44)5.10申请发票 (44)5.11试用邮局转正 (45)5.12虚拟主机业务同步 (46)5.13域名业务同步 (48)5.14企业邮局业务同步 (49)5.15数据库业务同步 (50)5.16同步所有业务的密码 (51)5.17接口测试 (52)5.18获取成本价 (52)5.19获取虚拟主机产品的操作系统列表 (53)5.20获取业务到期时间 (54)5.21判断FTP是否存在 (54)5.22获取所有产品赠品信息 (55)5.23提交有问必答 (56)5.24获取有问必答内容 (57)5.25获取产品价格（域名，虚拟主机，邮局） (58)5.26获取VPS机房价格 (58)5.27获取VPS服务器机房参数 (59)5.28获取主站业务开通日志 (60)六、套餐云主机、VPS相关 (60)6.1云主机添加 (60)6.2主机续费 (63)6.3变更基本信息 (63)6.4主机升级 (64)七、其他函数 (66)7.1获取VPS或套餐云的机房信息 (66)7.2获取主机升级参数 (66)7.3查询虚拟主机购买的独立IP (68)八、弹性云主机 (70)8.1购买弹性云主机 (70)8.2弹性云主机升级 (72)8.3弹性云主机转正 (73)8.4云主机续费 (74)8.5变更云主机的附加信息（可选功能） (74)8.6弹性云主机重启、开机、关机 (75)8.7弹性云主机的状态变化 (76)8.8弹性云备份操作 (76)8.9弹性更换线路 (77)8.10获取白名单列表 (78)8.12删除白名单 (79)8.13重装系统 (79)8.14购买IP (80)8.15获取主机相关信息 (81)8.16添加工单 (82)8.17获取工单服务列表 (83)8.18获取有问必答回复 (84)8.19修改操作系统管理员密码 (84)8.20获取性能数据 (85)8.21修改独立控制面板密码 (86)版本变更说明修改日期版本号修改说明2008-1-1 1.3西部数码发布第一版api接口：/CustomerCenter/doc/west263-API.doc2013-7-26 2.02.0新版api接口发布，采用新的接口地址，格式跟老版本不兼容。

快递鸟接口(API)技术文档1前言 (5)2接口规范说明 (5)2.1接口规范及说明 (5)2.1.1报文及报文编码 (5)2.1.2接口数据包结构 (5)2.1.3JSON示例 (6)2.1.4系统级参数 (6)2.1.5流程示意图 (7)2.2签名说明 (7)2.2.1关于签名 (7)2.2.2(C#)DataSign签名加密代码 (9)3下单类接口 (10)3.1接入步骤 (10)3.2预约取件接口 (11)3.2.1功能说明 (11)3.2.2基本信息 (11)3.2.3接口规则 (12)3.2.4支持情况 (12)3.2.5应用级参数 (12)3.2.6返回参数 (17)3.3预约取件取消接口 (17)3.3.1功能说明 (17)3.3.2基本信息 (17)3.3.3接口规则 (18)3.3.4支持情况 (18)3.3.5应用场景 (18)3.3.6应用级参数 (18)3.3.7返回参数 (19)3.4电子面单接口 (19)3.4.1功能说明 (19)3.4.2基本信息 (19)3.4.3应用场景 (20)3.4.4接口规则 (20)3.4.6应用场景 (21)3.4.7应用级参数 (21)3.4.8返回参数 (30)3.5电子面单取消接口 (35)3.5.1功能说明 (35)3.5.2基本信息 (36)3.5.3接口规则 (36)3.5.4支持情况 (36)3.5.5应用级参数 (36)3.5.6返回参数 (37)3.6电子面单追加子单接口 (37)3.6.1功能说明 (37)3.6.2基本信息 (37)3.6.3应用级参数 (38)3.6.4返回参数 (38)3.7获取电子面单文件接口 (39)3.7.1功能说明 (39)3.7.2基本信息 (39)3.7.3应用级参数 (39)3.7.4返回参数 (40)4轨迹查询类接口 (42)4.1即时查询接口 (42)4.1.1功能说明 (42)4.1.2基本信息 (42)4.1.3接口规则 (42)4.1.4支持情况 (42)4.1.5应用场景 (42)4.1.6应用级参数 (42)4.1.7返回参数 (43)4.2物流跟踪 (45)4.2.1轨迹订阅接口 (45)4.3单号识别接口 (64)4.3.1功能说明 (64)4.3.2基本信息 (64)4.3.3接口规则 (64)4.3.4应用级参数 (64)4.3.5返回参数 (65)5增值类接口 (66)5.1在途监控-国内版 (66)5.1.1即时查询接口(增值版) (66)5.1.2物流跟踪接口(增值版) (72)5.2快递查询接口 (78)5.2.1功能说明 (78)5.2.2基本信息 (78)5.2.3接口规则 (78)5.2.4支持情况 (78)5.2.5应用场景 (78)5.2.6应用级参数 (78)5.2.7返回参数 (79)5.3在途监控-国际版 (84)5.3.1物流跟踪接口(国际版) (84)5.4物流查询地图接口 (86)5.4.1即时查询接口(地图版) (87)5.4.2物流跟踪接口(地图版) (95)5.5短信服务 (100)5.5.1短信模板接口 (101)5.5.2短信发送接口 (103)5.5.3短信黑名单接口 (105)5.6智能地址解析接口 (106)5.6.1功能说明 (106)5.6.2基本信息 (106)5.6.3应用级参数 (106)5.6.4返回参数 (107)6附录 (109)6.1对接相关资料 (109)6.2电子面单模板规格 (109)6.3返回编码列表 (116)7技术支持 (117)1前言快递鸟API旨在为电商、电商平台、物流工具、打单工具、仓储系统、移动APP等系统提供专业、稳定、优质的API接口服务，满足不同用户的物流管理需求。

接口类型设计要求1.取得一
致性
类似的情
况应该有
让使用者
有一致性
的操作。

在提示、
选单与说
明文件
中，应该
采用同样
的名词。

并且保持
命令的一
贯性。

2.提供有
意义的回
馈
接口在调
用过程
中，所返
回的返回
值的必须
是有意义
和易于处
理的。

3.容错性
所有接口
在设计过
程中，必
须考虑到
全部的可
能产生的
错误并对
这些错误
做出处理
并体现在
返回值中。

所有接口
必须对传
入参数的
有效性进
行检查，
并体现于
返回值
中.
4.友好性
所有的接口中，必须对属性和方法做出
<summary >注释，便于调用者查阅5.安全性所有的接口模块，不允许开启异步的多线程，避免因为异步而产生的意外错误.。

上海证券交易所交易网关STEP接口规格说明书（竞价平台）V0.552023年4月文档版本日期版本说明2021-04-150.10创建文档。

2021-06-080.201.更新业务范围描述2.增加指定、撤指定业务相关接口3.更新应用消息内各接口的部分字段约束说明4.更新竞价平台标识为02021-07-050.301.更新指定撤指定、网络密码服务的SET分区信息2.配股、配转债包含成交确认3.更新ReportIndex的tag值2021-07-190.401.更新“申报拒绝”的MsgType2.更新“新订单申报”的字段描述3.更新“分区序号同步”的约束描述2021-12-010.501.更新“注册处理”和“网络密码服务”应用消息；2.更新“信用标签”的填写说明；3.新增错误码5016；4.更新OrdRejReason的类型为N5；5.更新“网络密码服务申报响应”消息；6.更新开放式基金分红设置取值；7.更新BCAN信息填写说明；8.更新结算会员代码填写说明；9.更新申报数量取值范围；10.更新网络密码服务申报ValidationCode填写说明；11.更新消息头的填写说明；12.更新订阅机制订阅数限制；13.更新branchID的填写说明；14.更新开放式基金转托管的填写说明；15.补充融资融券业务说明；16.补充“成交金额”的溢出场景说明；2022-02-110.511.补充“注册处理”消息流图；2.更新登录消息描述说明；2022-03-040.52 1.更新“成交金额”溢出场景的说明描述；2022-06-170.53 1.补充“TrdCnfmID（成交编号）”的填写说明；2023-01-040.541.补充“现金选择权”业务的申报填写说明；2.删除“指定登记”、“指定撤销”业务的申报填写说明；2023-04-070.551.修订新订单申报接口中“Price”、“OrdType”字段的填写说明；目录第一章前言 (5)1.1目的 (5)1.2术语和定义 (5)1.3参考文档 (5)1.4联系方式 (6)第二章系统简介 (7)2.1系统接入 (7)2.2业务范围 (7)第三章交互机制 (9)3.1会话机制 (9)3.1.1建立会话 (9)3.1.2关闭会话 (9)3.1.3维持会话 (10)3.1.4其他约定 (10)3.2申报与回报 (10)3.2.1业务类型 (11)3.2.2消息流图 (14)3.2.3平台状态 (18)3.2.4重复订单 (19)3.2.5执行报告 (20)3.3恢复场景 (22)3.4订阅机制 (22)第四章消息定义 (24)4.1消息结构与约定 (24)4.1.1数据类型 (24)4.1.2STEP格式约定 (25)4.1.3STEP消息头 (25)4.1.4STEP消息尾 (26)4.1.5STEP消息完整性 (26)4.2会话消息 (26)4.2.1登录消息（MsgType=A） (26)4.2.2注销消息（MsgType=5） (27)4.2.3心跳消息（MsgType=0） (28)4.2.4测试请求消息（MsgType=1） (28)4.2.5重发请求消息（MsgType=2） (29)4.2.6会话拒绝消息（MsgType=3） (29)4.2.7序号重设消息（MsgType=4） (29)4.3应用消息-新订单 (30)4.3.1新订单申报New Order Single (30)4.3.2撤单申报Order Cancel (35)4.3.3执行报告Execution Report (36)4.3.3.1申报响应、成交回报及撤单成功响应 (36)4.3.3.2撤单失败执行报告 (38)4.4应用消息-网络密码服务 (39)4.4.1网络密码服务申报 (39)4.4.1网络密码服务申报响应 (40)4.5其他消息 (42)4.5.1申报拒绝Order Reject (42)4.5.2平台状态PlatformState (42)4.5.3执行报告分区信息ExecRptInfo (42)4.5.4分区序号同步ExecRptSync (43)4.5.5分区序号同步响应ExecRptSyncRsp (43)4.5.6分区执行报告结束ExecRptEndOfStream (44)第五章附录 (45)5.1附一计算校验和 (45)5.2附二PBU及说明 (45)5.3附三错误代码说明 (46)5.4附四“用户私有信息”说明 (46)5.5附五价格数量字段说明 (47)5.6附六融资融券 (47)第一章前言1.1目的本接口规范描述了上海证券交易所（以下称本所）交易网关与市场参与者系统之间以STEP协议进行交易数据交换时所采用的交互机制、消息格式、消息定义和数据内容。