Kelola mata uang yang didukung

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

Pengantar

Sebagai bagian dari penyiapan awal monetisasi, tim konfigurasi Apigee Edge mengonfigurasi mata uang dan mata uang default yang didukung oleh organisasi Anda.

Anda dapat melihat mata uang yang didukung organisasi Anda, menambahkan mata uang yang didukung, atau menghapus mata uang yang didukung (jika mata uang tidak digunakan oleh developer atau paket tarif).

Mengelola mata uang yang didukung menggunakan UI

Kelola mata uang yang didukung dan tetapkan mata uang default di Pajak dan Mata Uang laman Profil Organisasi. Lihat Mengelola profil organisasi menggunakan UI untuk mengetahui detailnya.

Mengelola mata uang yang didukung menggunakan API

Mengelola mata uang yang didukung menggunakan API, seperti yang dijelaskan di bagian berikut.

Melihat mata uang yang didukung menggunakan API

Melihat masing-masing mata uang yang didukung oleh organisasi Anda atau semua mata uang didukung oleh organisasi Anda.

Untuk melihat setiap mata uang yang didukung oleh organisasi Anda, kirimkan permintaan GET ke /mint/organizations/{org_name}/supported-currencies/{supportedCurrencyId}, dengan {supportedCurrency_id} adalah identifikasi mata uang yang didukung untuk dilihat. Contoh:

curl -X GET -H "Accept: application/json"  \
  "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies/usd" \
-u email:password

Untuk melihat semua mata uang yang didukung oleh organisasi Anda, kirimkan permintaan GET ke /mint/organizations/{org_name}/supported-currencies. Contoh:

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies" \
  -H "Accept: application/json"  \
-u email:password

Berikut ini contoh responsnya:

{
"supportedCurrency" : [ {
    "description" : "US Dollar",
    "displayName" : "US Dollar",
    "id" : "usd",
    "name" : "USD",
    "organization" : {
      ...
    "status" : "ACTIVE",
    "virtualCurrency" : false
  }, {
    "creditLimit" : 5000.0000,
    "description" : "Euro",
    "displayName" : "Euro",
    "id" : "eur",
    "name" : "EUR",
    "organization" : {
      ...
    },
    "status" : "INACTIVE",
    "virtualCurrency" : false  
  } ],
  "totalRecords" : 2
}

Menyetel mata uang default menggunakan API

Tetapkan mata uang default untuk organisasi dengan menetapkan nilai currency ke mata uang ISO 4217 yang didukung kode saat Anda mengedit profil organisasi, seperti yang dijelaskan dalam Mengelola organisasi menggunakan API.

Mengedit mata uang yang didukung menggunakan API

Edit mata uang yang didukung dengan mengeluarkan permintaan PUT ke /mint/organizations/{org_name}/{supportedCurrencyId}, dengan {supportedCurrency_id} adalah identifikasi mata uang yang didukung untuk diperbarui. Anda harus menentukan properti yang diperbarui dalam isi permintaan serta ID mata uang yang didukung. Misalnya, panggilan API berikut mengedit deskripsi dan nama tampilan untuk mata uang yang didukung (properti yang diperbarui disorot dalam contoh):

curl -H "Content-Type: application/json" -X PUT -d \
  '{
     "description": "United States Dollar",
     "displayName": "United States Dollar",
     "id": "usd",
     "name": "USD",
     "organization": {
       "id": "{org_name}"
     },
     "status" : "ACTIVE",
     "virtualCurrency": "false"
  }' \
  "https://api.enterprise.apigee.com/v1/mint/organization/{org_name}/supported-currencies/usd" -d \
  -u email:password

Menghapus mata uang yang didukung menggunakan API

Hapus mata uang yang didukung dengan mengeluarkan permintaan DELETE ke /mint/organizations/{org_name}/supported-currencies/{currency_id}, dengan {currency_id} adalah identifikasi mata uang yang didukung yang akan dihapus. Contoh:

curl -X DELETE -H "Accept: application/json"  \
  "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies/usd" \
  -u email:password

Properti konfigurasi mata uang untuk API

Tabel berikut meringkas properti konfigurasi yang dapat ditetapkan menggunakan API.

Nama Deskripsi Default Wajib?
creditLimit

Properti ini hanya berlaku untuk developer pascabayar. Batas kredit untuk mata uang yang didukung.

T/A Tidak
deskripsi

Deskripsi mata uang yang didukung.

T/A Ya
Nama Tampilan

Nama yang akan ditampilkan untuk mata uang yang didukung.

T/A Ya
minimumTopupAmount

Properti ini hanya berlaku untuk developer prabayar. Jumlah minimum yang dapat ditambahkan developer ke saldo akun prabayar mereka dalam mata uang yang ditentukan.

T/A Tidak
nama

Kode ISO 4217 untuk mata uang, seperti USD untuk dolar Amerika Serikat.

T/A Ya
organisasi

Organisasi untuk mata uang yang didukung.

T/A Ya
status

Status mata uang yang didukung. Nilai yang valid mencakup:

  • AKTIF: Mata uang yang didukung tersedia untuk digunakan.
  • TIDAK AKTIF: Mata uang yang didukung tidak dapat digunakan.
T/A Ya
virtualCurrency

Menunjukkan apakah mata uang yang didukung adalah mata uang virtual. Nilai yang valid mencakup:

  • true: Mata uang yang didukung adalah mata uang virtual.
  • false: Mata uang yang didukung bukan mata uang virtual.
T/A Ya