Anda sedang melihat dokumentasi Apigee Edge.
Buka
dokumentasi Apigee X. info
Monetisasi menyediakan sekumpulan API yang dapat Anda gunakan untuk membatalkan penangguhan developer yang sebelumnya ditangguhkan, seperti yang dijelaskan di bagian berikut. Developer mungkin ditangguhkan jika mencapai batas yang dikonfigurasi. Misalnya, jumlah transaksi telah mencapai batas maksimumnya atau saldo akun prabayar telah habis. Untuk mengetahui daftar lengkap kode alasan, lihat Ringkasan kode alasan untuk developer yang ditangguhkan.
Melihat semua developer yang ditangguhkan yang menggunakan API
Lihat semua developer yang ditangguhkan untuk sebuah organisasi dengan mengajukan permintaan GET ke resource berikut: /organizations/{org_name}/suspended-developers
.
Dengan keterangan:
{org_name}
menentukan nama organisasi.
Misalnya, panggilan cURL berikut mencantumkan semua developer yang ditangguhkan untuk
myorg
:
curl -H "Content-Type: application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/suspended-developers" \ -u email:password
Berikut adalah contoh respons:
[ { "creationDate": 1464388723633, "devId": "myorg@@@6Vro7VnjUhpGVn3p", "id": "myorg-myorg@@@6Vro7VnjUhpGVn3p-myorg@@@myproduct-null-RATE_PLAN_RATE_BAND_EXCEEDED", "message": "mint.productHasBeenSuspended for myorg@@@6Vro7VnjUhpGVn3p myorg@@@myproduct due to RATE_PLAN_RATE_BAND_EXCEEDED", "orgId": "myorg", "prodId": "myorg@@@myproduct", "reasonCode": "RATE_PLAN_RATE_BAND_EXCEEDED" }, { "creationDate": 1464022846293, "devId": "myorg@@@vXh7LXxtUy9COVdy", "id": "myorg-myorg@@@vXh7LXxtUy9COVdy-myorg@@@myproduct-null-NO_CURRENT_PUBLISHABLE_ENTITY", "message": "mint.productHasBeenSuspended for myorg@@@vXh7LXxtUy9COVdy myorg@@@myproduct due to mint.noCurrentPublishableEntity", "orgId": "myorg", "prodId": "myorg@@@myproduct", "reasonCode": "NO_CURRENT_PUBLISHABLE_ENTITY" } ]
Melihat developer yang ditangguhkan menggunakan API
Lihat developer yang ditangguhkan untuk sebuah organisasi dengan mengajukan permintaan GET ke resource berikut: /organizations/{org_name}/suspended-developers/{developer_email_or_id}
.
Dengan keterangan:
{org_name}
menentukan nama organisasi.{developer_email_or_id}
menentukan ID developer. Untuk melihat daftar developer, lihat Developer Daftar.
Misalnya, panggilan cURL berikut mencantumkan detail untuk joe@example.com
developer yang ditangguhkan:
curl -H "Content-Type: application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/suspended-developers/joe@example.com" \ -u email:password
Berikut adalah contoh respons:
[ { "creationDate": 1464388723633, "devId": "myorg@@@6Vro7VnjUhpGVn3p", "id": "myorg-myorg@@@6Vro7VnjUhpGVn3p-myorg@@@myproduct-null-RATE_PLAN_RATE_BAND_EXCEEDED", "message": "mint.productHasBeenSuspended for myorg@@@6Vro7VnjUhpGVn3p myorg@@@myproduct due to RATE_PLAN_RATE_BAND_EXCEEDED", "orgId": "myorg", "prodId": "myorg@@@myproduct", "reasonCode": "RATE_PLAN_RATE_BAND_EXCEEDED" } ]
Membatalkan penangguhan semua developer untuk produk API menggunakan API
Batalkan penangguhan semua developer yang telah ditangguhkan untuk produk API dengan mengeluarkan permintaan POST
ke resource berikut:
/organizations/{org_name}/suspended-developers/unsuspend-by-product/{suspendedProduct_id}
.
Dengan keterangan:
{org_name}
menentukan nama organisasi.{suspendedProduct_id}
menentukan ID produk API, menggunakan format yang mirip dengan berikut ini:{org_id}@@@{product_id}
. Nilai ini ditampilkan sebagaiprodId
saat Anda melihat semua atau developer yang ditangguhkan tertentu, seperti yang dijelaskan dalam Melihat semua developer yang ditangguhkan menggunakan API dan Melihat developer yang ditangguhkan menggunakan API.
Misalnya, panggilan cURL berikut membatalkan penangguhan semua developer untuk produk API
myorg@@@myproduct
:
curl -H "Content-Type: application/json" -X POST \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/suspended-developers/unsuspend-by-product/myorg@@@myproduct" \ -u email:password
Membatalkan penangguhan developer menggunakan API
Batalkan penangguhan developer tertentu yang telah ditangguhkan dengan mengeluarkan permintaan DELETE ke resource berikut: /organizations/{org_name}/suspended-developers/{suspendedDev_id}.
Dengan keterangan:
{org_name}
menentukan nama organisasi.{suspendedDev_id}
menentukan ID developer yang ditangguhkan, menggunakan format yang mirip dengan berikut:{org_id}@@@{dev_id}
. Nilai ini ditampilkan sebagaidevId
saat Anda melihat semua atau developer yang ditangguhkan tertentu, seperti yang dijelaskan dalam Melihat semua developer yang ditangguhkan menggunakan API dan Melihat developer yang ditangguhkan menggunakan API.
Secara opsional, Anda dapat meneruskan parameter kueri berikut:
Parameter Kueri | Deskripsi |
---|---|
suspendedProduct_id |
ID produk API, menggunakan format yang mirip dengan berikut ini:
{org_id}@@@{product_id} . Nilai ini ditampilkan sebagai prodId saat Anda melihat semua developer atau developer yang ditangguhkan tertentu, seperti yang dijelaskan dalam Melihat semua developer yang ditangguhkan menggunakan API dan Melihat developer yang ditangguhkan menggunakan API. |
Misalnya, panggilan cURL berikut membatalkan penangguhan developer dengan ID
myorg@@@6Vro7VnjUhpGVn3p
untuk produk API myorg@@@myproduct
:
curl -H "Content-Type: application/json" -X DELETE \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/suspended-developers/myorg@@@6Vro7VnjUhpGVn3p?productId=myorg@@@myproduct" \ -u email:password
Ringkasan kode alasan untuk developer yang ditangguhkan
Tabel berikut merangkum kode alasan yang menunjukkan mengapa developer ditangguhkan.
Kode alasan | Deskripsi |
---|---|
INSUFFICIENT_FUNDS |
Akun developer telah habis. |
LIMIT_VIOLATED |
Batas yang dikonfigurasi untuk akun developer telah tercapai. |
NO_CURRENT_PUBLISHABLE_ENTITY |
Developer belum menyetujui (berlangganan) paket tarif. |
RATE_PLAN_RATE_BAND_EXCEEDED |
Batas band volume akhir yang dikonfigurasi telah tercapai. |