/
APIキー

APIキー

Owned by Yoshinori Matsumura
Last updated: Jul 27, 2023 by Hiroshi TsurumakiVersion comment
作成日更新日影響を受けるバージョン修正バージョン

 

 

Management PortalN/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キーを参照、管理できます。

キーを管理するにはキー名の横にある設定アイコン (縦三点リーダー) をクリックし、表示されるオプションを選択します。

アイコンの示す意味は次の通りです:

  1. クリップボードにコピー - 選択されたAPIキーをクリップボードにコピーします。
  2. 削除 - APIキーを削除します。
  3. 編集 - 選択されたキーの名前と説明を編集します。

リクエストの認証に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エンドポイントの詳細とその使用方法については、こちらをご覧ください: Management Portal APIを使用したレポートのエクスポート