コンテンツにスキップ

API

API画面では、帳票出力APIの実行に使用するAPIトークンの管理、接続許可IPの設定、および実行履歴の確認ができます。


API
帳票出力で使用するAPIトークンの確認、再発行、コピーができます。
また、APIトークンの有効・無効設定、コメントの入力、接続許可するグローバルIPアドレス(IPv4のみ)を指定できます。

実行履歴
帳票出力APIを使用して帳票出力した履歴を確認できます。
直近10件分のAPI実行履歴が表示されます。


API

API画面

図1:API画面

APIトークン

APIトークンが表示されます。 このトークンは帳票出力APIを利用して帳票を出力する場合に、認証情報として使用されます。

Danger

APIトークンは重要な認証情報です。
不正利用や情報漏えいの原因となるおそれがあるため、第三者に共有しないでください。

コピー

コピーアイコンをクリックすると、APIトークンをクリップボードにコピーします。

再発行

[再発行]ボタンをクリックするとAPIトークンの発行モーダルが表示されます。
モーダル内の[発行]ボタンをクリックするとAPIトークンを即時に再発行します。

Warning

再発行後は、元のAPIトークンに戻すことはできません。
新しいトークンが即時に反映されるため、元のトークンを使用できなくなる点に注意してください。

有効・無効

APIトークンの有効・無効を設定します。
初期値は[有効]です。 [無効]に設定した場合は、このAPIトークンを使用した帳票出力ができません。

コメント

任意のメモを入力します。文字数上限は400文字です。

接続許可IP

APIトークンを利用できるグローバルIPアドレス(IPv4のみ)を個別のグローバルIPアドレス(IPv4のみ)またはCIDR形式で指定します。
指定したグローバルIPアドレス(IPv4のみ)からのみ接続が許可されます。
初期状態では、接続許可IPは設定されていません。
接続許可IPの要件は以下のとおりです。

  • 最大20個
  • 400文字以内

Warning

接続許可IPを設定していない場合、すべてのグローバルIPアドレスからAPIトークンを利用できます。


実行履歴

APIトークン利用の直近10件の実行履歴が表示されます。

実行履歴

図2:実行履歴

表示内容は以下のとおりです。

項目 内容
日時 帳票出力APIの実行日時が表示されます。
ランタイム 帳票出力に使用されたランタイム(CastまたはExpage)が表示されます。
帳票名 出力対象の帳票名が表示されます。
帳票ID 出力対象の帳票IDが表示されます。
ステータス 帳票出力処理の結果(success:成功、warning:警告、error:エラー)が表示されます。

10件より前の実行履歴についてはログ画面から確認できます。