國際金融衍生品交易分析系統(tǒng)概述

1、 易盛國際金融衍生品交易分析系統(tǒng)API使用說明文件狀態(tài)：正在修改3.0.1.0版本：完成日期：2013-12-26 易盛國際金融衍生品交易分析系統(tǒng)API使用說明文檔變更日志API時間作者描述備注V3.0.1.02013-12-26API使用說明第一版 易盛國際金融衍生品交易分析系統(tǒng)API使用說明1系統(tǒng)簡介. 3API介紹. 32體系結(jié)構(gòu). 42.1 API架構(gòu) . 42.2授權(quán). 53開發(fā)接口. 63.1初始化階段. 63.2功能調(diào)用階段. 63.3授權(quán)碼. 63.4 IEsunnyTradeSpi接口. 63.4.1 OnOpen方法. 73.4.2 OnClose()方法. 73.4.3

2、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 OnRspOrd

3、erDelete方法. 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 OnQryExcha

4、ngeState方法. 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頁 易盛國際金融衍生

5、品交易分析系統(tǒng)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 L

6、ogOut方法 . 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方法

7、 . 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"部分. 5

8、53.6.1 GetEsunnyForeignApiVersion方法 . 553.6.2 CreateEsunnyForeignTradeApi方法. 553.6.3 DelEsunnyForeignTradeApi方法 . 564開發(fā)示例. 56第 2頁共 62頁 易盛國際金融衍生品交易分析系統(tǒng)API使用說明1系統(tǒng)簡介API介紹易盛公司的交易行情系統(tǒng)都是開放的平臺。易盛為每個平臺都專門提供了接入API(Application Programming Interface,應(yīng)用程序編程接口)，開發(fā)者可以利用這些API，開發(fā)更適合自身業(yè)務(wù)需求的子系統(tǒng)。通過這些自我開發(fā)系統(tǒng)和易盛后臺服務(wù)的無縫鏈接

9、，滿足個性化交易需求。交易API包括報單，改單，撤單，查詢客戶資金，查詢客戶委托，查詢客戶成交，查詢成交，查詢持倉，查詢出入金，查詢資金調(diào)整等功能。該API包含以下7個文件：文件名版本V1.0V1.0V1.0V1.0V1.0V1.0V1.0文件大小9KB文件描述定義API的錯誤代碼定義API所用到的數(shù)據(jù)結(jié)構(gòu)定義API所用的數(shù)據(jù)類型交易接口頭文件EsForeignApiErrCode.hEsForeignApiStruct.hEsForeignApiType.hEsunnyForeignApi.hForeignTradeApi.dllForeignTradeApi.libForeignTrade

10、Api.pdb26KB31KB30KB127KB3KB動態(tài)鏈接庫導(dǎo)入庫1371KB程序調(diào)試數(shù)據(jù)庫第 3頁共 62頁 易盛國際金融衍生品交易分析系統(tǒng)API使用說明2 體系結(jié)構(gòu)2.1 API架構(gòu)易盛國際金融衍生品交易分析系統(tǒng) API是通過向交易員提供一組函數(shù)，可以向交易后臺發(fā)送數(shù)據(jù)或報送請求，再由交易后臺返回或推送相關(guān)的數(shù)據(jù)信息，其基本架構(gòu)如下：下面是 API的基本處理邏輯：第 4頁共 62頁 易盛國際金融衍生品交易分析系統(tǒng)API使用說明2.2授權(quán)為提高 API權(quán)限控制，必須申請得到相關(guān)的授權(quán)碼，通過認(rèn)證之后開發(fā)商才允許進(jìn)行 API連接。并且可以在外盤系統(tǒng)的柜臺下，有客戶 API授權(quán)管理，可以對

11、API用戶進(jìn)行增加，修改，刪除和查詢操作。詳細(xì)申請流程可參考 API申請流程文檔。第 5頁共 62頁 易盛國際金融衍生品交易分析系統(tǒng)API使用說明3 開發(fā)接口3.1 初始化階段在正式使用 API功能之前，需要對交易 API進(jìn)行初始化。初始化操作包括：1，CreateEsunnyForeignTradeApi創(chuàng)建一個交易 API實(shí)例。2，SetSpi設(shè)置回調(diào)數(shù)據(jù)接口。3，Open連接交易服務(wù)器4，IsOpen獲取是否與交易服務(wù)器建立連接5，Login登陸交易服務(wù)器，完成初始化階段。3.2 功能調(diào)用階段在功能調(diào)用階段，用戶可以通過 API，向易盛后臺發(fā)送報單，改單，撤單，查詢客戶資金，查詢客戶委托

