使用 API 購買及管理 API 產品訂閱項目

本頁內容適用於 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 說明文件。

如要建構自己的自訂入口網站或手動管理購買程序，請參閱下列各節，瞭解如何使用 API 購買及管理 API 產品訂閱項目。另請參閱「在 Drupal 型開發人員入口網站中整合 Apigee 營利功能」。

透過 API 訂閱 API 產品

如要訂閱 API 產品，請對下列 API 發出 POST 要求： https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions

在要求主體中傳遞必要欄位，設定 API 產品訂閱要求，詳情請參閱「資源：訂閱項目」。

舉例來說，下列 API 呼叫會為指定開發人員購買 HelloworldProduct API 產品的訂閱方案： 

curl "https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{"apiproduct":"HelloworldProduct"}'

其中 $TOKEN 會設為您的 OAuth 2.0 存取權杖，如「取得 OAuth 2.0 存取權杖」一文所述。如要瞭解本範例使用的 curl 選項，請參閱「使用 curl」。如要瞭解可使用的環境變數，請參閱為 Apigee API 要求設定環境變數。

以下是回應輸出內容的範例。「startTime」設為目前時間。

{
   "name": "69f8bb42-a8e4-4a2c-b932-d82b51d37b72",
   "apiproduct": "HelloworldProduct",
   "startTime": "1615987132000",
   "createdAt": "1615903252000",
   "lastModifiedAt": "1615903252000"
}

詳情請參閱 Purchase API 產品訂閱 API

立即終止 API 產品訂閱方案

如要立即終止 API 產品訂閱，請對下列 API 發出 POST 要求： https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions/$SUBSCRIPTION:expire

舉例來說，下列 API 呼叫會為指定開發人員，將名為 69f8bb42-a8e4-4a2c-b932-d82b51d37b72 的 API 產品訂閱項目設為過期： 

curl "https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions/69f8bb42-a8e4-4a2c-b932-d82b51d37b72:expire" \
  -X POST \
  -H "Authorization: Bearer $TOKEN"

其中 $TOKEN 會設為您的 OAuth 2.0 存取權杖，如「取得 OAuth 2.0 存取權杖」一文所述。如要瞭解本範例使用的 curl 選項，請參閱「使用 curl」。如要瞭解可使用的環境變數，請參閱為 Apigee API 要求設定環境變數。

以下是回應輸出內容的範例。「endTime」設為目前時間。

{
  "name": "33f8dd42-c7x5-3s3f-b098-d=c93h22m36b47",
  "apiproduct": "WeatherReport",
  "startTime": "1613494852000",
  "endTime" : "1617894954000",
  "createdAt": "1613494852000",
  "lastModifiedAt": "1613494852000"
}

列出開發人員的所有 API 產品訂閱項目

如要列出開發人員的所有 API 產品訂閱項目，請對下列 API 發出 GET 要求： https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions

您也可以選擇傳遞下列欄位，支援分頁功能：

  • startKey，指定要從哪個 API 產品訂閱項目開始顯示訂閱項目清單。如果省略此引數，清單會從第一個項目開始。 搭配 count 使用，可提供更精確的篩選條件。 舉例來說，如要查看第 51 到 150 個 API 產品訂閱項目，請將 startKey 的值設為第 51 個訂閱項目的名稱，並將 count 的值設為 100。
  • count，指定要在 API 呼叫中傳回的費率方案數量。搭配 startKey 使用，可提供更精確的篩選條件。上限為 1000。預設值為 100。

舉例來說，下列 API 呼叫會列出指定開發人員的所有 API 產品訂閱項目： 

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

其中 $TOKEN 會設為您的 OAuth 2.0 存取權杖，如「取得 OAuth 2.0 存取權杖」一文所述。如要瞭解本範例使用的 curl 選項，請參閱「使用 curl」。如要瞭解可使用的環境變數，請參閱為 Apigee API 要求設定環境變數。

以下是回應輸出內容的範例：

{
  "developerSubscriptions": [
    {
      "name": "69f8bb42-a8e4-4a2c-b932-d82b51d37b72",
      "apiproduct": "HelloworldProduct",
      "startTime": "1615987132000",
      "createdAt": "1615903252000",
      "lastModifiedAt": "1615903252000"
    },
    {
      "name": "33f8dd42-c7x5-3s3f-b098-d=c93h22m36b47",
      "apiproduct": "WeatherReport",
      "startTime": "1614124552000",
      "createdAt": "1613494852000",
      "lastModifiedAt": "1613494852000"
    }
  ]
}

詳情請參閱「列出 API 產品訂閱項目 API」。

查看 API 產品訂閱的詳細資料

如要查看開發人員的 API 產品訂閱詳細資料，請對下列 API 發出 GET 要求： https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions/$SUBSCRIPTION

舉例來說，下列 API 呼叫會列出指定開發人員的所有 API 產品訂閱項目： 

curl "https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions/69f8bb42-a8e4-4a2c-b932-d82b51d37b72" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

其中 $TOKEN 會設為您的 OAuth 2.0 存取權杖，如「取得 OAuth 2.0 存取權杖」一文所述。如要瞭解本範例使用的 curl 選項，請參閱「使用 curl」。如要瞭解可使用的環境變數，請參閱為 Apigee API 要求設定環境變數。

以下是回應輸出內容的範例：

{
   "name": "69f8bb42-a8e4-4a2c-b932-d82b51d37b72",
   "apiproduct": "HelloworldProduct",
   "startTime": "1615987132000",
   "createdAt": "1615903252000",
   "lastModifiedAt": "1615903252000"
}

詳情請參閱「取得 API 產品訂閱項目 API」。