国际金融衍生品交易分析系统概述.doc

易盛国际金融衍生品交易分析系统API使用说明文件状态：正在修改3.0.1.0版本：完成日期：2013-12-26 易盛国际金融衍生品交易分析系统API使用说明文档变更日志API时间作者描述备注V3.0.1.02013-12-26API使用说明第一版 易盛国际金融衍生品交易分析系统API使用说明1系统简介. 3API介绍. 32体系结构. 42.1 API架构 . 42.2授权. 53开发接口. 63.1初始化阶段. 63.2功能调用阶段. 63.3授权码. 63.4 IEsunnyTradeSpi接口. 63.4.1 OnOpen方法. 73.4.2 OnClose()方法. 73.4.3 OnLogin方法 . 73.4.4 OnInitFinished方法. 83.4.5 OnLogOut方法 . 93.4.6 OnRspSetPassword方法 . 93.4.7 OnRspSetOperPassword方法 . 103.4.8 OnQryMoney方法 . 113.4.9 OnRtnMoney方法. 133.4.10 OnRspCashOperQry方法 . 133.4.11 OnRspCashAdjustQry方法. 153.4.12 OnRspOrderInsert方法 . 163.4.13 OnRspOrderModify方法 . 173.4.14 OnRspOrderDelete方法. 173.4.15 OnRspQryOrder方法. 183.4.16 OnRspHistOrderQry方法 . 193.4.17 OnRtnOrderState方法. 203.4.18 OnRtnOrderInfo方法. 213.4.19 OnRspMatchQry方法 . 223.4.20 OnRtnMatchState方法. 233.4.21 OnRtnMatchInfo方法 . 243.4.22 OnRspHistMatchQry方法. 253.4.23 OnQryHold方法. 263.4.24 OnRtnHold方法. 273.4.25 OnQryExchangeState方法. 273.4.26 OnRtnExchangeState方法 . 283.4.27 OnQryCommodity方法. 293.4.28 OnQryContract方法. 303.4.29 OnQryClient方法. 313.4.30 OnRspHistCashOperQry方法. 313.4.31 OnRspHistCashAdjustQry方法 . 323.4.32 OnRspAuthClient方法. 343.4.33 OnRspQryCurrency方法. 343.4.34 OnRtnExchangeRateMod方法. 35第 1页共 62页 易盛国际金融衍生品交易分析系统API使用说明3.4.35 OnRtnOrderRemove方法 . 363.4.36 OnRtnMatchRemove方法. 363.4.37 OnRtnCommodityState方法 . 373.4.38 OnRtnContractAdd方法 . 373.5 IEsunnyTradeApi接口 . 383.5.1 SetSpi方法 . 383.5.2 Free方法. 393.5.3 GetErrcodeDesc方法 . 393.5.4 Open方法. 393.5.5 Close方法. 403.5.6 IsOpen方法. 403.5.7 Login方法 . 403.5.8 LogOut方法 . 413.5.9 SetPassword方法 . 423.5.10 SetOperPassword方法 . 433.5.11 QryClients方法 . 433.5.12 QryMoney方法 . 433.5.13 QryOrder方法 . 433.5.14 QryMatch方法 . 443.5.15 QryHold方法 . 453.5.16 QryExchangeState方法. 463.5.17 QryCommodity方法 . 463.5.18 QryContract方法. 473.5.19 OrderInsert方法 . 483.5.20 OrderModify方法 . 493.5.21 OrderDelete方法. 493.5.22 QryHistOrder方法. 503.5.23 QryHistMatch方法. 503.5.24 QryCashOpera方法. 513.5.25 QryCachAdjust方法. 523.5.26 QryHistCashOpera方法. 523.5.27 QryHistCachAdjust方法. 533.5.28 AuthClient方法 . 533.5.29 QryCurrency方法. 543.5.30 GetCertCodeExpireDate方法. 543.6 extern C部分. 553.6.1 GetEsunnyForeignApiVersion方法 . 553.6.2 CreateEsunnyForeignTradeApi方法. 553.6.3 DelEsunnyForeignTradeApi方法 . 564开发示例. 56第 2页共 62页 易盛国际金融衍生品交易分析系统API使用说明1系统简介API介绍易盛公司的交易行情系统都是开放的平台。易盛为每个平台都专门提供了接入API(Application Programming Interface,应用程序编程接口)，开发者可以利用这些API，开发更适合自身业务需求的子系统。通过这些自我开发系统和易盛后台服务的无缝链接，满足个性化交易需求。交易API包括报单，改单，撤单，查询客户资金，查询客户委托，查询客户成交，查询成交，查询持仓，查询出入金，查询资金调整等功能。该API包含以下7个文件：文件名版本V1.0V1.0V1.0V1.0V1.0V1.0V1.0文件大小9KB文件描述定义API的错误代码定义API所用到的数据结构定义API所用的数据类型交易接口头文件EsForeignApiErrCode.hEsForeignApiStruct.hEsForeignApiType.hEsunnyForeignApi.hForeignTradeApi.dllForeignTradeApi.libForeignTradeApi.pdb26KB31KB30KB127KB3KB动态链接库导入库1371KB程序调试数据库第 3页共 62页 易盛国际金融衍生品交易分析系统API使用说明2 体系结构2.1 API架构易盛国际金融衍生品交易分析系统 API是通过向交易员提供一组函数，可以向交易后台发送数据或报送请求，再由交易后台返回或推送相关的数据信息，其基本架构如下：下面是 API的基本处理逻辑：第 4页共 62页 易盛国际金融衍生品交易分析系统API使用说明2.2授权为提高 API权限控制，必须申请得到相关的授权码，通过认证之后开发商才允许进行 API连接。并且可以在外盘系统的柜台下，有客户 API授权管理，可以对 API用户进行增加，修改，删除和查询操作。详细申请流程可参考 API申请流程文档。第 5页共 62页 易盛国际金融衍生品交易分析系统API使用说明3 开发接口3.1 初始化阶段在正式使用 API功能之前，需要对交易 API进行初始化。初始化操作包括：1，CreateEsunnyForeignTradeApi创建一个交易 API实例。2，SetSpi设置回调数据接口。3，Open连接交易服务器4，IsOpen获取是否与交易服务器建立连接5，Login登陆交易服务器，完成初始化阶段。3.2 功能调用阶段在功能调用阶段，用户可以通过 API，向易盛后台发送报单，改单，撤单，查询客户资金，查询客户委托，查询客户成交，查询成交，查询持仓，查询出入金，查询资金调整等请求，并获得相应的应答。3.3 授权码用户在创建 API实例的时候，传入申请的授权码之后，还需要在柜台配置一下对应的明文编号，才能正常登陆。3.4 IEsunnyTradeSpi接口IEsunnyTradeSpi接口实现了时间通知接口。用户必须派生 IEsunnyTradeSpi接口，编写事件处理方法来处理感兴趣的事件。具体的结构定义，类型定义和错误码参见 EsForeignApiStruct.h，EsForeignApiType.h和 EsForeignApiErrCode.h这三个头文件。第 6页共 62页 易盛国际金融衍生品交易分析系统API使用说明3.4.1 OnOpen方法与服务器建立连接时调用，此时还未登陆。函数原形：void _cdecl OnOpen()；参数：无返回值： void3.4.2 OnClose() 方法与服务器断开连接时调用函数原形：void _cdecl OnClose()；参数：无返回值：无3.4.3 OnLogin方法发送 Login登陆成功时收到服务器登陆响应调用函数原形：void _cdecl OnLogin(const TEsLoginRspField* rsp , int errCode , constint iReqID)；参数：rsp :返回用户登录信息的地址登录应答结构struct TEsLoginRspField/是否 CA认证TIsCaLoginTypeIsCaLogin;第 7页共 62页 易盛国际金融衍生品交易分析系统API使用说明/是否强制修改密码TIsForcePasswordType/登录号IsForcePwd;TLoginNoTypeLoginNo;/登录端帐号简称TLoginNameTypeLoginName;/客户预留信息,客户自己识别后台系统TReservedInfoType/上次登录时间TDateTimeType/上次登出时间TDateTimeType/上次登录 ipReservedInfo;LastLoginDateTime;LastLogoutDateTime;LastLoginIp;TIpType/上次登录 portTPortTypeLastLoginPort;LastLoginMachineInfo;ServerDateTime;/上次登录机器信息TMachineInfoType/系统当前时间(客户端校时)TDateTimeType;errCode:返回的错误代码，当 errCode=0，表示登陆成功（详细可查错误代码表）。iReqID:返回用户登录请求的 ID，对应发送请求的 ID。返回值：无3.4.4 OnInitFinished方法发送 Login成功后，收到 OnLogin应答成功后收到初始化操作完成。所有的业务操作需要在本响应 errCode为 0（成功）后可进行函数原形：void _cdecl OnInitFinished(int errCode);参数：第 8页共 62页 易盛国际金融衍生品交易分析系统API使用说明errCode返回初始化过程中的错误码（详细可查错误代码表）。返回值：无3.4.5 OnLogOut方法收到登出应答调用函数原形：void _cdecl OnLogOut(int errCode , const int iReqID);参数：errCode :返回登出过程的错误码，当 errCode等于 0的时候，表示正常退出。iReqID :返回用户登出请求的 ID，对应发送请求的 ID。返回值：无3.4.6 OnRspSetPassword方法修改客户密码时调用函数原形：void _cdecl OnRspSetPassword(const TEsClientPasswordModifyRspField*rsp ,int errCode , const int iReqID);参数：rsp :返回信息包括客户号和修改的密码类型，其中密码类型包含修改的密码是交易密码，行情密码，还是认证密码。客户密码修改应答结构struct TEsClientPasswordModifyRspField第 9页共 62页 易盛国际金融衍生品交易分析系统API使用说明/客户号TClientNoType/密码类型TPasswordTypeType;ClientNo;PasswordType;errCode :返回修改密码时的错误码，当 errCode等于 0的时候，表示修改成功。iReqID :返回用户登出请求的 ID，对应发送请求的 ID。返回值：无3.4.7 OnRspSetOperPassword方法修改操作员密码时应答函数原形：void _cdecl OnRspSetOperPassword(const TEsOperatorPasswordModifyRspField* rsp,int errCode, const int iReqID)；参数：rsp:返回操作员号操作员密码修改应答结构struct TEsOperatorPasswordModifyRspField/操作员号TOperatorNoTypeOperatorNo;第 10页共 62页 易盛国际金融衍生品交易分析系统API使用说明;errCode :返回修改密码时的错误码，当 errCode等于 0的时候，表示修改成功。iReqID :返回用户登出请求的 ID，对应发送请求的 ID。返回值：无3.4.8 OnQryMoney方法资金查询的应答，可以用来获得对应客户号下的今资金，今权益，今可提，手续费，保证金和出入金等资金状况。函数原形：void_cdeclOnQryMoney(constTEsMoneyQryRspField*rsp,TEsIsLastType islast, int errCode, const int iReqID)；参数：rsp:查询完成时，指针为空，未完成时包含查询结果。资金查询应答结构struct TEsMoneyQryRspFieldTClientNoTypeClientNo;CurrencyNo;YAvailable;YCanCashOut;YMoney;/客户号TCurrencyNoTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueType/货币编号/昨可用/昨可提/昨账面/昨权益YBalance;YUnExpiredProfit;Adjust;/昨未结平盈/资金调整/入金CashIn;CashOut;/出金Fee;/手续费第 11页共 62页 易盛国际金融衍生品交易分析系统API使用说明TMoneyValueTypeFrozen;/冻结资金/逐笔平盈/盯市平盈/逐笔浮盈/盯市浮盈/未结平盈/权利金TMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueType出入金 24(非自动汇兑资金)TMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueType;CoverProfit;DayCoverProfit;FloatProfit;DayFloatProfit;UnExpiredProfit;Premium;Deposit;/保证金KeepDeposit;Pledge;/维持保证金/质押资金/可用资金TAvailable;Discount;/贴现金额TradeFee;/交易手续费/交割手续费/汇兑手续费/冻结保证金/冻结手续费/浮盈(无 LME)/LME浮盈DeliveryFee;ExchangeFee;FrozenDeposit;FrozenFee;NewFloatProfit;LmeFloatProfit;OptionMarketValue;OriCash;/期权市值/币种原始TMoney;/今资金/今权益/今可提/风险率/账户市值TBalance;TCanCashOut;RiskRate;AccountMarketValue;Islast：指示是否查询完成，完成时 rsp指针为空errCode :返回查询资金时的错误码，当 errCode等于 0的时候，表示查询成功。iReqID :返回用户资金查询请求的 ID，对应发送请求的 ID。返回值：无第 12页共 62页 易盛国际金融衍生品交易分析系统API使用说明3.4.9 OnRtnMoney方法资金变化推送通知，能够获得客户号下资金变化的推送，包括资金调整，出入金，手续费和浮赢的推送。函数原形：void _cdecl OnRtnMoney(const TEsMoneyChgNoticeField& rsp)；参数：rsp：资金变化详细信息struct TEsMoneyChgNoticeFieldTClientNoTypeTCurrencyNoTypeu_shortClientNo;/客户号/货币编号CurrencyNo;MoneyChgNum;MoneyItem1;/资金变化项的个数/资金变化内容TMoneyChgItem;资金变化通知结构struct TMoneyChgItemTMoneyChgTypeTMoneyValueType;MoneyChg;MoneyValue;返回值：无3.4.10 OnRspCashOperQry方法出入金查询应答，可以查询到出入金状态，操作时间，操作人，出入金类型，出入金方式，货币编号，操作金额和审核时间等信息。函数原形：void _cdecl OnRspCashOperQry(const TEsCashOperQryRspField* rsp,TEsIsLastType islast, int errCode, const int iReqID);第 13页共 62页 易盛国际金融衍生品交易分析系统API使用说明参数：rsp:查询结果，查询完成时，指针为空出金入金查询应答结构struct TEsCashOperQryRspFieldTEsCashOperQryReqFieldTCashSerialIdTypeTCashStateTypeReqData;/查询请求数据/出入金流水号/出入金状态/操作时间/操作人SerialId;CashState;TDateTimeTypeOperDateTime;OperatorNo;CheckDateTime;CheckOperatorNo;TOperatorNoTypeTDateTimeType/审核时间/审核人TOperatorNoTypeTCashTypeTypeCashType;/出入金类型/出入金方式/货币编号/操作金额/备注TCashModeTypeTCurrencyNoTypeTMoneyValueTypeTCashRemarkTypeCashMode;CurrencyNo;CashValue;CashRemark;TBankTypeTAccountTypeTLWFlagTypeTBankTypeTAccountTypeTLWFlagType;ClientBank;/银行标识/银行账户ClientAccount;ClientLWFlag;CompanyBank;CompanyAccount;/本外币账户标识/银行标识/银行账户CompanyLWFlag; /本外币账户标识isLast:指示是否查询完成，完成时，rsp指针为空errCode:查询过程中错误码，为 0表示查询成功iReqID:对应发送请求的 ID返回值：无第 14页共 62页 易盛国际金融衍生品交易分析系统API使用说明3.4.11 OnRspCashAdjustQry方法资金调整查询应答，可以获得资金调整状态，操作时间，操作人，审核时间，资金调整类型和操作金额等信息。函数原形：void _cdecl OnRspCashAdjustQry(const TEsAdjustQryRspField* rsp,TEsIsLastType islast, int errCode, const int iReqID);参数：rsp:查询结果，查询完成时，指针为空资金调整查询应答结构struct TEsAdjustQryRspFieldTEsAdjustQryReqFieldTAdjustSerialIdTypeTAdjustStateTypeTDateTimeTypeReqData;/查询请求数据/出入金流水号/资金调整状态/操作时间SerialId;AdjustState;OperDateTime;OperatorNo;CheckDateTime;CheckOperatorNo;TOperatorNoTypeTDateTimeType/操作人/审核时间TOperatorNoType/审核人TAdjustTypeTypeTCurrencyNoTypeTMone