12、，查詢客戶成交，查詢成交，查詢持倉，查詢出入金，查詢資金調(diào)整等請求，并獲得相應(yīng)的應(yīng)答。3.3 授權(quán)碼用戶在創(chuàng)建 API實(shí)例的時候，傳入申請的授權(quán)碼之后，還需要在柜臺配置一下對應(yīng)的明文編號，才能正常登陸。3.4 IEsunnyTradeSpi接口IEsunnyTradeSpi接口實(shí)現(xiàn)了時間通知接口。用戶必須派生 IEsunnyTradeSpi接口，編寫事件處理方法來處理感興趣的事件。具體的結(jié)構(gòu)定義，類型定義和錯誤碼參見 EsForeignApiStruct.h，EsForeignApiType.h和 EsForeignApiErrCode.h這三個頭文件。第 6頁共 62頁 易盛國際金融衍生品交

13、易分析系統(tǒng)API使用說明3.4.1 OnOpen方法與服務(wù)器建立連接時調(diào)用，此時還未登陸。函數(shù)原形：void _cdecl OnOpen()；參數(shù)：無返回值： void3.4.2 OnClose() 方法與服務(wù)器斷開連接時調(diào)用函數(shù)原形：void _cdecl OnClose()；參數(shù)：無返回值：無3.4.3 OnLogin方法發(fā)送 Login登陸成功時收到服務(wù)器登陸響應(yīng)調(diào)用函數(shù)原形：void _cdecl OnLogin(const TEsLoginRspField* rsp , int errCode , constint iReqID)；參數(shù)：rsp :返回用戶登錄信息的地址登錄應(yīng)答結(jié)構(gòu)s

14、truct TEsLoginRspField/是否 CA認(rèn)證TIsCaLoginTypeIsCaLogin;第 7頁共 62頁 易盛國際金融衍生品交易分析系統(tǒng)API使用說明/是否強(qiáng)制修改密碼TIsForcePasswordType/登錄號IsForcePwd;TLoginNoTypeLoginNo;/登錄端帳號簡稱TLoginNameTypeLoginName;/客戶預(yù)留信息,客戶自己識別后臺系統(tǒng)TReservedInfoType/上次登錄時間TDateTimeType/上次登出時間TDateTimeType/上次登錄 ipReservedInfo;LastLoginDateTime;Last

15、LogoutDateTime;LastLoginIp;TIpType/上次登錄 portTPortTypeLastLoginPort;LastLoginMachineInfo;ServerDateTime;/上次登錄機(jī)器信息TMachineInfoType/系統(tǒng)當(dāng)前時間(客戶端校時)TDateTimeType;errCode:返回的錯誤代碼，當(dāng) errCode=0，表示登陸成功（詳細(xì)可查錯誤代碼表）。iReqID:返回用戶登錄請求的 ID，對應(yīng)發(fā)送請求的 ID。返回值：無3.4.4 OnInitFinished方法發(fā)送 Login成功后，收到 OnLogin應(yīng)答成功后收到初始化操作完成。所有的

16、業(yè)務(wù)操作需要在本響應(yīng) errCode為 0（成功）后可進(jìn)行函數(shù)原形：void _cdecl OnInitFinished(int errCode);參數(shù)：第 8頁共 62頁 易盛國際金融衍生品交易分析系統(tǒng)API使用說明errCode返回初始化過程中的錯誤碼（詳細(xì)可查錯誤代碼表）。返回值：無3.4.5 OnLogOut方法收到登出應(yīng)答調(diào)用函數(shù)原形：void _cdecl OnLogOut(int errCode , const int iReqID);參數(shù)：errCode :返回登出過程的錯誤碼，當(dāng) errCode等于 0的時候，表示正常退出。iReqID :返回用戶登出請求的 ID，對應(yīng)發(fā)送請

