既存のコンシューマ キーとシークレットの読み込み

このページは ApigeeApigee ハイブリッドに適用されます。

Apigee Edge ドキュメントを表示する

Apigee では、デベロッパー アプリを作成して API プロダクトに関連付けると、コンシューマ キーとコンシューマ シークレットが自動的に生成されます(これらの手順については、アプリを登録して API へのアクセスを制御するをご覧ください)。しかし、既存のコンシューマ キーとシークレットがあって、別のシステムから Apigee Edge に読み込みたい場合もあります。技術的には、このプロセスは読み込みではありません。既存のキーを一度に 1 つ、Apigee に再作成するものです。

コンシューマ キー(API キー)のサイズ 2 KB
コンシューマ シークレット サイズ 2 KB
  1. Apigee API を使用してコンシューマ キーとシークレットを作成します
    コンシューマ キーとシークレット API の create をご覧ください。curl は次のとおりです。
    curl https://apigee.googleapis.com/v1/organizations/{org}/developers/{developer_email}/apps/{app_name}/keys \
      -X POST \
      -H "Authorization: Bearer $TOKEN" \
      -H 'Content-type:application/json' \
      -d \
        '{
          "consumerKey": "key",
          "consumerSecret": "secret",
          "expiresInSeconds": "180"
        }'

    ここで、OAuth 2.0 アクセス トークンの取得で説明されているように、$TOKEN は OAuth 2.0 アクセス トークンに設定されます。この例で使用されている curl オプションの詳細については、curl の使用をご覧ください。使用される環境変数の説明については、Apigee API リクエストの環境変数の設定をご覧ください。

    リクエストの本文で指定できるフィールドについては、リソース: DeveloperAppKey をご覧ください。

  2. コンシューマ キー / シークレットを 1 つ以上の Apigee API 製品に関連付けます。 これにより、インポートされたコンシューマ キー(API キーとも呼ばれます)を、プロダクトによって認証が制御される API プロキシへの呼び出しに使用できるようになります。
    ReplaceDeveloperAppKey API をご覧ください。curl は次のとおりです。
    curl https://apigee.googleapis.com/v1/organizations/{org}/developers/{developer_email}/apps/{app_name}/keys/{key} \
      -X POST \
      -H "Authorization: Bearer $TOKEN" \
      -H 'Content-type:application/json' \
      -d \
        '{
          "apiProducts": ["product_1", "product_2"]
        }'

    ここで、OAuth 2.0 アクセス トークンの取得で説明されているように、$TOKEN は OAuth 2.0 アクセス トークンに設定されます。この例で使用されている curl オプションの詳細については、curl の使用をご覧ください。使用される環境変数の説明については、Apigee API リクエストの環境変数の設定をご覧ください。

  3. 必要に応じて、Apigee によって自動生成された初期コンシューマ キー / シークレットを削除します。ただし、自動生成されたキーは保持できます。インポートしたキーと自動生成されたキーはどちらも API 呼び出しで機能し、Apigee UI の [Developer App Details] ページに表示されます。
    デベロッパー アプリ API の delete API キーをご覧ください。