1. APIキーの管理

「APIキー」画面では、APIキーを生成できます。APIキーは、管理APIにリクエストするときに使用する、認証用の文字列です。

生成できるAPIキーの上限は10個です。

1.1. APIキーを生成する

  1. サイドメニューから「管理API」 → 「APIキー」を選択し、「APIキー」画面を開きます。

    APIキーを生成する_APIキー一覧

  2. 「APIキーの生成」ボタンを押し、「APIキーの生成」画面を開きます。

  3. 生成するAPIキーの情報を入力し、「確認」ボタンを押します。

    APIキーを生成する_情報入力

    • 説明
      生成するAPIキーの説明です。

      説明には次の制限があります。

      • 文字数:80文字以下

    • 有効期間
      APIキーをリクエストに使用できる期間です。有効期間を設定する場合、この期間外にAPIキーを使用して管理APIにリクエストすると、認証エラーになります。

  4. 生成するAPIキーの内容を確認し、「確定」ボタンを押します。

    APIキーを生成する_内容確定

    APIキーを生成後、設定した内容は変更できません。

  5. APIキーが生成されます。「APIキーをコピーしました。」にチェックを入れると、「閉じる」ボタンが押せるようになります。

    APIキーを生成する_APIキー生成

    「閉じる」ボタンを押した後は、APIキーの確認ができません。APIキーを保存して、大切に保管してください。

1.2. APIキーを失効させる

  1. サイドメニューから「管理API」 → 「APIキー」を選択し、「APIキー」画面を開きます。

  2. 失効させるAPIキーにチェックを入れ、「APIキーの失効」ボタンを押し、「APIキーの失効」画面を開きます。

    APIキーを失効させる_APIキーの失効

  3. 失効させるAPIキーの内容を確認し、「確定」ボタンを押します。

    APIキーを失効させる_確定

  4. APIキーが失効されます。

    APIキーを失効させる_完了

2. IPアドレス許可ルールの管理

「IPアドレス許可ルール」画面では、管理APIにアクセスできるIPアドレスを設定します。管理APIにアクセスできるIPアドレスを制限することで、セキュリティーを高めることができます。

  • IPアドレス許可ルールを設定しない場合、すべてのIPアドレスからアクセスできます。

  • 作成できるIPアドレス許可ルールの上限は100個です。

2.1. IPアドレス許可ルールを作成する

  1. サイドメニューから「管理API」 → 「IPアドレス許可ルール」を選択し、「IPアドレス許可ルール」画面を開きます。

    IPアドレス許可ルールを作成する_IPアドレス許可ルール一覧

  2. 「ルールの新規作成」ボタンを押し、「ルールの新規作成」画面を開きます。

  3. 作成するルールの情報を入力し、「確認」ボタンを押します。

    IPアドレス許可ルールを作成する_ルールの新規作成

    入力可能なIPアドレスのフォーマットは、 IPアドレス許可ルールを作成する_ボタン ボタンを押すと確認できます。

    説明には次の制限があります。

    • 文字数:80文字以下

  4. 作成するルールの内容を確認し、「確定」ボタンを押します。

    IPアドレス許可ルールを作成する_確定

  5. ルールが作成されます。

    IPアドレス許可ルールを作成する_完了

2.2. IPアドレス許可ルールを確認する

  1. サイドメニューから「管理API」 → 「IPアドレス許可ルール」を選択し、「IPアドレス許可ルール」画面を開きます。「IPアドレス許可ルール」画面では、設定したIPアドレス許可ルールの一覧を確認できます。

  2. 「検索条件」ボタンを押すと、検索条件の入力欄が表示されます。テーブル内の項目を、部分一致検索で絞りこむことができます。

    IPアドレス許可ルールを確認する_検索条件

    検索において、大文字と小文字は区別されません。

2.3. IPアドレス許可ルールを編集する

  1. サイドメニューから「管理API」 → 「IPアドレス許可ルール」を選択し、「IPアドレス許可ルール」画面を開きます。

  2. 一覧テーブルの「編集ボタン」列の IPアドレス許可ルールを編集する_ボタン ボタンを押します。

  3. ルールの情報を編集し、「確認」ボタンを押します。

  4. 内容を確認し、「確定」ボタンを押します。

  5. ルールが更新されます。

2.4. IPアドレス許可ルールを削除する

  1. サイドメニューから「管理API」 → 「IPアドレス許可ルール」を選択し、「IPアドレス許可ルール」画面を開きます。

  2. 削除するルールにチェックを入れ、「ルールの削除」ボタンを押し、「ルールの削除」画面を開きます。

    IPアドレス許可ルールを削除する_ルールの削除

  3. 削除するルールの内容を確認し、「確定」ボタンを押します。

    IPアドレス許可ルールを削除する_確定

  4. ルールが削除されます。

    IPアドレス許可ルールを削除する_完了

3. 管理API使用状況の確認

サイドメニューから「管理API」 → 「管理API使用状況」を選択すると、「管理API使用状況」画面が表示されます。「管理API使用状況」画面では、APIコール回数 (リクエスト回数) や、データ使用量 (レスポンスのデータ量) を確認できます。

「更新」ボタンを押すと、最新の使用状況に更新されます。

管理API使用状況を確認する

1日あたりのAPIコール回数と使用データ量は、毎日0時にリセットされます。