17、求的 ID。返回值：無3.4.6 OnRspSetPassword方法修改客戶密碼時調(diào)用函數(shù)原形：void _cdecl OnRspSetPassword(const TEsClientPasswordModifyRspField*rsp ,int errCode , const int iReqID);參數(shù)：rsp :返回信息包括客戶號和修改的密碼類型，其中密碼類型包含修改的密碼是交易密碼，行情密碼，還是認(rèn)證密碼?？蛻裘艽a修改應(yīng)答結(jié)構(gòu)struct TEsClientPasswordModifyRspField第 9頁共 62頁 易盛國際金融衍生品交易分析系統(tǒng)API使用說明/客戶號TClien

18、tNoType/密碼類型TPasswordTypeType;ClientNo;PasswordType;errCode :返回修改密碼時的錯誤碼，當(dāng) errCode等于 0的時候，表示修改成功。iReqID :返回用戶登出請求的 ID，對應(yīng)發(fā)送請求的 ID。返回值：無3.4.7 OnRspSetOperPassword方法修改操作員密碼時應(yīng)答函數(shù)原形：void _cdecl OnRspSetOperPassword(const TEsOperatorPasswordModifyRspField* rsp,int errCode, const int iReqID)；參數(shù)：rsp:返回操作員號操

19、作員密碼修改應(yīng)答結(jié)構(gòu)struct TEsOperatorPasswordModifyRspField/操作員號TOperatorNoTypeOperatorNo;第 10頁共 62頁 易盛國際金融衍生品交易分析系統(tǒng)API使用說明;errCode :返回修改密碼時的錯誤碼，當(dāng) errCode等于 0的時候，表示修改成功。iReqID :返回用戶登出請求的 ID，對應(yīng)發(fā)送請求的 ID。返回值：無3.4.8 OnQryMoney方法資金查詢的應(yīng)答，可以用來獲得對應(yīng)客戶號下的今資金，今權(quán)益，今可提，手續(xù)費(fèi)，保證金和出入金等資金狀況。函數(shù)原形：void_cdeclOnQryMoney(constTEsM

20、oneyQryRspField*rsp,TEsIsLastType islast, int errCode, const int iReqID)；參數(shù)：rsp:查詢完成時，指針為空，未完成時包含查詢結(jié)果。資金查詢應(yīng)答結(jié)構(gòu)struct TEsMoneyQryRspFieldTClientNoTypeClientNo;CurrencyNo;YAvailable;YCanCashOut;YMoney;/客戶號TCurrencyNoTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyV

21、alueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueType/貨幣編號/昨可用/昨可提/昨賬面/昨權(quán)益YBalance;YUnExpiredProfit;Adjust;/昨未結(jié)平盈/資金調(diào)整/入金CashIn;CashOut;/出金Fee;/手續(xù)費(fèi)第 11頁共 62頁 易盛國際金融衍生品交易分析系統(tǒng)API使用說明TMoneyValueTypeFrozen;/凍結(jié)資金/逐筆平盈/盯市平盈/逐筆浮盈/盯市浮盈/未結(jié)平盈/權(quán)利金TMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMon

22、eyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMoneyValueType出入金 24(非自動匯兌資金)TMoneyValueTypeTMoneyValueTypeTMoneyValueTypeTMon

23、eyValueTypeTMoneyValueType;CoverProfit;DayCoverProfit;FloatProfit;DayFloatProfit;UnExpiredProfit;Premium;Deposit;/保證金KeepDeposit;Pledge;/維持保證金/質(zhì)押資金/可用資金TAvailable;Discount;/貼現(xiàn)金額TradeFee;/交易手續(xù)費(fèi)/交割手續(xù)費(fèi)/匯兌手續(xù)費(fèi)/凍結(jié)保證金/凍結(jié)手續(xù)費(fèi)/浮盈(無 LME)/LME浮盈DeliveryFee;ExchangeFee;FrozenDeposit;FrozenFee;NewFloatProfit;LmeFl

24、oatProfit;OptionMarketValue;OriCash;/期權(quán)市值/幣種原始TMoney;/今資金/今權(quán)益/今可提/風(fēng)險率/賬戶市值TBalance;TCanCashOut;RiskRate;AccountMarketValue;Islast：指示是否查詢完成，完成時 rsp指針為空errCode :返回查詢資金時的錯誤碼，當(dāng) errCode等于 0的時候，表示查詢成功。iReqID :返回用戶資金查詢請求的 ID，對應(yīng)發(fā)送請求的 ID。返回值：無第 12頁共 62頁 易盛國際金融衍生品交易分析系統(tǒng)API使用說明3.4.9 OnRtnMoney方法資金變化推送通知，能夠獲得客戶

