通达信接口官网分享如何编写api接口?
1、接口概述
接口概要介绍了接口文件中所包含的商业功能,所针对的对象,以及接口文件中所包含的业务接口,使读者能够直观地了解。
2、权限描述
有些接口调用要求有权限验证,这里需要解释。如果接口仅仅是根据指定的token验证,那么文件需要解释如何获得token。如果一个接口需要验证一个签名,那么在此必须给出一个特定的签名方式。
3、编码方式
在接口的要求过程中,可能会因为编码而产生混乱的代码,因此,接口需要协商如何进行编码。
4、请求说明
接口文件的请求描述中,主要包括接口请求的域名和请求的数据格式接口清单,这些都是接口文件的主要内容。在要求参数时,需要指出每一个参数的含义、类型和是否必须的特性。在接口回应的结果中,还必须说明是否存在商业域。
5、状态代码描述
接口的反应通常包含一个响应状态代码,比如成功,失败等等。状态代码可以帮助访问者判定接口呼叫的状态。
通达信接口调用结果说明:
相关函数 |
调用结果 |
Deinit Logoff |
无 |
Init |
返回值为 授权成功的交易账户数量 返回值 < 1 时, 无需调用 Deinit 接口, 也不能调用其它接口, 否则会出错! |
Logon |
调用成功: 返回值为 客户端 Id 调用失败: 返回值 <= 0 |
参数 ErrorInfo 保存错误信息, 需要分配 256 字节的空间 |
|
GetExpireDate |
返回值为 API 授权到期日期 |
格式为 yyyymmdd 整数, 如 2018 年 5 月 1 日为 20180501 |
|
单项操作 |
调用成功: ErrorInfo 为空字符串 |
QueryData |
调用失败: ErrorInfo 为错误信息 |
QueryHistoryData |
参数 Result 保存操作结果, 需要分配 1024*1024 字节的空间 |
SendOrder |
Result 格式为表格数据, 每一行通过换行符\n 分割,每一列通过制表符\t 分割 |
CancelOrder |
例子: |
GetQuote |
股东代码\t 股东名称\t 帐号类别\t 保留信息\n |
Repay |
12345678\t\t0\t 信息 1\n |
87654321\t\t2\t 信息 2 |
|
注: 不同券商返回的字段会有所不同 |
|
参数 ErrorInfo 保存错误信息, 需要分配 256 字节的空间 |
|
批量操作 |
批量操作的参数通过数组方式传入, 用下标区分每项操作 |
QueryDatas |
第 i 项操作调用成功: ErrorInfo[i]为空字符串 |
SendOrders |
第 i 项操作调用失败: ErrorInfo[i]为错误信息 |
CancelOrders |
参数 Result[]保存批量操作结果, Result[i]保存第 i 项操作结果 |
GetQuotes |
每项操作结果需要分配 1024*1024 字节的空间 |
QueryMultiAccountsDatas |
每项操作结果的格式可参阅[Result 格式] |
SendMultiAccountsOrders |
参数 ErrorInfo[]保存批量错误信息, ErrorInfo[i]保存第 i 项错误信息 |
CancelMultiAccountsOrders |
每项错误信息需要分配 256 字节的空间 |
GetMultiAccountsQuotes |
|
如果接口文件能够包含上述的步骤,那么它就是一个完整的接口文件,便于访问者进行阅读和了解。今天的内容分享到这了,关于对交易接口感兴趣的,联系下方qq了解交流。