安裝元大證券 OneAPI

1.向[元大證券]申請開通OneAPI權限

元大提供很多套API,GSnail目前支援的是元大證券的OneAPI(因為功能較其他API多),但申請程序較麻煩(不像元大期貨的QAPI只要線上簽署即可使用),用戶在申請時請務必告知營業員或櫃檯服務人員要一併開通OneAPI的期貨下單權限(因為是元大證券的單位,申請OneAPI通常只幫你開通OneAPI的報價和證券下單功能,不會主動幫你開OneAPI的[期貨下單]功能)。另外,元大證券申請API前,必須先在測試程式下單並上傳測試記錄,所以請先到元大證券官網,輸入帳號密碼登入後,把滑鼠游標移到[台股]選項上面暫停,等出現下面選單後點選[API下單]

選擇元大API下單

接下來,會連到API下單的網頁,您可以看到兩個下載選項[API測試軟體]與[API交易元件],分別按滑鼠右鍵另存連結將這兩個檔案(setup.exe 和 b2bapi_user_docs.zip)下載回來,因為檔案含執行檔,瀏覽器可能會出現安全選項詢問選擇保留即可

下載API測試軟體與API交易元件

接下來請執行下載回來的API測試軟體 setup.exe,請輸入身分證號和網路密碼後按[登入]按鈕

API測試軟體

登入後,接下來的畫面按[下單]按鈕即可完成上傳測試記錄動作

API測試軟體_下單

完成上述動作後,請通知營業員協助開始申請程序,並等候幾天等營業員告知API權限開通。

2.測試OneAPI交易元件功能權限是否開通

當營業員通知您API權限已經開通後,接下來請把下載回來的API元件(b2bapi_user_docs.zip)解壓縮,然後點進去[YuantaOneAPI_User_Docs]目錄,裡面會有一隻執行檔YuantaOneAPI_TestAP.exe請開啟該執行檔測試您的API權限是否開通

API測試程式

先輸入您的證券帳號,密碼,選擇[正式環境]後,先按[Open]按鈕,再按[登入(Login)]按鈕,如果有開通權限會傳回上面畫面中紅色框框內容資訊(帳號筆數:1 然後 S證券帳號,姓名,身分證號,667,),接下來,請接著測試期貨帳號是否開通權限,將帳號種類改成F,輸入期貨帳號,再按一次登入[登入(Login)]按鈕,如果期貨下單權限有成功開通會看到下面畫面紅色框框的資訊(帳號筆數:1 然後 F期貨帳號,姓名,身分證號,667,),反之若輸入錯誤或權限未開通會看到(00112,無此權限使用此功能)資訊
API測試程式_測試期貨權限開通

如果您的API權限有成功開通,可以進行接下來步驟,否則請聯絡您的營業員協助開通API權限

3.複製API元件DLL到GSnail安裝目錄中

請開啟【YuantaOneAPI_User_Docs】目錄,在檔案目錄中選取全部副檔名為dll的檔案,將其複製到GSnail的安裝目錄中(預設為C:\Program Files (x86)\GSnail程式\GSnail)

複製元大API元件DLL檔

4.設定GSnail報價下單模組

開啟GSnail程式點選設定,在設定畫面左側選擇[報價下單模組],先在歸戶帳號位置輸入身分證號,元大的OneAPI必須設定證券帳號和期貨帳號(如果您只開通證券帳號請把期貨帳號留空白),報價模組與下單API請選擇最新版本的[元大OneAPI報價API]和[元大OneAPI下單API],設定完成後可以按[連線測試]測試是否可以正常連線API
(之前安裝1.0.7版API 請於2022-02-25前到元大官網下載新版API元件 並重覆第3步驟,然後API請改選擇1.0.8版)

設定元大報價下單模組