Apigee API スタートガイド

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

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

Apigee API は、一連の RESTful オペレーションを使用してプログラムで API を開発、管理するために使用できます。

Apigee API を使用することで、API プロキシ管理を組織のソフトウェア開発ライフサイクル（SDLC）に統合できます。Apigee API の一般的な用途は、他のアプリケーションのデプロイや移行も行う自動化された大規模なプロセスの一部として、API プロキシをデプロイするスクリプトやコードを作成することや、API プロキシを環境間で移行するスクリプトやコードを作成することです。

詳細については、Apigee API をご覧ください。

Apigee API の有効化

Apigee API が有効になっていることを確認します。プロジェクトで API を有効にする最も簡単な方法は、Google Cloud コンソールを使用することです。詳細については、ステップ 3: API を有効にするをご覧ください。

OAuth 2.0 アクセス トークンの取得

Apigee API では、OAuth 2.0 によるユーザー認証がサポートされています。OAuth 2.0 では、Google Cloud の認証情報をアクセス トークンに交換し、これを使用して Apigee API への安全な呼び出しを行えます。トークンを取得すると、そのトークンの有効期限が切れるまで認証情報を再度交換する必要はありません。

Google Cloud 認証情報を使用してトークンを取得する

Google Cloud 認証情報を使用してトークンを取得するには、次のようにします。

  1. Google ユーザー認証情報を使用して gcloud に Cloud Platform へのアクセスを認可します。
    gcloud auth login
  2. 現在アクティブなアカウントのトークンを取得します。
    export TOKEN=$(gcloud auth print-access-token)
  3. アクセス トークンは、Apigee API を呼び出すときに、Authorization ヘッダーで渡します。次に例を示します。
    curl "https://apigee.googleapis.com/v1/organizations" -H "Authorization: Bearer $TOKEN"

Google Cloud サービス アカウント キーを使用してトークンを取得する

サービス アカウント キーを使用した認証でトークンを取得するには、次のようにします。

  1. GCP コンソールを使用し、サービス アカウント キーの作成と管理の説明に沿ってサービス アカウントのキーを生成します。

    サービス アカウント認証情報が含まれる JSON ファイルが、パソコンにダウンロードされます。

  2. GOOGLE_APPLICATION_CREDENTIALS 環境変数をサービス アカウント キーが置かれているパスに設定します。

    export GOOGLE_APPLICATION_CREDENTIALS=your_sa_credentials_file.json
  3. Apigee API を呼び出すときに、Google Cloud CLI を使用してアクセス トークンを Authorization ヘッダーに追加します。次に例を示します。
    curl "https://apigee.googleapis.com/v1/organizations" -H "Authorization: Bearer $(gcloud auth application-default print-access-token)"

Apigee API リクエストの環境変数の設定

このドキュメントで説明する Apigee API と gcloud CLI の例では、次の表で定義されている環境変数を 1 つ以上使用しています。

前もって環境変数を環境内でわかりやすい値に設定することで、変更をまったくしないか最小限にとどめ、サンプル リクエストをコピー＆ペーストして独自の環境で実行できます。

環境変数 説明
$API API プロキシの名前。
$APIPRODUCT API プロダクトの名前。
$APP アプリの ID。
$DEVELOPER_EMAIL デベロッパーのメールアドレス。
$ENV 環境の名前（test、prod など）。
$ID リソース ID。
$KEY コンシューマ キー。
$NAME リソースの名前。
$ORG Apigee 組織。
$REV API プロキシのリビジョン番号。
$SHAREDFLOW 共有フローの名前。
$TYPE リソースタイプ。

curl の使用

このセクションの例では、curl を使用して、Apigee API を使用するアプリケーションを開発する方法を示します。curl は、URL 構文を使用してデータを転送できるオープンソースのコマンドライン ツールで、HTTP や HTTPS などの一般的なプロトコルをサポートしています。

次の表は、以降の例で使用している curl のコマンドライン オプションの要約を示しています。

オプション 説明
-d '{}' --data @filename
--data-binary @filename		 リクエスト本文を定義します。リクエスト本文は、コマンドに直接渡すか、ファイルに記述してそのファイル名を指定できます。
-F file=@filename
--form file=@filename 		フォームベースのデータを定義します。このデータは、ファイルに記述してそのファイル名を指定することで渡せます。
-H
--header		 リクエスト ヘッダーを定義します。

リクエスト ヘッダーで次の情報を渡す必要があります。

  • Authorization ヘッダー: OAuth 2.0 アクセス トークンの取得で説明されているユーザー認証用の OAuth 2.0 トークン。
  • Content-Type ヘッダー: API を使用してリソース（POST、PATCH、PUT）を作成または更新するときに送信されるリクエスト本文のコンテンツ タイプ。
-X リクエストの種類（GET、POST など）を指定します。

次に例を示します。

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apis" \
   -X GET \
   -H "Authorization: Bearer $TOKEN"

ここで、$TOKEN は、OAuth 2.0 アクセス トークンの取得で説明されているように、OAuth 2.0 アクセス トークンに設定されます。