Request Interfaceの指定
WebAPIを使用するための共通の指定方法について説明します。
Request Interface
HULFT10 API Gateway WebAPI リファレンスの「配信履歴の取得」のRequest Interfaceを例に説明します。
http://ControlURL/api/v1/hulft/{hulft-host-id}/logs/sendings/detail/{id}
Authorization: Bearer AccessToken(*)
* |
: |
AccessTokenには、「アクセストークンの取得」でコピーしたアクセストークンを指定します。 |
上のRequest InterfaceのURLで、斜体の文字部分に指定するパスについては以下のとおりです。
- ControlURL
-
ControlURLには、以下の下線部分のとおり、HULFT10 API Gatewayの管理画面にアクセスするためのURLを指定します。
http://API-Gatewayを起動しているホスト名:API-Gatewayのポート番号
例として、以下のURLの下線部分が該当します。
http://XYZ10000:12300
- hulft-host-id
-
接続するHULFTのホストIDを指定します。
ホストIDは以下の手順で入手できます。
-
HULFT10 API Gateway>Main>ホストの管理>すべてのホストをクリックします。
-
接続したいホストのホスト名をクリックします。
表示されたホスト情報のURLの末尾にホストIDが含まれています。
例として、以下のURLの下線部分が該当します。
http://XYZ10000:12300/manager/host/detail/HULFTID2924982229197730
-
- id
-
最新転送IDを指定します。
履歴の転送識別子は以下の手順で入手できます。
-
HULFT10 API Gateway>Main>ホストの管理>すべてのホストをクリックします。
-
接続したいホストの接続ボタンをクリックします。
-
接続先となるHULFT10の配信状況または集信状況で、確認したい履歴の転送IDをクリックします。
表示された画面タイトルの「転送ID:」より後の文字が最新転送IDです。
例として、以下の画面タイトルの下線部分が該当します。
転送ID:D71D3DCE35BCF9E7E64CD10483DADF2061000100000000000000000000000000
-
これらの値をすべて指定すると以下のとおりとなります。
http://XYZ10000:12300/api/v1/hulft/HULFTID2924982229197730/logs/sendings/detail/D71D3DCE35BCF9E7E64CD10483DADF2061000100000000000000000000000000
Authorization: Bearer AccessToken
コマンドを実行した結果として、該当する配信履歴が取得されます。