立花証券・e支店・API専用ページ(v4.7-000 at 2025.05.31)
1.はじめに
2.リリース&改定情報
3.ご利用方法
4.ご利用にあたって
6.サンプルプログラム
7.その他
1.はじめに
1.目的
このページは立花証券・e支店システム(以下e支店と呼ぶ)の
アプリケーションプログラミングインタフェース(以下APIと呼ぶ)専用ページです。
本APIを利用することでご自分で作成したプログラムからe支店に注文発注ができます。
例えば、ご自分で注文受発注用の自動売買ロボットプログラム等を開発し、
プログラムから注文受発注を行うことが可能となります。
従来ブラウザでご利用いただいておりますe支店・PCブラウザ画面
(以下e支店・標準Webと呼ぶ)の操作による注文受発注機能を、
本APIを利用しプログラムにて行うことが可能となります。
APIのご利用は無料で個人や投資家の皆様に株価(4本値、板、
日足等過去約20年分を蓄積するヒストリカル情報など)、
日本株のニュース等の情報取得のためのインタフェース機能を提供します。
2.特徴
本APIの特徴としては、通常の要求&応答方式のAPI(以下 REQUEST I/F と呼ぶ)とは別に、
リアルタイム株価ボードシステムの開発で培ったノウハウを利用し
注文約定等通知データをリアルタイム配信するAPI(以下 EVENT I/F と呼ぶ)を合わせて兼ね備えている点です。
従来よくある REQUEST I/F のみのAPIの場合、
注文入力後に注文照会を何度も呼び出すことで約定したかどうかを確認する(ポーリング方式)必要があるめ
利用するにも手間がかかる上、システム的にも負荷がかかり、利用者もAPI提供側にも使いにくいAPIでした。
本APIではポーリング方式の欠点を克服するため導入した EVENT I/F を利用することで、
毎回APIを呼び出す(ポーリングする)ことなく
e支店システムから約定等通知をリアルタイム(イベント方式)で受信し
市場での約定等状態をいち早くプログラムで検知することが可能になります。
3.概要
本APIはインターネット経由でe支店システムのWebサーバに接続することで利用できます。
(1)認証 I/F
・プロトコル :HTTPS GET
・データ形式 :JSON
・日本語コード:ShiftJIS
(2)REQUEST I/F
・プロトコル :HTTPS GET
・データ形式 :JSON
・日本語コード:ShiftJIS
(3)EVENT I/F(HTTP Protocol 版)
・プロトコル :HTTPS GET (Chunk Responce)
・データ形式 :専用形式
・日本語コード:ShiftJIS
(4)EVENT I/F(WebSocket Protocol 版)、v4r7でリリース予定。
・プロトコル :HTTPS 1.1 GET (Handshake and Switching Protocols Responce) + WebSocket Protocol
・データ形式 :専用形式((3)準拠)
・日本語コード:ShiftJIS
※(4)は(3)と同情報を異 Protocol で取り扱うI/Fです。
※WebSocket Protocol の詳細は RFC 6455 等を参照。
4.提供機能
本APIでは以下機能を提供します。
(1)認証機能(認証 I/F)
・ログイン
・ログアウト
(2)業務機能(REQUEST I/F)
・株式新規注文
・株式訂正注文
・株式取消注文(含む一括取消)
・現物保有銘柄一覧
・信用建玉一覧
・買余力
・建余力&本日維持率
・売却可能数量
・注文一覧
・注文約定一覧(詳細)
・可能額サマリー
・可能額推移
・現物株式買付可能額詳細
・信用新規建て可能額詳細
・リアル保証金率
(3)マスタ機能(REQUEST I/F)
・マスタ情報ダウンロード
(
・システムステータス
・日付情報
・呼値
・運用ステータス別状態
・運用ステータス(株式)
・運用運用ステータス(派生)
・株式銘柄マスタ
・株式銘柄市場マスタ
・株式銘柄別・市場別規制
・先物銘柄マスタ
・オプション銘柄マスタ
・派生銘柄別・市場別規制
・代用掛目
・保証金マスタ
・取引所エラー等理由コード
)
・マスタ情報問合取得
(
・日付情報
・株式銘柄マスタ
・株式銘柄市場マスタ
・先物銘柄マスタ
・オプション銘柄マスタ
・その他(指数等)銘柄マスタ
・取引所エラー等理由コード
)
・ニュースヘッダー問合取得
・ニュースボディー問合取得
・銘柄詳細情報問合取得
・証金残情報問合取得
・信用残情報問合取得
・逆日歩情報問合取得
(4)時価情報機能(REQUEST I/F)
・時価情報問合取得
・蓄積情報問合取得
(5)注文約定通知(EVENT I/F)
・注文約定等通知
・e支店システム、システムステータス(開局、閉局等)
・e支店システム、運用ステータス(注文受付開始、終了等)
・リアルタイム株価ボード・時価
・リアルタイム株価ボード・ニュース
2.リリース&改定情報
2025.04.25 e支店・API(v4r7)リリース、(v4r5)廃止告知
機能追加に伴いe支店・API(v4r7)をリリース致します。
※本日よりデモ環境にて v4r7(及び v4r[56])がご利用頂けます。
本番環境へのリリース予定日は2025年05月31日(土)です。
スケジュール調整等により変更となる場合がありますので、
本ページ、及び、ログイン応答項目(e支店・APIリリース予定日)を逐次参照願います。
※EVENT I/F のご利用が無いお客様への影響は御座いません。
本バージョンは平行リリースのため、現行バージョン(v4r6)も継続利用可能(追加機能等は利用不可)ですが、
2025年08月以降廃止予定ですので、順次新バージョン(v4r7)への移行をお願いいたします。
なお、本記載内容は都合により変更となる場合がありますので、予めご了承願います。
1.EVENT I/F(WebSocket版)リリース。
詳しくは以下資料を参照願います。
・「立花証券・e支店・API(v4r7)、インタフェース概要(改定日:2025.05.31参照)
・「立花証券・e支店・API(v4r7)、EVENT I/F 利用方法、データ仕様」(改定日:2025.05.31参照)
・本HP、1.はじめに、3−(4)を追記。
EVENT I/F (WebSocket版)(以下本サービスと呼ぶ)の影響でサーバ負荷等、弊社で問題があると判断した場合
その他機能への影響を考慮し即座に本サービスを停止する場合が御座います。
本サービスを停止した場合でも現行 EVENT I/F(HTTP 版)は従来通りご利用頂けますので
本サービスの停止を考慮し、現行(HTTP 版)で代用できるよう予めご対応をお願いいたします。
2.EVENT I/F 配信共通項目仕様変更。
現在共通項目として全種別の通知に設定している p_err[no] 項目を通知種別(ST:ステータス通知)のみに変更。
詳しくは以下資料を参照願います。
・「立花証券・e支店・API(v4r7)、EVENT I/F 利用方法、データ仕様」(改定日:2025.05.31参照)
※対象は EVENT I/F(HTTP版、WebSocket版)共に同データ仕様となります。
3.仮想URL(EVENT-WebSocket版)追加
認証機能(認証I/F)・ログイン要求の応答項目に仮想URL(EVENT-WebSocket)を追加。
※詳しくは 「5.マニュアル」、該当機能説明を参照願います。
4.サンプルプログラム
・JSON 文字列の引数項目追加のためサンプルプログラム mfds_json_api_compress_v4r7.js を公開。
・基本利用方法(v4r7)・・・・・・・・・・・・・・・・・・・「6.サンプルプログラム」参照。
・時価情報取得表示(v4r7)・・・・・・・・・・・・・・・・・「6.サンプルプログラム」参照。
・EVENT I/F(WebSocket版)時価情報取得表示(v4r7)・・・・「6.サンプルプログラム」参照。
を先行公開いたします。
5.e支店・API(v4r5)、廃止
2025年01月29日のリリース告知通りv4r5を廃止致しますので新バージョンへの移行をお願いいたします。
※追加変更機能をご利用でない場合、通常はバージョン指定(v4r[56])を v4r7 に変更頂ければ移行できます。
2025.02.22 e支店・API(v4r6)、リリース
1.2025年01月29日のリリース告知通りv4r6をリリース。
新バージョン(v4r6)は平行リリースのため
旧バージョン(v4r5)も継続利用可能(追加機能等は利用不可)ですが、
2025年05月以降廃止予定ですので、順次、新バージョンへの移行をお願いいたします。
2025.01.29 e支店・API(v4r6)、リリース告知
機能追加に伴いe支店・API(v4r6)をリリース致します。
1.各種情報問合取得I/F追加。
・銘柄詳細情報問合取得(CLMMfdsGetIssueDetail)
・証金残情報問合取得(CLMMfdsGetSyoukinZan)
・信用残情報問合取得(CLMMfdsGetShinyouZan)
・逆日歩情報問合取得(CLMMfdsGetHibuInfo)
※詳しくは 「5.マニュアル」、該当機能説明を参照願います。
※「5.マニュアル」内からリンクしている各種資料は変更ありませんので
現行v4r5用の各種資料をご利用願います。
2.サンプルプログラム
・JSON 文字列の引数項目追加のためサンプルプログラム mfds_json_api_compress_v4r6.js を公開。
・基本利用方法(v4r6)・・・・・・「6.サンプルプログラム」参照。
・時価情報取得表示(v4r6)・・・・「6.サンプルプログラム」参照。
を先行公開いたします。
※本告知リリースと共に旧バージョン用のサンプルプログラムは廃止となります。
旧バージョンのサンプルプログラムをご利用の場合は以下リンクを参照願います。
・基本利用方法(v4r5)
・時価情報取得表示(v4r5)
リリース予定日は2025年02月22日(土)です。
スケジュール調整等により変更となる場合がありますので、
本ページ、及び、ログイン応答項目(e支店・APIリリース予定日)を逐次参照願います。
本バージョンは平行リリースのため、現行バージョン(v4r5)も継続利用可能(追加機能等は利用不可)ですが、
2025年05月以降廃止予定ですので、順次新バージョン(v4r6)への移行をお願いいたします。
なお、本記載内容は都合により変更となる場合がありますので、予めご了承願います。
**** 以下過去履歴 ****
2024.11.03 e支店・API(v4r5)、保守リリース
2024.03.31 e支店・API(v4r5)、保守リリース、EVENT I/F・通知項目追加。
2023.12.31 e支店・API(v4r5)、リリース、(v4r「34」)廃止
2023.12.15 e支店・API(v4r5)、デモ環境先行リリース
2023.10.02 e支店・API(v4r5)、リリース告知、新NISA(成長枠)対応
2023.07.22 e支店・API(v4r4)、リリース(2023.12.31 廃止)
2023.05.20 e支店・API(v4r3)、保守リリース、マスタダウンロード機能
2023.04.01 e支店・API(v4r2)、廃止
2022.11.19 e支店・API(v4r3)、リリース(2023.12.31 廃止)、(v4r1)廃止
2022.09.21 e支店・API(v4r2)、デモ環境、e支店・API(テスト環境)公開
2022.09.03 e支店・API(v4r2)、保守リリース、注文一括取消機能追加対応
2022.06.06 e支店・API(v4r2)、保守リリース、東証障害時対応
2022.04.02 e支店・API(v4r2)、保守リリース、東証再編対応
2021.10.15 e支店・API(v4r2)、保守リリース、EXECL(VBA) 利用サンプル公開
2021.06.27 e支店・API(v4r2)、リリース(2023.04.01 廃止)、(v4)廃止
2021.04.25 e支店・API(v4r1)、デモ環境、標準Web等画面(テスト環境)リリース
2021.02.13 e支店・API(v4r1)、リリース(2022.11.19 廃止)
2020.11.22 e支店・API(v3系)、廃止
2020.10.24 e支店・API(v4)、リリース(2021.06.27 廃止)
2020.09.26 e支店・API(v3r3)、リリース(2020.11.22 廃止)
2020.09.26 e支店・API(v3r2)、リリース(2020.11.22 廃止)
2020.08.21 e支店・API(v3)、リリース(2020.11.22 廃止)
2020.07.25 e支店・API(v2)、リリース(2020.08.21 廃止)
2020.07.14 e支店・API(v2)、立花証券・e支店・API専用ページ(本ページ)公開
2020.07.13 e支店・API(v2)(公開バージョン)開発
2020.06.29 e支店・API(v1)(実験バージョン)開発
3.ご利用方法
1.認証機能(認証 I/F)
認証用URLへe支店口座のログインID、パスワードを指定し認証要求を送信し結果を応答で受信します。
応答が正常の場合、4種類の仮想URL(REQUEST、MASTER、PRICE、EVENT)を返します。
応答がエラーの場合はエラーコードにより理由を判断します。
※各種書面(金商法交付書面等)が未読の場合、応答が正常でも仮想URLが発行されない(e支店・APIが利用できない)ため
標準Webにて既読操作をお願いいたします。
2.業務機能(REQUEST I/F)
本機能を利用する場合1.で取得した仮想URL(REQUEST)へ該当要求を送信し結果を応答で受信します。
※REQUEST I/F は一問一答(要求送信後応答を待ち次の要求を送信する)方式(利用者側での使い方に対する制限)となります。
※HTTP プロトコルを利用したインタフェースであるため、使い方により同時並列に要求は出せてしまいますが、
その場合の動作保証はできませんのでご注意下さい(ただし、3.(1)マスタ情報ダウンロードについては並列利用可能です)。
※以下各機能も3.(1)マスタ情報ダウンロードを除き基本同様です。
3.マスタ機能(REQUEST I/F)
本機能を利用する場合1.で取得した仮想URL(MASTER)へ該当要求を送信し結果を応答で受信します。
マスタ機能には以下機能があり利用方法が異なります。
・マスタ情報ダウンロード
・マスタ情報問合取得
弊社で発注可能な銘柄情報や各種規制情報、値幅情報等発注機能に関する各種付帯情報など
お客様が発注用アプリケーション等を構築され時に、予め入力チェック等に必要な情報の取得が本機能でできます。
※入力チェック等については本APIの注文入力各機能で実装のため、お客様のプログラムにてチェック機能の実装無しでも
本システムによりチェックを行いますが、本情報の取得により事前にお客様プログラムにてチェックすることも可能です。
(1)マスタ情報ダウンロード
本機能は通常の要求〜応答による手順とは異なり、要求後はダウンロード終了の通知まで
初期ダウンロードデータとして各種情報をレコード単位で通知します。
ダウンロード終了後は日中、弊社基幹システムで更新があった場合、該当情報を更新情報としてレコード単位で通知します。
※別紙「立花証券・e支店・API(v4r5)、インタフェース概要「3−4−1.マスタ情報ダウンロード」参照。
※マスタ情報ダウンロードはお客様の通信環境にもよりますが、弊社本番環境(社内からのアクセス)での計測では
約40秒くらいの時間がかかります。
(2)マスタ情報問合取得
本機能は取得対象のマスタ及び項目を指定し該当要求を送信し結果を応答で受信します。
※取得したい情報のみを指定し要求応答形式で取得できるため、取得時間短縮や保持リソースを必要な項目のみに抑えられます。
4.時価情報機能(REQUEST I/F)
本機能を利用する場合1.で取得した仮想URL(PRICE)へ該当要求を送信し結果を応答で受信します。
具体的には銘柄コード及び時価情報項目を複数指定することで、該当情報を問合取得することができます。
1要求では最大120までの銘柄コードが指定できます。
また指定取得できる時価情報項目は株価ボード・PC画面に表示している各項目になります。
5.注文約定通知(EVENT I/F)
本機能を利用する場合1.で取得した仮想URL(EVENT)へ該当要求を送信します。
その後はe支店システムとの接続を維持したまま受信待ちとし、e支店システムから通知データが送信される都度該当データを受信します。
※本I/Fは配信専用であるため、利用者側がデータを受信しない場合、e支店システムは送信できるまで待つ仕様です。
通知受信に関してはインターネットの経路、及び受信するハード性能に依存します(俗に言うところのベストエフォート送信です)。
※REQUEST I/F で注文入力要求、応答の送受信をした後 EVENT I/F でe支店システムからの注文受付等各種通知を送信する
シーケンスですが、e支店システムからお客様プログラムまでの間の通信環境やお客様プログラムの処理の都合により、
応答や通知を受信または処理する順番が逆になるケースが想定されますのでご注意ください。
※e支店・API(v3r2)よりリアルタイム株価ボードの時価通知機能をサポート(公開)致しましたが、
時価については間引き処理をしています。
また、お客様の通信環境等によりデータ受信が遅延する(時価が遅れて受信される)場合がありますので
予めご注意願います。
6.仮想URLについて
本API利用時は認証し仮想URLを取得する必要があります。
仮想URLはe支店システムで生成するe支店システム内でユニーク(重複しない)となります。
仮想URLは認証後毎回新たに作成すると共に、その時点で先認証で作成した仮想URLは無効とします(1顧客1仮想URL)。
仮想URLが無効になるタイミングは以下です。
・多重認証
・ログアウト
・e支店システム閉局
仮想URLは無効になると、それ以降ご利用でき(再度有効になり)ません。
無効となった仮想URLに要求した場合、応答でエラーを返します。
仮想URLは認証時、機能毎に4種類(仮想URL(REQUEST、MASTER、PRICE、EVENT))取得します。
仮想URL REQUEST, MASTER, PRICE は REQUEST I/F(プロトコル)、EVENT は EVENT I/F(プロトコル)で通信を行います。
REQUEST I/F と EVENT I/F は同時に(並列)利用できますが、無効化タイミングは同時です。
本APIは HTTP プロトコル でインタフェースする性質上、
仮想URLへのアクセスは通常のインターネットページの表示と同様、同時並列に要求を送信可能なインタフェースとなっています。
そのインタフェースは照会系機能についての性質であり、サーバへデータを入力する機能については顧客毎にシリアル処理(異なる性質の処理)のため
REQUEST I/F は一問一答(要求送信後応答を待ち次の要求を送信する)方式(利用者側での使い方に対する制限)となります。
またブラウザ等での自動再送処理等による同要求重複送信をe支店システム(受信側)で回避するため、要求データに設定する送信通番を
前受信要求.送信通番>=今受信要求.送信通番の場合、処理せずエラー応答を返します。
EVENT I/F は常時接続利用のため1要求のみ受け付け、先要求は自動で切断します(後要求勝ち)。
仮想URLはログアウト等で無効化しない場合、最終的にe支店システム閉局時までe支店システム内で有効な状態として維持します。
仮想URLを通して注文受発注を行うため、セキュリティ強化を考える場合、認証し必要機能を実施した後、ログアウトすることで
仮想URLを無効化し、クライアントとe支店間のつながり(セッション)を無くすことができます(お客様の利用方法依存のため任意です)。
仮想RULは意味のない(目で見える)文字列であり、該当文字については決まったフォーマット仕様はありません(任意で仕様が変わります)。
7.利用時間について
利用時間はe支店システムの稼働時間帯です。
e支店システムの保守や障害等発生時は、e支店・標準Web同様本APIもご利用頂けません。
本APIはe支店システムのサブシステムであるため、e支店システムが通常稼働していても
本API用サブシステムが障害発生時はご利用頂けません。
このケースの場合、本APIで発注した注文についてはe支店・標準Webの注文等照会機能によりご確認をお願いいたします。
また、その後の注文についての処理(訂正、取消など)についてはe支店・標準Webをご利用ください。
8.セキュリティー
本API はインターネット経由でe支店口座をお持ちの全てのお客様向けにリリースを想定した機能です。
セキュリティー確保の意味ではe支店・標準Web同様 SSL 通信の範囲となります。
本APIはソフトウエア的に暗号化や圧縮機能は現バージョンでは持っていません。
※バージョン(v3)以降は APACHE mod_deflate 機能による application/json, text/json の応答圧縮機能を追加。
ご利用にあたりお客様のe支店口座のログイン、パスワードによる認証が唯一のセキュリティとなります。
本APIではそれらを変更する機能はありませんので、変更時はe支店・標準Webの操作で実行をお願いいたします。
本APIはインターネット経由での接続を公開しお客様の責任でご利用頂くインタフェースです。
インターネット上に流れる情報についてはインターネット上に公開される(インターネット上に情報が流れるため
物理的にはその経路上で他人に見られる可能がある)前提でご利用をお願いいたします。
※これは暗号化しても圧縮しても解読に時間がかかるかどうかの問題であり、インターネット上に情報を流したら見えてしまう性質上の問題です。
4.ご利用にあたって
1.本APIのご利用にはe支店の口座開設が必要となります。
2.e支店の口座開設後、e支店・標準Webにログイン頂いた後に以下操作が必要になります。
・各種書面(金商法交付書面等)の確認。
各種書面が未読の場合、e支店・標準Webがご利用頂けないのと同様、本APIもご利用頂けません。
本APIの機能はe支店・標準Webの一部機能について、
お客様の画面操作に代わり、お客様が開発したプログラムからe支店・標準Webの機能を実行するものです。
そのため、本APIのご利用はe支店・標準Webで上記確認を実施頂くことにより
本APIを含むe支店のご利用によるリスクを全て許容して頂くことが前提となります。
また、各種書面については追加変更がありますので、その都度e支店・標準Webにてご確認(許容)頂く必要があります。
3.新規、訂正、取消等の各注文入力機能には第二暗証番号が必要となります。
e支店・標準Web・お客様情報画面、第二暗証番号・暗証番号省略設定の有効、無効に関わらず
本APIの各注文入力機能には第二暗証番号の引数設定が必須となります。
4.インサイダー申告頂きました銘柄につきましては本APIからの新規注文入力機能、訂正注文入力機能はご利用頂けません。
ただし、取消注文入力機能については緊急性を考慮しご利用頂けるよう対処しております。
インサイダー申告銘柄の新規及び訂正注文入力につきましてはe支店・標準Webからのご利用をお願いいたします。
5.本APIはお客様が(ご自身で)作成されたプログラムからの利用を想定したインタフェース(機能)の提供を目的としています。
そのため、各種注文入力機能等につきましてはe支店・標準Webの各種注文入力機能等にあります入力内容確認機能は
本APIを利用するお客様側のプログラムで実施する前提で、お客様の確認後の入力内容を本APIを通して入力頂くことになります。
本APIを通して入力頂いた注文入力内容は弊社業務システムで必要な業務チェックをした後、
問題ない場合はそのまま市場へ取り次ぎ(発注)を行います。
6.当社システムのご利用に際し過負荷であると当社が判断した場合、口座利用を停止させて頂く場合がございます。
7.当社提供情報は、蓄積、編集および加工等は禁止しております。ご利用については当社規定の範囲内でご利用ください。
8.本HPのマニュアル、及びサンプルプログラムを参照並びに解析頂きご利用ください。
本APIのご利用に限らず、
一般的にAPIと呼ばれるアプリケーションプログラミングインタフェースをご利用する観点での話にはなりますが、
一般的にAPIを利用するには、システム開発経験(HTTP及びJSONに関する知識、インターネット経由での
通信プログラム作成経験や開発能力)等、一定上の開発能力が必要であり、
本APIのサンプルプログラム、及びマニュアルを見て開発できる力量、技量が必要となりますので予めご留意願います。
9.流量制限
本APIで注文入力の偏りを防ぎ各お客様に公平にご利用いただくため、お客様からの要求受付に対し流量制限(秒10件)をしております。
6.サンプルプログラム
以下リンクをクリックするとe支店・APIを利用したサンプルプログラムを表示します。
1.基本利用方法(v4r7)
2.時価情報取得表示(v4r7)
3.EVENT IF WebSocket版(v4r7)
※デモ環境にてご利用頂けます。
※本番環境はv4r7リリース後にご利用頂けます。
右クリック(ページソースコード表示)で全て参照&利用可能です。
e支店・APIを利用したプログラム開発の際、参考資料の1つとしてご利用下さい。
※サンプルプログラムはお客様がe支店・APIを利用したプログラム開発をする目的のみに利用を許諾致します。
※サンプルプログラムは当社の都合により提供の停止を含む機能追加変更削除等を行いますので予めご了承下さい。
なお、
サンプルプログラムはお客様がe支店・APIを利用したプログラム開発をする目的でe支店・APIの使い方をその1例として参考提供することが目的ですので
サンプルプログラム(として提供する全てのソースコード)の使用(含む一部機能(クラス、メソッド、サブルーチン等を含む)の利用や流用等)の
実行により生じた全ての障害・損害・不具合等に関しては一切の責任を負いませんので、自己の判断、及び自己の責任においてご(参考)利用をお願いいたします。
7.その他
1.ネットワーク疎通確認
本APIのご利用にはお客様のプログラム(以下クライアントと呼ぶ)から弊社本APIプログラム(以下サーバと呼ぶ)に
インターネットを経由し HTTPS プロトコルで接続及びデータ通信をする必要があります。
お客様の契約先インターネット回線から不特定多数の回線業者のルータ等機器類を経由し
弊社契約先回線業者を通して弊社サーバに接続し
その逆をたどってお客様とのデータ通信を行うことで本APIが機能いたします。
そのため本APIをご利用前に、通信環境の確認として以下をお試しください。
(1)立花証券・e支店・API専用ページ(以下本ページと呼ぶ)の表示確認。
本ページ(本記載内容)が見えていることで、クライアントからサーバまでのネットワーク的な疎通確認となります。
本ページが見えている=本APIにアクセス可能、本ページが見えていない=本APIにアクセス不可能を意味しますので
本APIが使えない・・・とか本APIに接続できない・・・と思う場合はこちらで判断ください。
※ただし、サービス時間帯以外や休日の保守作業による休止時間帯を除きます。
(2)本専用ページまでのアクセス時間の確認。
クライアントからサーバまでのアクセスが遅い・・・と感じられる場合は以下をお試しください。
% wget https://kabuka.e-shiten.jp/e_api/mfds_json_api_sample.html -O output.html
実行結果として転送バイト数、ページ取得 % と転送時刻 s などが表示されます。
ちなみに、弊社社員の自宅PC(光回線)から試したところ 26054 バイト を 0.003 秒 で転送(アクセス時間 0.003 秒)した結果でした。
結果はクライアント〜サーバ間のシステム構成やネットワーク環境に依存しますので上記の計測結果が遅いと感じられる場合は
お客様のご利用PCやシステム環境、通信環境等の見直しが必要となりますので予めご留意願います。
※wget は linux のコマンドになりますので、windows をご利用の場合は windows で稼働するフリーの wget ソフト等を
インストール(フリーソフトのインストールや実行については自己責任でお願いいたします)しご確認ください。
2.サーバ障害対策
本APIの稼働サーバは複数台を並列稼働し本APIサービスの提供を行っております。
万が一その内の1台が障害で停止した場合は該当サーバを切り捨て他の稼働サーバで継続運用致します。
ただし、タイミングにより該当サーバへ処理を割り振られた本APIの要求(応答受信前に障害発生)については
クライアントは HTTPS のレベルでエラーを検知(本APIの応答は返らない)となります。
このケースにおいて該当要求が注文入力である場合は応答が返されないため注文入力可否が判定できませんので
本APIの注文一覧、または標準Webの注文一覧にて該当注文が発注されたかどうかについてご確認をお願いいたします。
※e支店システムが障害(例として基幹データベースの障害など)等の場合、各APIはエラー応答(p_errno!=0)を返します。
※e支店システムが閉局等の場合も同様に各APIはエラー応答(p_errno!=0)を返します。
※ p_errno については「立花証券・e支店・API(vN[rN])、REQUEST I/F、利用方法、データ仕様」参照。
3.URLエンコード
本APIは HTTP プロトコルでインタフェースする仕様上
お客様からの要求については URL に JSON 文字列として指定頂く仕様となっております。
そのため URL の記述仕様上意味を持つ文字(例:「#+/:=」等)は直接指定することができません。
それらにつきましてはURLエンコード(文字変換)を行い、URLに指定可能なエンコード文字(列)として指定頂く必要があります。
例:「#」→「%23」、「+」→「%2B」、「/」→「%2F」、「:」→「%3A」、「=」→「%3D」など。
※通常の業務データ(注文入力等)では上記文字を指定することはありませんが、パスワード等は該当しますのでご注意ください。
Copyright(C) 2017 THE TACHIBANA SECURITIES CO., LTD. All Rights Reserved.