Memberikan kredit

Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X. info

Pengantar

Monetisasi memberi Anda fleksibilitas untuk menerbitkan kredit developer.

Untuk developer prabayar, kredit akan muncul sebagai pengurangan penggunaan — hal ini akan meningkatkan atau menurunkan saldo prabayar developer ke depannya. Sama seperti menggunakan kartu debit, dana akan ditarik dari saldo prabayar developer saat developer membeli paket produk API. Developer harus mempertahankan saldo yang memadai untuk pembelian. Lihat Bagaimana cara menghitung sisa saldo akun prabayar?

Untuk developer pascabayar, kredit akan muncul sebagai baris terpisah dalam invoice, sehingga mengurangi tagihan dalam invoice.

Menjelajahi halaman Kredit

Akses dan jelajahi halaman Kredit, seperti yang dijelaskan di bawah.

Memberikan kredit

1. Akses halaman Kredit.
2. Klik + Kredit.
3. Masukkan informasi berikut:

   Kolom	Deskripsi
   Bulan Penagihan	Bulan penagihan saat kredit berlaku. Pilih bulan dari daftar.
   Developer	Nama developer atau perusahaan yang diberikan kredit. Masukkan nama di kotak teks. Saat Anda mengetik, daftar developer/perusahaan yang berisi string akan ditampilkan dalam drop-down. Klik nama developer atau perusahaan dari menu drop-down. Catatan: Setelah 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 yang akan menerima kredit. Pilih Semua Produk atau satu produk API dari daftar.
   Mata Uang	Mata uang yang digunakan untuk kredit. Mata uang dikonfigurasi untuk paket tarif dalam paket produk API yang dibeli developer dan tidak dapat diubah. Jika ada beberapa mata uang yang ditentukan dalam paket tarif, Anda dapat memilih salah satu mata uang.
   Jumlah	Jumlah kredit (dalam mata uang yang ditentukan). Tentukan nilai positif atau negatif. Nilai tidak boleh nol.
   Catatan	Catatan opsional untuk menjelaskan alasan kredit.

4. Klik Simpan Saldo.

Memberikan kredit menggunakan API

Dengan menggunakan API, berikan kredit kepada developer untuk paket produk API secara keseluruhan, atau untuk penggunaan produk API tertentu dalam paket produk API.

Untuk menerbitkan kredit menggunakan API, buat 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} menentukan identifikasi paket produk API dan paket tarif yang berlaku untuk kredit.

Saat mengeluarkan permintaan, Anda harus menentukan 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 yang berlaku untuk kredit. Nilai ini ditetapkan secara default ke bulan saat ini.
• Tahun penagihan yang berlaku untuk kredit. Nilai ini ditetapkan secara default ke tahun berjalan.
• Produk API tempat kredit berlaku. Jika Anda tidak menentukan ID produk API, kredit akan berlaku untuk semua produk API dalam paket produk API.

Misalnya, permintaan berikut menerbitkan kredit sebesar $100 untuk bulan penagihan April 2018 kepada developer yang diidentifikasi sebagai dev1@myorg.com. Kredit berlaku untuk paket produk payment API dan paket tarif payment_standard_plan:

Lihat Parameter kueri untuk API kredit 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 API kredit:

Nama	Deskripsi	Default	Wajib?
billingMonth	Bulan penagihan yang berlaku untuk kredit, seperti APRIL.	T/A	Tidak
billingYear	Tahun penagihan yang berlaku untuk kredit, seperti 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 developer atau perusahaan yang diberikan kredit.	T/A	Ya
productId	Produk API yang menerapkan 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 ini menjelaskan alasan kredit diberikan.	T/A	Ya