管理APIの機能
1. APIキーの管理
「APIキー」画面では、APIキーを生成できます。APIキーは、管理APIにリクエストするときに使用する、認証用の文字列です。
生成できるAPIキーの上限は10個です。 |
1.1. APIキーを生成する
-
サイドメニューから「管理API」 → 「APIキー」を選択し、「APIキー」画面を開きます。
-
「APIキーの生成」ボタンを押し、「APIキーの生成」画面を開きます。
-
生成するAPIキーの情報を入力し、「確認」ボタンを押します。
-
説明
生成するAPIキーの説明です。説明には次の制限があります。
-
文字数:80文字以下
-
-
有効期間
APIキーをリクエストに使用できる期間です。有効期間を設定する場合、この期間外にAPIキーを使用して管理APIにリクエストすると、認証エラーになります。
-
-
生成するAPIキーの内容を確認し、「確定」ボタンを押します。
APIキーを生成後、設定した内容は変更できません。
-
APIキーが生成されます。「APIキーをコピーしました。」にチェックを入れると、「閉じる」ボタンが押せるようになります。
「閉じる」ボタンを押した後は、APIキーの確認ができません。APIキーを保存して、大切に保管してください。
1.2. APIキーを失効させる
-
サイドメニューから「管理API」 → 「APIキー」を選択し、「APIキー」画面を開きます。
-
失効させるAPIキーにチェックを入れ、「APIキーの失効」ボタンを押し、「APIキーの失効」画面を開きます。
-
失効させるAPIキーの内容を確認し、「確定」ボタンを押します。
-
APIキーが失効されます。
2. IPアドレス許可ルールの管理
「IPアドレス許可ルール」画面では、管理APIにアクセスできるIPアドレスを設定します。管理APIにアクセスできるIPアドレスを制限することで、セキュリティーを高めることができます。
|
2.1. IPアドレス許可ルールを作成する
-
サイドメニューから「管理API」 → 「IPアドレス許可ルール」を選択し、「IPアドレス許可ルール」画面を開きます。
-
「ルールの新規作成」ボタンを押し、「ルールの新規作成」画面を開きます。
-
作成するルールの情報を入力し、「確認」ボタンを押します。
入力可能なIPアドレスのフォーマットは、 ボタンを押すと確認できます。
説明には次の制限があります。
-
文字数:80文字以下
-
-
作成するルールの内容を確認し、「確定」ボタンを押します。
-
ルールが作成されます。
2.2. IPアドレス許可ルールを確認する
-
サイドメニューから「管理API」 → 「IPアドレス許可ルール」を選択し、「IPアドレス許可ルール」画面を開きます。「IPアドレス許可ルール」画面では、設定したIPアドレス許可ルールの一覧を確認できます。
-
「検索条件」ボタンを押すと、検索条件の入力欄が表示されます。テーブル内の項目を、部分一致検索で絞りこむことができます。
検索において、大文字と小文字は区別されません。
2.3. IPアドレス許可ルールを編集する
-
サイドメニューから「管理API」 → 「IPアドレス許可ルール」を選択し、「IPアドレス許可ルール」画面を開きます。
-
一覧テーブルの「編集ボタン」列の ボタンを押します。
-
ルールの情報を編集し、「確認」ボタンを押します。
-
内容を確認し、「確定」ボタンを押します。
-
ルールが更新されます。
2.4. IPアドレス許可ルールを削除する
-
サイドメニューから「管理API」 → 「IPアドレス許可ルール」を選択し、「IPアドレス許可ルール」画面を開きます。
-
削除するルールにチェックを入れ、「ルールの削除」ボタンを押し、「ルールの削除」画面を開きます。
-
削除するルールの内容を確認し、「確定」ボタンを押します。
-
ルールが削除されます。
3. 管理API使用状況の確認
サイドメニューから「管理API」 → 「管理API使用状況」を選択すると、「管理API使用状況」画面が表示されます。「管理API使用状況」画面では、APIコール回数 (リクエスト回数) や、データ使用量 (レスポンスのデータ量) を確認できます。
「更新」ボタンを押すと、最新の使用状況に更新されます。
1日あたりのAPIコール回数と使用データ量は、毎日0時にリセットされます。 |