Anda sedang melihat dokumentasi Apigee Edge.
Buka
dokumentasi Apigee X. info
Pengantar
Monetisasi memberi Anda fleksibilitas untuk memberikan kredit developer.
Untuk developer prabayar, kredit muncul sebagai pengurangan penggunaan — hal ini meningkatkan atau mengurangi saldo prabayar developer ke depannya. Mirip dengan penggunaan kartu debit, dana ditarik dari saldo prabayar developer saat developer membeli paket produk API. Developer harus menjaga keseimbangan yang memadai untuk pembelian. Lihat Bagaimana cara menghitung sisa saldo akun prabayar?
Untuk developer pascabayar, kredit muncul sebagai baris terpisah dalam invoice, sehingga mengurangi tagihan dalam invoice.
Menjelajahi halaman Kredit
Akses dan jelajahi halaman Kredit, seperti yang dijelaskan di bawah ini.
Edge
Untuk mengakses halaman Credits menggunakan Edge UI:
- Login ke apigee.com/edge.
- Pilih Publikasikan > Monetisasi > Kredit di menu navigasi sebelah kiri.
Halaman Kredit akan ditampilkan.
Seperti yang disorot dalam gambar, laman Kredit memungkinkan Anda untuk:
- Lihat informasi ringkasan untuk semua kredit, termasuk nama penerima, jumlah kredit, tanggal dan waktu kredit berlaku, paket produk API dan produk API yang diberikan kredit, serta catatan apa pun yang ditambahkan
- Memberikan kredit
- Telusuri daftar kredit
Edge Klasik (Private Cloud)
Untuk mengakses halaman Kredit menggunakan UI Edge Klasik:
- Login ke
http://ms-ip:9000
, dengan ms-ip yang merupakan alamat IP atau nama DNS node Server Pengelolaan. - Pilih Monetisasi > Laporan Monetisasi di menu navigasi atas.
Halaman Kredit memungkinkan Anda untuk:
- Lihat informasi ringkasan untuk semua kredit, termasuk nama penerima, jumlah kredit, tanggal dan waktu kredit berlaku, paket produk API dan produk API yang diberikan kredit, serta catatan apa pun yang ditambahkan
- Memberikan kredit
- Telusuri daftar kredit
Memberikan kredit
- Akses halaman Kredit.
- Klik + Kredit.
- Masukkan informasi berikut:
Kolom Deskripsi Bulan Penagihan Bulan penagihan saat kredit berlaku. Pilih bulan dari daftar.
Developer Nama perusahaan atau developer yang menerima kredit. Masukkan nama di kotak teks. Saat Anda mengetik, daftar developer/perusahaan yang berisi string akan ditampilkan di menu drop-down. Klik nama developer atau perusahaan dari menu drop-down.
Catatan: Setelah Anda memilih developer atau perusahaan, kolom yang tersisa akan ditampilkan. Jika memilih perusahaan atau developer yang belum menerima paket tarif, Anda tidak dapat menerbitkan kredit.
Paket Produk Paket produk API yang berlaku untuk kredit. Pilih dari daftar paket produk API yang tersedia.
Produk Produk API dalam paket produk API yang dipilih tempat kredit diterapkan. Pilih Semua Produk atau satu produk API dari daftar.
Mata uang Mata uang yang digunakan untuk kredit. Mata uang dikonfigurasi untuk paket tarif di paket produk API yang dibeli oleh developer dan tidak dapat diubah. Jika ada beberapa mata uang yang ditentukan dalam paket tarif, Anda dapat memilih salah satu mata uang tersebut.
Jumlah Jumlah kredit (dalam mata uang yang ditentukan). Tentukan nilai positif atau negatif. Nilai tidak boleh nol.
Catatan Catatan opsional untuk menjelaskan alasan kredit.
- Klik Simpan Kredit.
Memberikan kredit menggunakan API
Dengan API, berikan kredit kepada developer atas paket produk API secara keseluruhan, atau untuk penggunaan produk API tertentu dalam paket produk API.
Untuk mengeluarkan kredit menggunakan API, kirimkan permintaan POST ke
/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{rate-plan_id}/real-currency-credit-transactions
,
dengan {package_id}
dan {rate-plan_id}
masing-masing menentukan
identifikasi paket produk API dan paket tarif yang berlaku untuk kredit tersebut.
Saat mengajukan permintaan, Anda harus menentukannya sebagai parameter kueri:
- ID Developer (alamat email) yang menerima kredit.
- Jumlah kredit.
- Mata uang yang digunakan untuk kredit.
- Catatan yang menjelaskan alasan kredit.
Secara opsional, Anda dapat menentukan parameter kueri tambahan berikut:
- Bulan penagihan saat kredit diterapkan. Nilai ini ditetapkan secara default ke bulan berjalan.
- Tahun penagihan saat kredit berlaku. Nilai ini ditetapkan secara default ke tahun berjalan.
- Produk API yang berlaku untuk kredit. Jika Anda tidak menentukan ID produk API, kredit akan berlaku untuk semua produk API dalam paket produk API.
Misalnya, permintaan berikut memberikan kredit sebesar $100 untuk bulan penagihan April 2018
kepada developer yang diidentifikasi sebagai dev1@myorg.com
. Kredit ini berlaku untuk
paket produk payment
API dan paket tarif payment_standard_plan
:
Lihat Parameter kueri untuk kredit API untuk mengetahui daftar lengkap parameter kueri yang dapat Anda tentukan dalam permintaan kredit.
$ curl -H "Content-Type:application/json" -X POST \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/payment/rate-plans/payment_standard_plan/real-currency-credit-transactions?currencyId=usd&developerId=dev1@myorg.com&transactionAmount=100&transactionNote=Credit+for+failed+transactions&billingMonth=APRIL&billingYear=2013" \ -u email:password
Berikut adalah contoh kutipan respons:
{ "currency" : "USD", "developer" : { "address" : [ { "address1" : "Dev One Address", ... } ], "approxTaxRate" : 0.0000, "billingType" : "PREPAID", "broker" : false, "developerRole" : [ ], "email" : "dev1@myorg.com", "hasSelfBilling" : false, "id" : "K4jW2QLjZ1h8GFA8", "legalName" : "DEV ONE", "name" : "Dev One", "organization" : { ... }, "registrationId" : "TestRegId", "status" : "ACTIVE", "type" : "TRUSTED" }, "endTime" : "2013-09-04 15:54:36", "environment" : "PROD", "euroExchangeRate" : 0.8107, "gbpExchangeRate" : 0.6860, "id" : "904c3f73-ab8d-4e5d-a48c-225fd49a3bde", "isVirtualCurrency" : false, "notes" : "Credit for failed transactions", "pkgId" : "myorg@@@payment", "pkgRatePlanProductName" : "Payment", "providerTxId" : "904c3f73-ab8d-4e5d-a48c-225fd49a3bde", "rate" : 100, "ratePlan" : { ... }, "status" : "ACTIVE", "virtualCurrency" : false }, "description" : "Standard Plan", "displayName" : "Standard Plan", … "monetizationPackage" : { "description" : "Payment", ... } ], ... }, "product" : [ { "customAtt1Name" : "user", "description" : "Payment", "displayName" : "Payment", "id" : "payment", "name" : "payment", "organization" : { ... }, "status" : "CREATED", "transactionSuccessCriteria" : "Status=='200 OK'" } ], "status" : "CREATED" }, "name" : "Standard Plan", "organization" : { ... }, ... }, ... }, ... }, "revenueShareAmount" : 0, "startTime" : "2013-09-04 15:54:36", "status" : "SUCCESS", "taxModel" : "UNDISCLOSED", "txProviderStatus" : "SUCCESS", "type" : "CREDIT", "usdExchangeRate" : 1.0675, "utcEndTime" : "2013-09-04 15:54:36", "utcStartTime" : "2013-09-04 15:54:36" }
Parameter kueri untuk credit API
Parameter kueri berikut tersedia untuk digunakan dengan credit API:
Nama | Deskripsi | Default | Wajib diisi? |
---|---|---|---|
billingMonth |
Bulan penagihan saat kredit diterapkan, seperti APRIL. |
T/A | Tidak |
billingYear |
Tahun penagihan saat kredit diterapkan, misalnya 2018. |
T/A | Tidak |
currencyId |
Mata uang yang digunakan untuk kredit. Mata uang dikonfigurasi untuk paket tarif di paket produk API yang dibeli oleh developer dan tidak dapat diubah. |
T/A | Ya |
developerId |
Nama perusahaan atau developer yang menerima kredit. |
T/A | Ya |
productId |
Produk API yang berlaku untuk kredit. Jika Anda tidak menentukan ID produk, kredit akan berlaku untuk semua produk API dalam paket produk API. |
T/A | Tidak |
transactionAmount |
Jumlah kredit (dalam mata uang yang ditentukan). Tentukan nilai positif atau negatif. Nilai tidak boleh nol. |
T/A | Ya |
transactionNote |
Perhatikan bahwa alasan kredit diberikan. |
T/A | Ya |