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, 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 bagian Pajak dan Mata Uang di halaman Profil Organisasi. Lihat Mengelola profil organisasi menggunakan UI untuk mengetahui detailnya.

Mengelola mata uang yang didukung menggunakan API

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

Melihat mata uang yang didukung menggunakan API

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

Untuk melihat mata uang individual yang didukung oleh organisasi Anda, buat 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 adalah contoh respons:

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

Menambahkan mata uang yang didukung menggunakan API

Tambahkan mata uang yang didukung dengan mengajukan permintaan POST ke /mint//organizations/{org_name}/supported-currencies. Untuk setiap mata uang yang didukung yang Anda tambahkan, Anda harus menentukan informasi berikut dalam isi permintaan:

  • Nama mata uang yang didukung. Namanya adalah kode ISO 4217 untuk mata uang, seperti USD untuk dolar Amerika Serikat.
  • Nama tampilan.
  • Deskripsi.
  • Apakah mata uang tersebut merupakan mata uang virtual atau tidak.
  • Status mata uang, yaitu apakah mata uang tersedia untuk digunakan atau tidak.
  • Organisasi yang mata uangnya didukung akan ditambahkan.

Secara opsional, Anda dapat menyetel:

  • Batas kredit untuk mata uang yang didukung (khusus developer pascabayar).
  • Penambahan saldo minimum untuk mata uang yang didukung (khusus developer prabayar).

Lihat Properti konfigurasi mata uang yang didukung untuk mengetahui informasi selengkapnya.

Misalnya, kode berikut menambahkan mata uang yang didukung untuk organisasi:

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

Menetapkan mata uang default menggunakan API

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

Mengedit mata uang yang didukung menggunakan API

Edit mata uang yang didukung dengan mengajukan permintaan PUT ke /mint/organizations/{org_name}/{supportedCurrencyId}, dengan {supportedCurrency_id} merupakan identifikasi mata uang yang didukung yang akan diperbarui. Anda perlu menentukan properti yang diperbarui serta ID mata uang yang didukung dalam isi permintaan. Misalnya, panggilan API berikut akan mengedit deskripsi dan nama tampilan untuk mata uang yang didukung (properti yang diperbarui ditandai 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 merangkum 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 tersedia untuk 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