作成日 | 更新日 | 影響を受けるバージョン | 修正バージョン |
---|---|---|---|
|
| Management Portal | N/A |
Blancco Management Portal APIエンドポイント認証のためにはAPIキーが必要です。APIキーはManagement Portalの「サポート」タブにある「APIキー」にて管理されています。
全APIキー
テナント内で作成されたすべてのAPIキーが一覧表示されます。APIキーの作成日やキーの所有者等の詳細情報も表示されます。
自分のAPIキー
自身のAPIキーが一覧表示されます。新しいAPIキーを生成したり、既存のAPIキーを管理できます。
新規APIキーを生成
新しいAPIキーを作成するには「APIキーを生成」を選択し、キーの名前と説明を入力します。キーの名前と説明はテナント内の他のユーザーが「全APIキー」ページに移動した場合に表示されることにご注意ください。
キーの生成後、作成したAPIキーをコピーできる確認ダイアログが表示されます。キーは後から「自分のAPIキー」ページでもコピーできます。
既存APIキーの管理
APIキーが作成されると「自分のAPIキー」タブからAPIキーを参照、管理できます。
キーを管理するにはキー名の横にある設定アイコン(縦三点リーダー)をクリックし、表示されるオプションを選択します。
アイコンの示す意味は次の通りです:
- クリップボードにコピー - 選択されたAPIキーをクリップボードにコピーします。
- 削除 - APIキーを削除します。
- 編集 - 選択されたキーの名前と説明を編集します。
リクエストの認証にAPIキーを使用する
APIキーを使用してAPIリクエストを認証するには、キーをリクエストヘッダの一部として提供する必要があります。
ヘッダ | 必須 | 説明 |
---|---|---|
X-BLANCCO-API-KEY | はい | ヘッダの内容にAPIキーそのものを指定する必要があります。APIキー名等ではありません。例えば以下のような文字列です:「8574e755-1f80-4af4-b7ae-a8187afb3909」。 この構造はいつでも変更可能です。 すべてのAPIキーの値は一意です。 |
次の例は簡単なcurlリクエストの一部としてAPIキーを含める方法を示しています。{UUID} を有効なレポートUUIDに、{API_KEY}をAPIキーのキー文字列に置き換えてください:
curl -X "GET" \ "https://api.eu-west-1.blancco.cloud/v1/report/export/{UUID}" \ -H "accept: */*" \ -H "X-BLANCCO-API-KEY: {API_KEY}"
利用可能なAPIエンドポイントの詳細とその使用方法については、こちらをご覧ください: [LINK]