Anda sedang melihat dokumentasi Apigee Edge.
Buka
Dokumentasi Apigee X. info
Bagian berikut memperkenalkan profil organisasi dan menjelaskan cara mengelolanya menggunakan UI dan API.
Tentang profil organisasi
Sebagai bagian dari penyiapan awal monetisasi, tim konfigurasi Apigee Edge menyiapkan profil organisasi Anda.
Anda perlu mengedit profil organisasi untuk menambahkan atau memperbarui informasi tentang organisasi Anda, sebagaimana diperlukan. Misalnya, Anda mungkin perlu memperbarui jenis penagihan, setelan mata uang, atau model pajak.
Konfigurasi informasi dasar tentang organisasi Anda, termasuk:
- Nama, alamat, dan negara operasional organisasi
- Jenis penagihan (prabayar, pascabayar, atau keduanya), seperti yang dijelaskan di bagian Memahami jenis penagihan
- Siklus penagihan (prorata atau bulan kalender)
- Mata uang dasar
- Model pajak yang digunakan oleh organisasi Anda
Anda dapat mengelola profil organisasi menggunakan UI dan API, seperti yang dijelaskan di bagian berikut ini.
Menjelajahi halaman Profil Organisasi
Akses halaman Profil Organisasi, seperti yang dijelaskan di bawah.
Edge
Untuk mengakses halaman Profil Organisasi menggunakan UI Edge:
- Login ke apigee.com/edge.
- Pilih Publikasikan > Monetisasi > Profil Organisasi di menu navigasi sebelah kiri.
Halaman Profil Organisasi ditampilkan.
Seperti yang disorot dalam gambar, laman Profil Organisasi memungkinkan Anda untuk:
- Melihat setelan profil organisasi saat ini
- Edit setelan profil organisasi, termasuk:
- Nama dan informasi
- Pajak dan mata uang
- Persyaratan dan ketentuan, seperti yang dijelaskan dalam Mengelola persyaratan dan ketentuan
Edge Klasik (Private Cloud)
Untuk mengakses halaman Profil Organisasi menggunakan UI Edge Klasik:
- Login ke
http://ms-ip:9000
, dengan ms-ip sebagai Alamat IP atau nama DNS node Server Pengelolaan. - Pilih Admin > Profil Organisasi di menu navigasi atas.
Halaman Profil Organisasi ditampilkan.
Halaman Profil Organisasi memungkinkan Anda untuk:
- Melihat setelan profil organisasi saat ini
- Edit setelan profil organisasi, termasuk:
- Nama dan informasi
- Pajak dan mata uang
- Persyaratan dan ketentuan, seperti yang dijelaskan dalam Mengelola persyaratan dan ketentuan
Mengedit profil organisasi menggunakan UI
Untuk mengedit profil organisasi menggunakan UI:
- Akses halaman Profil Organisasi.
- Klik Edit.
- Di bagian Nama dan informasi, edit nama organisasi dan negara operasional.
- Di bagian Pajak dan mata uang, edit kolom berikut:
Kolom Deskripsi Model Pajak Catatan: Hanya berlaku jika Anda menyiapkan paket tarif pembagian keuntungan dan ingin untuk membuat dokumen penagihan.
Model pajak untuk paket tarif pembagian keuntungan yang mengidentifikasi jenis dokumen penagihan yang diperlukan.
Nilai yang valid mencakup:
- Diungkap: Penyedia API bertindak sebagai agen yang diungkapkan oleh developer. Pendapatan kotor (termasuk pajak penjualan) yang dikumpulkan dari pengguna akhir adalah diteruskan ke pengembang. Komisi penyedia API dikumpulkan dari developer dalam bentuk invoice komisi. Penyedia API tidak menangani pajak penjualan yang dikumpulkan dari pengguna akhir, dan itu merupakan tanggung jawab pengembang untuk melaporkan pajak penjualan.
- Tidak diungkapkan: Penyedia API bertindak sebagai agen yang tidak diungkapkan pengembang, dan memotong pajak yang dikumpulkan dari pengguna akhir dan membayarnya ke otoritas pajak daerah. Developer menagih penyedia API untuk pendapatan bersih bagi hasil kepada developer (dikurangi pajak penjualan dan komisi).
- Hybrid: Penyedia API bertindak sebagai agen yang diungkapkan dalam developer. Namun, penyedia API membayar pajak penjualan yang dipungut dari pelanggan kepada otoritas pajak setempat atas nama developer. API meneruskan sisa pendapatan kepada pengembang, lalu faktur untuk biaya komisi.
Mata Uang Mata uang yang didukung organisasi Anda. Untuk pembagian keuntungan, kartu tarif, dan paket khusus biaya, mata uang default digunakan untuk paket tarif Anda. Saat membuat kartu tarif atau paket khusus biaya, Anda dapat mengubah mata uang mana digunakan dengan memilih dari daftar mata uang yang didukung. Anda juga dapat menetapkan jumlah penambahan saldo minimum yang dapat ditambahkan developer aplikasi ke saldo akun prabayar mereka untuk setiap mata uang.
Untuk menambahkan mata uang:
- Klik Tambahkan mata uang.
- Pilih mata uang dari menu drop-down di kolom Mata uang.
- Anda juga dapat menetapkan jumlah minimum yang dapat ditambahkan developer aplikasi ke saldo akun prabayar mereka dalam mata uang yang ditentukan di kolom Penambahan saldo minimum.
- Klik Tambahkan.
- Tetapkan sebagai mata uang default, jika diinginkan, dengan mengklik tombol pilihan terkait.
- Ulangi langkah-langkah untuk menambahkan mata uang lainnya.
Untuk menghapus mata uang, posisikan kursor di atas mata uang yang ingin dihapus, lalu klik .
- Kelola persyaratan dan ketentuan, seperti yang dijelaskan dalam Mengelola persyaratan dan ketentuan menggunakan UI.
- Klik Simpan.
Mengelola profil organisasi menggunakan API
Mengelola profil organisasi menggunakan API, seperti yang dijelaskan di bagian berikut.
Melihat profil organisasi menggunakan API
Lihat profil organisasi Anda dengan mengajukan permintaan GET ke
/mint/organizations/{org_name}
. Contoh:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \ -H "Accept: application/json" \ -u email:password
Berikut ini contoh responsnya. Untuk informasi selengkapnya tentang opsi Lihat Properti konfigurasi profil organisasi untuk API.
{ "address" : [ { "address1" : "Test address”, "city" : "Test City", "country" : "US", "id" : "test-address", "isPrimary" : true, "state" : "CA", "zip" : "54321" } ], "approveTrusted" : false, "approveUntrusted" : false, "billingCycle" : "CALENDAR_MONTH", "country" : "US", "currency" : "USD", "description" : "Test organization", "hasBillingAdjustment" : true, "hasBroker" : false, "hasSelfBilling" : false, "hasSeparateInvoiceForProduct" : false, "id" : "{org_name}" "issueNettingStmt" : false, "logoUrl" : " https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg", "name" : "myorg", "nettingStmtPerCurrency" : false, "regNo" : "RegNo-1234-myorg", "selfBillingAsExchOrg" : false, "selfBillingForAllDev" : false, "separateInvoiceForFees" : true, "status" : "ACTIVE", "supportedBillingType" : "PREPAID", "taxModel" : "UNDISCLOSED", "taxRegNo" : "TaxRegNo-1234-myorg", "timezone" : "UTC" }
Mengedit profil organisasi menggunakan API
Edit profil organisasi dengan mengajukan permintaan PUT ke
/mint/organizations/{org_name}
. Saat mengedit profil organisasi, Anda harus menentukan semua
properti profil organisasi, bukan hanya properti yang Anda edit.
Untuk mengedit mata uang default untuk organisasi, tetapkan nilai currency
ke
mata uang ISO 4217
kode mata uang yang didukung yang ingin Anda tetapkan sebagai default.
Misalnya, panggilan API berikut akan memperbarui currency
menjadi USD dan model pajak
ditetapkan ke HYBRID
(kolom yang diperbarui ditandai dalam contoh). Untuk selengkapnya
informasi tentang opsi yang ditampilkan, lihat Konfigurasi profil organisasi
untuk API.
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \ -H "Content-Type: application/json" \ -d '{ "address" : [ { "address1" : "Test address”, "city" : "Test City", "country" : "US", "id" : "corp-address", "isPrimary" : true, "state" : "CA", "zip" : "54321" } ], "approveTrusted" : false, "approveUntrusted" : false, "billingCycle" : "CALENDAR_MONTH", "country" : "US", "currency" : "USD", "description" : "Test organization", "hasBillingAdjustment" : true, "hasBroker" : false, "hasSelfBilling" : false, "hasSeparateInvoiceForProduct" : false, "id" : "myorg", "issueNettingStmt" : false, "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg", "name" : "{org_name}", "nettingStmtPerCurrency" : false, "regNo" : "RegNo-1234-myorg", "selfBillingAsExchOrg" : false, "selfBillingForAllDev" : false, "separateInvoiceForFees" : false, "status" : "ACTIVE", "supportedBillingType" : "POSTPAID", "taxModel" : "HYBRID", "taxRegNo" : "TaxRegNo-1234-myorg", "timezone" : "UTC" }' \ -u email:password
Mengonfigurasi jenis penagihan prabayar dan pascabayar menggunakan API
Akun developer dapat dikonfigurasi untuk menggunakan jenis penagihan berikut: prabayar, pascabayar, atau keduanya.
Dengan akun prabayar, developer membayar di muka untuk penggunaan API Anda. Dana dipotong dari saldo prabayar developer yang dikelola melalui penyedia jasa pembayaran terintegrasi. Developer harus memiliki saldo prabayar yang cukup untuk membeli API.
Dengan akun pascabayar, developer ditagih setiap bulan (melalui invoice) pada akhir bulan. Developer membayar penggunaan produk API berdasarkan persyaratan pembayaran yang ditetapkan oleh paket yang disertakan dalam invoice.
Untuk mengonfigurasi jenis penagihan prabayar dan pascabayar untuk organisasi Anda, tetapkan properti supportedBillingType
ke salah satu
nilai berikut untuk menunjukkan jenis penagihan mana yang valid: PREPAID
, POSTPAID
, atau BOTH
. Jika Anda menetapkan nilai ke BOTH
,
defaultnya adalah PREPAID
saat Anda menambahkan developer aplikasi atau perusahaan. Dalam hal ini, Anda dapat secara eksplisit menetapkan jenis penagihan untuk perusahaan atau developer aplikasi menggunakan API, seperti yang dijelaskan di
Mengelola perusahaan dan developer aplikasi.
Contoh:
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \ -H "Content-Type: application/json" \ -d '{ "address" : [ { "address1" : "Test address", "city" : "Test City", "country" : "US", "id" : "corp-address", "isPrimary" : true, "state" : "CA", "zip" : "54321" } ], "approveTrusted" : false, "approveUntrusted" : false, "billingCycle" : "CALENDAR_MONTH", "country" : "US", "currency" : "USD", "description" : "Test organization", "hasBillingAdjustment" : true, "hasBroker" : false, "hasSelfBilling" : false, "hasSeparateInvoiceForProduct" : false, "id" : "myorg", "issueNettingStmt" : false, "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg", "name" : "{org_name}", "nettingStmtPerCurrency" : false, "regNo" : "RegNo-1234-myorg", "selfBillingAsExchOrg" : false, "selfBillingForAllDev" : false, "separateInvoiceForFees" : false, "status" : "ACTIVE", "supportedBillingType" : "POSTPAID", "taxModel" : "HYBRID", "taxRegNo" : "TaxRegNo-1234-myorg", "timezone" : "UTC" }' \ -u email:password
Mengonfigurasi siklus penagihan menggunakan API
Untuk mengonfigurasi siklus penagihan bagi organisasi Anda, tetapkan properti billingCycle
ke salah satu nilai berikut:
PRORATED
: Penagihan didasarkan pada jumlah hari penggunaan produk API dalam satu bulan kalender.CALENDAR_MONTH
: Penagihan dilakukan setiap bulan.
Contoh:
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \ -H "Content-Type: application/json" \ -d '{ "address" : [ { "address1" : "Test address", "city" : "Test City", "country" : "US", "id" : "corp-address", "isPrimary" : true, "state" : "CA", "zip" : "54321" } ], "approveTrusted" : false, "approveUntrusted" : false, "billingCycle" : "CALENDAR_MONTH", "country" : "US", "currency" : "USD", "description" : "Test organization", "hasBillingAdjustment" : true, "hasBroker" : false, "hasSelfBilling" : false, "hasSeparateInvoiceForProduct" : false, "id" : "myorg", "issueNettingStmt" : false, "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg", "name" : "{org_name}", "nettingStmtPerCurrency" : false, "regNo" : "RegNo-1234-myorg", "selfBillingAsExchOrg" : false, "selfBillingForAllDev" : false, "separateInvoiceForFees" : false, "status" : "ACTIVE", "supportedBillingType" : "POSTPAID", "taxModel" : "HYBRID", "taxRegNo" : "TaxRegNo-1234-myorg", "timezone" : "UTC" }' \ -u email:password
Properti konfigurasi profil organisasi untuk API
Profil organisasi memungkinkan Anda menetapkan properti konfigurasi berikut menggunakan API.
Nama | Deskripsi | Default | Wajib? |
---|---|---|---|
address |
Alamat organisasi, yang dapat mencakup alamat, kota, negara bagian, kode pos kode, negara, dan indikasi apakah ini adalah alamat utama untuk organisasi/pengaturan. |
T/A | Tidak |
approveTrusted |
Tanda ini tidak digunakan. |
T/A | Tidak |
approveUntrusted |
Tanda ini tidak digunakan. |
T/A | Tidak |
billingCycle |
Periode siklus penagihan. Nilainya bisa berupa salah satu dari berikut:
|
T/A | Ya |
country |
Kode ISO 3166-2 untuk negara operasional untuk organisasi, seperti BR untuk Brasil. |
T/A | Ya |
currency |
Kode ISO 4217 untuk "dasar" atau mata uang akuntansi yang digunakan organisasi (seperti USD untuk Amerika Serikat dolar). Untuk paket pembagian keuntungan: Mata uang yang ditentukan digunakan untuk paket Anda. Untuk paket kartu tarif (model pengisian daya): Hal yang sama berlaku untuk paket pembagian keuntungan. Namun, Anda dapat mengubah setelan mata uang ke mata uang apa pun yang didukung oleh organisasi/pengaturan. Untuk paket khusus biaya: Anda dapat mengubah setelan mata uang ke mata uang apa pun yang didukung oleh organisasi. |
T/A | Ya |
description |
Deskripsi singkat organisasi. |
T/A | Tidak |
hasBillingAdjustment |
Tanda yang menentukan apakah penyesuaian diaktifkan. Jika diaktifkan, Anda dapat membuat penyesuaian traffic yang dicatat oleh Layanan API untuk produk API Anda. dapat berupa salah satu dari hal berikut:
|
T/A | Tidak |
hasBroker |
Tanda yang menentukan apakah pendapatan didasarkan pada jaringan bersih. Nilainya bisa salah satu dari hal berikut:
|
T/A | Tidak |
hasSelfBilling |
Tanda yang mengarahkan monetisasi untuk membuat invoice penagihan mandiri, bukan pendapatan pernyataan {i>share<i}. Invoice penagihan mandiri adalah dokumen keuangan yang menjelaskan jumlahnya yang disebabkan oleh pengembang aplikasi. Ini berlaku sebagai invoice bagi Penyedia API atas nama developer aplikasi Anda. Nilainya dapat berupa salah satu dari berikut ini:
|
T/A | Tidak |
hasSeparateInvoiceForProduct |
Tanda yang menentukan apakah invoice terpisah akan dibuat untuk setiap produk API. Tujuan dapat berupa salah satu dari hal berikut:
|
T/A | Tidak |
id |
ID organisasi. |
T/A | Tidak |
issueNettingStmt |
Tanda yang menentukan apakah laporan mutasi jaringan dibuat saat membuat penagihan yang informatif serta dipersonalisasi. Nilainya dapat berupa salah satu dari berikut ini:
|
T/A | Tidak |
logoUrl |
URL logo organisasi. |
T/A | Tidak |
name |
Nama organisasi. |
T/A | Ya |
netPaymentAdviceNote |
Catatan saran pembayaran bersih. |
T/A | Tidak |
nettingStmtPerCurrency |
Tanda yang menentukan apakah pernyataan jaringan terpisah dibuat untuk setiap tanda mata uang yang digunakan. Nilainya dapat berupa salah satu dari berikut ini:
|
T/A | Tidak |
regNo |
Nomor pendaftaran organisasi. Jumlah yang Anda masukkan untuk properti ini adalah yang ditampilkan di bagian bawah dokumen penagihan. |
T/A | Tidak |
selfBillingAsExchOrg |
Jika invoice penagihan mandiri diaktifkan, tunjukkan apakah invoice tersebut diaktifkan untuk penukaran tidak di organisasi lain. Nilainya dapat berupa salah satu dari berikut ini:
|
T/A | Tidak |
selfBillingForAllDev |
Jika invoice penagihan mandiri diaktifkan, tunjukkan apakah invoice tersebut diaktifkan untuk semua developer aplikasi Google. Secara default, invoice penagihan mandiri hanya dibuat untuk developer aplikasi yang memiliki menandatangani perjanjian dengan penyedia API. Nilainya dapat berupa salah satu dari berikut ini:
|
salah | Tidak |
separateInvoiceForFees |
Tanda yang menentukan apakah invoice terpisah dipublikasikan untuk biaya. Nilainya bisa berupa salah satu dari hal berikut:
|
salah | Ya |
status |
Status organisasi. Nilai yang valid mencakup:
|
T/A | Tidak |
supportedBillingType |
Model pembayaran developer yang digunakan untuk penagihan. Nilainya bisa berupa salah satu dari berikut:
Lihat Mengonfigurasi jenis penagihan prabayar dan pascabayar menggunakan API. |
PRABAYAR | Ya |
taxModel |
Catatan: Hanya berlaku jika Anda menyiapkan paket tarif pembagian keuntungan dan ingin untuk membuat dokumen penagihan. Model pajak untuk paket tarif pembagian keuntungan yang mengidentifikasi jenis dokumen penagihan yang diperlukan. Nilai yang valid mencakup:
|
T/A | Ya |
taxNexus |
Negara tempat organisasi terdaftar untuk tujuan pajak. |
T/A | Tidak |
taxRegNo |
Nomor pendaftaran pajak organisasi atau pendaftaran Pajak Pertambahan Nilai (PPN) angka, jika berlaku. Properti ini bersifat opsional karena nomor pendaftaran pajak atau Nomor pendaftaran PPN tidak berlaku di semua negara. Nomor yang Anda masukkan untuk yang ditampilkan di bagian bawah dokumen penagihan. |
T/A | Tidak |
transactionRelayURL |
URL sistem lain tempat transaksi dapat direlai, seperti data gudang. |
T/A | Tidak |
timezone |
ID zona waktu untuk operasi organisasi, seperti Amerika/New_York atau Eropa/Paris. Singkatan zona waktu, seperti UTC, EST (Timur Waktu Standar), atau CET (Waktu Eropa Tengah), juga didukung. |
T/A | Ya |
Mengganti setelan profil monetisasi untuk perusahaan atau developer aplikasi
Ganti setelan profil monetisasi untuk perusahaan atau developer aplikasi menggunakan UI atau API, seperti yang dijelaskan di bagian berikut: