本頁面由 Cloud Translation API 翻譯而成。

開始使用 Apigee API
透過集合功能整理內容你可以依據偏好儲存及分類內容。

本頁適用於 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 說明文件。

Apigee API 可用於透過程式輔助方式，以一組 RESTful 作業開發及管理 API。

您可以使用 Apigee API，將 API Proxy 管理功能整合至貴機構的軟體開發生命週期 (SDLC)。Apigee API 的常見用途是編寫用於部署 API Proxy 或將 API Proxy 從一個環境遷移至另一個環境的腳本或程式碼，做為部署或遷移其他應用程式的大型自動化流程的一部分。

詳情請參閱 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 憑證取得權杖，請按照下列步驟操作：

授權 gcloud 使用您的 Google 使用者憑證存取 Cloud Platform：
```
gcloud auth login
```

取得目前有效帳戶的權杖：

export TOKEN=$(gcloud auth print-access-token)

呼叫 Apigee API 時，請在授權標頭中傳遞存取權杖。例如：

curl "https://apigee.googleapis.com/v1/organizations" -H "Authorization: Bearer $TOKEN"

使用 Google Cloud 服務帳戶金鑰取得權杖

如要使用服務帳戶金鑰取得權杖以進行授權，請按照下列步驟操作：

請按照「建立及管理服務帳戶金鑰」一文的說明，使用 GCP 主控台為服務帳戶產生金鑰。
系統會將含有服務帳戶憑證的 JSON 檔案下載到您的電腦。
將 GOOGLE_APPLICATION_CREDENTIALS 環境變數設為服務帳戶金鑰所在的路徑：
```
export GOOGLE_APPLICATION_CREDENTIALS=your_sa_credentials_file.json
```

呼叫 Apigee API 時，請使用 Google Cloud CLI 將存取權杖新增至授權標頭。例如：

curl "https://apigee.googleapis.com/v1/organizations" -H "Authorization: Bearer $(gcloud auth application-default print-access-token)"

設定 Apigee API 要求的環境變數

本說明文件中提供的 Apigee API 和 gcloud CLI 範例，會使用下表中定義的一或多個環境變數。

只要在環境中預先將環境變數設為有意義的值，您就可以複製及貼上範例要求，在自己的環境中執行，而無需或幾乎不需要進行修改。

環境變數	說明
`$API`	API Proxy 的名稱。
`$APIPRODUCT`	API 產品的名稱。
`$APP`	應用程式 ID。
`$DEVELOPER_EMAIL`	開發人員的電子郵件地址。
`$ENV`	環境名稱，例如 `test` 或 `prod`。
`$ID`	資源 ID。
`$KEY`	用戶端金鑰。
`$NAME`	資源名稱。
`$ORG`	您的 Apigee 機構。
`$REV`	API Proxy 的修訂版本號碼。
`$SHAREDFLOW`	共用流程的名稱。
`$TYPE`	資源類型。

使用 curl

本節的範例使用 curl 示範如何使用 Apigee API 開發應用程式。curl 是一款開放原始碼的命令列工具，可透過網址語法傳輸資料，並支援 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 存取權憑證一文所述。