25、號下資金變化的推送，包括資金調(diào)整，出入金，手續(xù)費(fèi)和浮贏的推送。函數(shù)原形：void _cdecl OnRtnMoney(const TEsMoneyChgNoticeField& rsp)；參數(shù)：rsp：資金變化詳細(xì)信息struct TEsMoneyChgNoticeFieldTClientNoTypeTCurrencyNoTypeu_shortClientNo;/客戶號/貨幣編號CurrencyNo;MoneyChgNum;MoneyItem1;/資金變化項(xiàng)的個數(shù)/資金變化內(nèi)容TMoneyChgItem;資金變化通知結(jié)構(gòu)struct TMoneyChgItemTMoneyChgType

26、TMoneyValueType;MoneyChg;MoneyValue;返回值：無3.4.10 OnRspCashOperQry方法出入金查詢應(yīng)答，可以查詢到出入金狀態(tài)，操作時間，操作人，出入金類型，出入金方式，貨幣編號，操作金額和審核時間等信息。函數(shù)原形：void _cdecl OnRspCashOperQry(const TEsCashOperQryRspField* rsp,TEsIsLastType islast, int errCode, const int iReqID);第 13頁共 62頁 易盛國際金融衍生品交易分析系統(tǒng)API使用說明參數(shù)：rsp:查詢結(jié)果，查詢完成時，指針為空

27、出金入金查詢應(yīng)答結(jié)構(gòu)struct TEsCashOperQryRspFieldTEsCashOperQryReqFieldTCashSerialIdTypeTCashStateTypeReqData;/查詢請求數(shù)據(jù)/出入金流水號/出入金狀態(tài)/操作時間/操作人SerialId;CashState;TDateTimeTypeOperDateTime;OperatorNo;CheckDateTime;CheckOperatorNo;TOperatorNoTypeTDateTimeType/審核時間/審核人TOperatorNoTypeTCashTypeTypeCashType;/出入金類型/出入金方

28、式/貨幣編號/操作金額/備注TCashModeTypeTCurrencyNoTypeTMoneyValueTypeTCashRemarkTypeCashMode;CurrencyNo;CashValue;CashRemark;TBankTypeTAccountTypeTLWFlagTypeTBankTypeTAccountTypeTLWFlagType;ClientBank;/銀行標(biāo)識/銀行賬戶ClientAccount;ClientLWFlag;CompanyBank;CompanyAccount;/本外幣賬戶標(biāo)識/銀行標(biāo)識/銀行賬戶CompanyLWFlag; /本外幣賬戶標(biāo)識isLast

29、:指示是否查詢完成，完成時，rsp指針為空errCode:查詢過程中錯誤碼，為 0表示查詢成功iReqID:對應(yīng)發(fā)送請求的 ID返回值：無第 14頁共 62頁 易盛國際金融衍生品交易分析系統(tǒng)API使用說明3.4.11 OnRspCashAdjustQry方法資金調(diào)整查詢應(yīng)答，可以獲得資金調(diào)整狀態(tài)，操作時間，操作人，審核時間，資金調(diào)整類型和操作金額等信息。函數(shù)原形：void _cdecl OnRspCashAdjustQry(const TEsAdjustQryRspField* rsp,TEsIsLastType islast, int errCode, const int iReqID);參

30、數(shù)：rsp:查詢結(jié)果，查詢完成時，指針為空資金調(diào)整查詢應(yīng)答結(jié)構(gòu)struct TEsAdjustQryRspFieldTEsAdjustQryReqFieldTAdjustSerialIdTypeTAdjustStateTypeTDateTimeTypeReqData;/查詢請求數(shù)據(jù)/出入金流水號/資金調(diào)整狀態(tài)/操作時間SerialId;AdjustState;OperDateTime;OperatorNo;CheckDateTime;CheckOperatorNo;TOperatorNoTypeTDateTimeType/操作人/審核時間TOperatorNoType/審核人TAdjustTypeTypeTCurrencyNoTypeTMon