API キーの作成

Concert APIを呼び出すには、Concert UIから作成できる有効なAPIキーの秘密を使ってリクエストを認証する必要があります。 Concert APIを使用して、1回限りのデータ取り込みや自動データ取り込み、その他のサポートされる機能を使用できます。

警告: APIキーは、Concertインスタンスと設定の特定の側面へのアクセスを許可する一意の識別子です。 APIキーは常に安全に保管し、不正なリクエストやデータへのセキュリティ関連のリスクを防ぐために、アクセスを許可された個人に限定します。 APIキーを紛失した場合、それを復元することはできない。

注意事項

以下の手順で、ConcertUI で新しい API キーを生成します。

  1. 認証情報、または設定されたSSOと多要素認証を使用して「ConcertUIにログインします。
  2. メインナビゲーションヘッダーの右上にあるユーザーアイコン（丸）をクリックし、APIキーを選択します。
  3. APIキーを生成をクリックします。
    注：すでにAPIキーを作成している場合は、新しいキーを生成する前に、そのキーを取り消すよう求められます。
  4. APIキーの値とAPIキーの使用法の詳細を記録し、安全な場所に保管してください。
    警告ダイアログボックスを閉じると、APIキーの秘密は表示されません。

APIキーの使い方の例には、APIヘッダーに含める必要のある重要な情報が含まれています：

  • API キーの種類: SaaS および VM デプロイメントには C_API_KEY を、 Concert クラスタ上のデプロイメントには ZenAPIKey を、 IBM Cloud Pak® foundational services を使用してデプロイされた OCP クラスタには を使用する。 この値は、認証ヘッダーのAPI key secretの前になければならない。
  • InstanceId: Concertインスタンスの固有ID。

有効なAPIキーが生成されたら、リクエストの認証にそれを使い始めることができる。 APIを呼び出すために必要な様々なカスタム・ヘッダの詳細については、APIリファレンスと認証を参照のことConcert

エンドポイントとリクエストの完全なインデックスについては、https://developer.ibm.com/apis/catalog/concert--ibm-concert-apiを参照のこと。