API キーと秘密鍵の作成

API キーと秘密鍵は、API フックを使用するために必要な資格情報です。 API フックへの要求が許可されるためには、X-API-Key ヘッダーと X-API-Secret ヘッダーの両方を指定する必要があります。 API キーと秘密鍵の値は、それぞれ、これらのヘッダーの値を表します。

単一のテスト・スイートにスコープ設定された API フックとは異なり、API キーとシークレットはテスト組織にスコープ設定されます。 そのため、テスト組織内で生成された API キーと秘密鍵のペアは、API フックが関連付けられているテスト・スイートに関係なく、同じ組織内のすべての API フックに対する要求を許可する権限を持ちます。

API キーと秘密鍵の作成方法

  1. API Manager にログインします。
  2. 「API のテスト」タイルをクリックします。
  3. テスト・スイートを選択します。
  4. 「設定」 > 「API フックおよびキー」 タブに移動します。
  5. 新しい API フックを使用するには、API キーと秘密鍵があることを確認する必要があります。鍵

    • 「キー」セクションに移動し、 「追加」をクリックします。
    • キー名を入力します。
    • 保存 をクリックします。 システムはキーとシークレットを表示します。 将来の参照のためにコピーしてください。 キーと秘密鍵がセットアップされている場合、API フックの使用方法について詳しくは、 API フックの使用 を参照してください。

新規 API キーがアクティブになり、ナビゲーション・メニューにある API キーのリストに表示されるようになります。 後で再度参照する必要がある場合は、キーをクリックして、API キーの値を表示できます。 任意の時点で API キーを削除する場合は、削除する API キーの横にある「削除」アイコンをクリックします。 これにより、このキーと秘密鍵の組み合わせを使用した API フックに対する今後のすべての要求が無効になります。

次のタスク