Halaman ini diterjemahkan oleh Cloud Translation API.

Membeli dan mengelola langganan produk API menggunakan API

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Jika Anda ingin membuat portal kustom sendiri atau mengelola proses pembelian secara manual, berikut adalah menjelaskan cara membeli dan mengelola langganan produk API menggunakan API. Lihat juga Mengintegrasikan monetisasi Apigee di portal developer berbasis Drupal.

Membeli langganan produk API menggunakan API

Untuk membeli langganan produk API, berikan permintaan POST ke API berikut: https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions

Konfigurasi permintaan langganan produk API dengan meneruskan kolom wajib diisi dalam isi permintaan, seperti yang dijelaskan dalam Referensi: Langganan.

Misalnya, panggilan API berikut membeli langganan produk HelloworldProduct API untuk developer tertentu:

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"}'

Jika $TOKEN ditetapkan ke token akses OAuth 2.0 Anda, seperti yang dijelaskan di Mendapatkan token akses OAuth 2.0. Untuk mengetahui informasi tentang opsi curl yang digunakan dalam contoh ini, lihat Menggunakan curl. Untuk deskripsi tentang variabel lingkungan yang digunakan, lihat Menetapkan variabel lingkungan untuk permintaan API Apigee.

Berikut ini contoh output respons. startTime disetel ke waktu saat ini.

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

Untuk informasi selengkapnya, lihat API langganan produk API Pembelian

Segera berakhir langganan produk API

Untuk segera mengakhiri langganan produk API, kirimkan permintaan POST ke API berikut: https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions/$SUBSCRIPTION:expire

Misalnya, panggilan API berikut akan mengakhiri langganan produk API dengan nama 69f8bb42-a8e4-4a2c-b932-d82b51d37b72 untuk developer tertentu:

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

Berikut ini contoh output respons. endTime disetel ke waktu saat ini.

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

Mencantumkan semua langganan produk API untuk developer

Untuk menampilkan daftar semua langganan produk API bagi developer, berikan permintaan GET ke API berikut: https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions

Secara opsional, Anda dapat meneruskan kolom berikut untuk mendukung penomoran halaman:

startKey untuk menentukan nama langganan produk API yang digunakan untuk mulai menampilkan daftar langganan. Jika dihilangkan, daftar dimulai dari item pertama. Gunakan dengan count untuk memberikan pemfilteran yang lebih bertarget. Misalnya, untuk melihat langganan produk API dari 51-150, setel nilai startKey ke nama dari langganan ke-51 dan setel nilai count ke 100.
count untuk menentukan jumlah paket tarif yang akan ditampilkan dalam panggilan API. Gunakan dengan startKey untuk memberikan pemfilteran yang lebih bertarget. Batas maksimumnya adalah 1.000. Setelan defaultnya adalah 100.

Misalnya, panggilan API berikut mencantumkan semua langganan produk API untuk developer tertentu:

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

Berikut ini contoh output respons:

{
  "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"
    }
  ]
}

Untuk informasi selengkapnya, lihat API langganan produk List API.

Melihat detail tentang langganan produk API

Untuk melihat detail tentang langganan produk API bagi developer, berikan permintaan GET ke API berikut: https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions/$SUBSCRIPTION

Misalnya, panggilan API berikut mencantumkan semua langganan produk API untuk developer tertentu:

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

Berikut ini contoh output respons:

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

Untuk informasi selengkapnya, lihat Mendapatkan API langganan produk API.