Mengelola profil organisasi

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, jika perlu. Misalnya, Anda mungkin perlu memperbarui jenis penagihan, setelan mata uang, atau model pajak.

Konfigurasikan informasi dasar tentang organisasi Anda, termasuk:

  • Nama, alamat, dan negara operasional organisasi
  • Jenis penagihan (prabayar, pascabayar, atau keduanya), seperti yang dijelaskan dalam Memahami jenis penagihan
  • Siklus penagihan (bulan kalender atau prorata)
  • 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.

Menjelajahi halaman Profil Organisasi

Akses halaman Profil Organisasi, seperti yang dijelaskan di bawah.

Edge

Untuk mengakses halaman Organization Profile menggunakan Edge UI:

  1. Login ke apigee.com/edge.
  2. Pilih Publikasikan > Monetisasi > Profil Organisasi di menu navigasi sebelah kiri.

Halaman Profil Organisasi ditampilkan.

Seperti yang disorot dalam gambar, halaman Profil Organisasi memungkinkan Anda:

  • Melihat setelan profil organisasi saat ini
  • Mengedit setelan profil organisasi, termasuk:

Edge Klasik (Private Cloud)

Untuk mengakses halaman Profil Organisasi menggunakan UI Edge Klasik:

  1. Login ke http://ms-ip:9000, dengan ms-ip yang merupakan alamat IP atau nama DNS node Server Pengelolaan.
  2. Pilih Admin > Profil Organisasi di menu navigasi atas.

Halaman Profil Organisasi ditampilkan.

Halaman Profil Organisasi memungkinkan Anda:

  • Melihat setelan profil organisasi saat ini
  • Mengedit setelan profil organisasi, termasuk:

Mengedit profil organisasi menggunakan UI

Untuk mengedit profil organisasi menggunakan UI:

  1. Akses halaman Profil Organisasi.
  2. Klik Edit.
  3. Di bagian Nama dan informasi, edit nama organisasi dan negara tempat beroperasi.
  4. 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 membuat dokumen penagihan.

    Model pajak untuk paket tarif pembagian keuntungan yang mengidentifikasi jenis dokumen penagihan yang diperlukan.

    Nilai yang valid meliputi:

    • Diungkap: Penyedia API bertindak sebagai agen developer yang diungkapkan. Pendapatan kotor (termasuk pajak penjualan) yang dikumpulkan dari pengguna akhir akan diteruskan ke developer. Komisi penyedia API dikumpulkan dari developer dalam bentuk invoice komisi. Penyedia API tidak menangani pajak penjualan yang terkumpul dari pengguna akhir, dan developer bertanggung jawab untuk melaporkan pajak penjualan.
    • Tidak diungkapkan: Penyedia API bertindak sebagai agen developer yang tidak diungkapkan, dan memotong pajak yang dikumpulkan dari pengguna akhir dan membayarkannya kepada otoritas pajak setempat. Developer menagih penyedia API untuk pembagian keuntungan bersih yang dibayarkan kepada developer (dikurangi pajak penjualan dan komisi penyedia API).
    • Campuran: Penyedia API bertindak sebagai agen developer yang diungkapkan. Namun, penyedia API membayar pajak penjualan yang dikumpulkan dari pelanggannya kepada otoritas pajak setempat atas nama developer. Penyedia API meneruskan pendapatan yang tersisa kepada developer, lalu invoice 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 yang akan digunakan dengan memilih dari daftar mata uang yang didukung. Secara opsional, Anda dapat menetapkan jumlah penambahan saldo minimum yang dapat ditambahkan oleh developer aplikasi ke saldo akun prabayar mereka untuk setiap mata uang.

    Untuk menambahkan mata uang:

    1. Klik Tambahkan mata uang.
    2. Pilih mata uang dari menu drop-down di kolom Mata uang.
    3. Secara opsional, tetapkan jumlah minimum yang dapat ditambahkan oleh developer aplikasi ke saldo akun prabayar mereka dalam mata uang yang ditentukan di kolom Tambah saldo minimum.
    4. Klik Tambahkan.
    5. Jika mau, tetapkan sebagai mata uang default dengan mengklik tombol pilihan terkait.
    6. Ulangi langkah untuk menambahkan mata uang lainnya.

    Untuk menghapus mata uang, posisikan kursor pada mata uang yang ingin Anda hapus, lalu klik .

  5. Kelola persyaratan dan ketentuan, seperti yang dijelaskan dalam Mengelola persyaratan dan ketentuan menggunakan UI.
  6. Klik Simpan.

Mengelola profil organisasi menggunakan API

Kelola 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 adalah contoh responsnya. Untuk informasi selengkapnya tentang opsi yang ditampilkan, 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 diedit.

Guna mengedit mata uang default untuk organisasi, tetapkan nilai currency ke kode mata uang ISO 4217 dari mata uang yang didukung yang ingin Anda tetapkan sebagai default.

Misalnya, panggilan API berikut memperbarui currency ke USD dan setelan model pajak ke HYBRID (kolom yang diperbarui ditandai dalam contoh). Untuk informasi selengkapnya tentang opsi yang ditampilkan, lihat Properti 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 pembayaran terintegrasi. Developer harus memiliki saldo prabayar yang memadai untuk membeli API.

Dengan akun pascabayar, developer ditagih setiap bulan (melalui invoice) di akhir bulan. Developer membayar penggunaan produk API berdasarkan persyaratan pembayaran yang ditetapkan oleh paket yang disertakan di invoice.

Untuk mengonfigurasi jenis penagihan prabayar dan pascabayar untuk organisasi Anda, tetapkan properti supportedBillingType ke salah satu nilai berikut untuk menunjukkan jenis penagihan 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 dalam 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 produk API digunakan 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 diisi?
address

Alamat organisasi, yang dapat mencakup alamat jalan, kota, negara bagian/provinsi, kode pos, negara, dan indikasi apakah ini merupakan alamat utama untuk organisasi.

T/A Tidak
approveTrusted

Flag ini tidak digunakan.

T/A Tidak
approveUntrusted

Flag ini tidak digunakan.

T/A Tidak
billingCycle

Periode siklus penagihan. Nilainya bisa berupa salah satu dari berikut:

  • PRORATED: Penagihan didasarkan pada jumlah hari produk API digunakan dalam satu bulan kalender.
  • CALENDAR_MONTH: Penagihan dilakukan setiap bulan.

Lihat Mengonfigurasi siklus penagihan menggunakan API.

T/A Ya
country

Kode ISO 3166-2 untuk negara operasional organisasi, seperti BR untuk Brasil.

T/A Ya
currency

Kode ISO 4217 untuk "dasar" atau mata uang akuntansi yang digunakan organisasi (seperti USD untuk dolar Amerika Serikat).

Untuk paket pembagian keuntungan: Mata uang yang ditentukan digunakan untuk rencana 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.

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 atau tidak. Jika diaktifkan, Anda dapat melakukan penyesuaian pada detail traffic yang dicatat oleh Layanan API untuk produk API Anda. Nilainya dapat berupa salah satu dari berikut:

  • true: Penyesuaian diaktifkan.
  • false: Penyesuaian tidak diaktifkan.
T/A Tidak
hasBroker

Tanda yang menentukan apakah pendapatan didasarkan pada internet atau tidak. Nilainya dapat berupa salah satu dari berikut ini:

  • true: Pendapatan didasarkan pada bersih.
  • false: Pendapatan tidak didasarkan pada bersih.
T/A Tidak
hasSelfBilling

Tanda yang mengarahkan monetisasi untuk membuat invoice penagihan mandiri, bukan laporan pembagian keuntungan. Invoice penagihan mandiri adalah dokumen keuangan yang menjelaskan jumlah yang harus dibayarkan kepada developer aplikasi. Faktur ini berfungsi sebagai invoice ke Penyedia API atas nama developer aplikasi. Nilainya dapat berupa salah satu dari berikut ini:

  • true: Membuat invoice penagihan mandiri, bukan laporan pembagian keuntungan.
  • false: Menonaktifkan invoice penagihan mandiri.
T/A Tidak
hasSeparateInvoiceForProduct

Tanda yang menentukan apakah invoice terpisah dibuat untuk setiap produk API. Nilainya dapat berupa salah satu dari berikut ini:

  • true: Invoice terpisah dibuat untuk setiap produk API.
  • false: Invoice terpisah tidak dibuat untuk setiap produk API.
T/A Tidak
id

ID organisasi.

T/A Tidak
issueNettingStmt

Tanda yang menentukan apakah pernyataan netting dihasilkan saat membuat dokumen penagihan. Nilainya dapat berupa salah satu dari berikut ini:

  • true: Pernyataan jaringan dibuat saat membuat dokumen penagihan.
  • false: Laporan jaringan tidak dibuat saat membuat dokumen penagihan.
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 netting terpisah dibuat untuk setiap mata uang yang digunakan. Nilainya dapat berupa salah satu dari berikut ini:

  • true: Pernyataan netting terpisah dibuat untuk setiap mata uang yang digunakan.
  • false: Pernyataan netting terpisah tidak dibuat untuk setiap mata uang yang digunakan.
T/A Tidak
regNo

Nomor pendaftaran organisasi. Angka yang Anda masukkan untuk properti ini ditampilkan di bagian bawah dokumen penagihan.

T/A Tidak
selfBillingAsExchOrg

Jika invoice penagihan mandiri diaktifkan, tunjukkan apakah invoice tersebut diaktifkan untuk organisasi bursa. Nilainya dapat berupa salah satu dari berikut ini:

  • true: Invoice penagihan mandiri diaktifkan untuk organisasi bursa.
  • false: Invoice penagihan mandiri tidak diaktifkan untuk organisasi Exchange.
T/A Tidak
selfBillingForAllDev

Jika invoice penagihan mandiri diaktifkan, tunjukkan apakah invoice ini diaktifkan untuk semua developer aplikasi. Secara default, invoice penagihan mandiri hanya dibuat untuk developer aplikasi yang telah menandatangani perjanjian dengan penyedia API. Nilainya dapat berupa salah satu dari berikut ini:

  • true: Faktur penagihan mandiri diaktifkan untuk semua developer aplikasi.
  • false: Invoice penagihan mandiri tidak diaktifkan untuk semua developer aplikasi.
false Tidak
separateInvoiceForFees

Tanda yang menentukan apakah invoice terpisah dipublikasikan untuk biaya. Nilainya dapat berupa salah satu dari berikut ini:

  • true: Faktur terpisah diterbitkan untuk biaya.
  • false: Invoice terpisah tidak dipublikasikan untuk biaya.
false Ya
status

Status organisasi. Nilai yang valid meliputi:

  • AKTIF: Akun organisasi terdaftar di monetisasi dan tersedia untuk digunakan.
  • TIDAK AKTIF: Akun organisasi terdaftar di monetisasi, tetapi tidak dapat digunakan.
T/A Tidak
supportedBillingType

Model pembayaran developer yang digunakan untuk penagihan. Nilainya bisa berupa salah satu dari berikut:

  • PREpaid: Developer membayar di muka untuk penggunaan produk API. Dana dipotong dari saldo developer saat produk API digunakan. Developer harus memiliki saldo prabayar yang memadai untuk membeli produk API.
  • POSTpaid: Developer ditagih setiap bulan (melalui invoice) untuk penggunaan produk API. Developer membayar penggunaan produk API berdasarkan persyaratan pembayaran yang ditetapkan oleh paket yang disertakan dalam invoice.
  • BOTH: Mendukung kedua jenis penagihan. Setelan default-nya adalah PRABAYAR.

Lihat Mengonfigurasi jenis penagihan prabayar dan pascabayar menggunakan API.

PRABAYAR Ya
taxModel

Catatan: Hanya berlaku jika Anda menyiapkan paket tarif pembagian keuntungan dan ingin membuat dokumen penagihan.

Model pajak untuk paket tarif pembagian keuntungan yang mengidentifikasi jenis dokumen penagihan yang diperlukan.

Nilai yang valid meliputi:

  • Diungkap: Penyedia API bertindak sebagai agen developer yang diungkapkan. Pendapatan kotor (termasuk pajak penjualan) yang dikumpulkan dari pengguna akhir akan diteruskan ke developer. Komisi penyedia API dikumpulkan dari developer dalam bentuk invoice komisi. Penyedia API tidak menangani pajak penjualan yang terkumpul dari pengguna akhir, dan developer bertanggung jawab untuk melaporkan pajak penjualan.
  • Tidak diungkapkan: Penyedia API bertindak sebagai agen developer yang tidak diungkapkan, dan memotong pajak yang dikumpulkan dari pengguna akhir dan membayarkannya kepada otoritas pajak setempat. Developer menagih penyedia API untuk pembagian keuntungan bersih yang dibayarkan kepada developer (dikurangi pajak penjualan dan komisi penyedia API).
  • Campuran: Penyedia API bertindak sebagai agen developer yang diungkapkan. Namun, penyedia API membayar pajak penjualan yang dikumpulkan dari pelanggannya kepada otoritas pajak setempat atas nama developer. Penyedia API meneruskan pendapatan yang tersisa kepada developer, lalu invoice untuk biaya komisi.
T/A Ya
taxNexus

Negara tempat organisasi terdaftar untuk tujuan pajak.

T/A Tidak
taxRegNo

Nomor pendaftaran pajak atau nomor pendaftaran Pajak Pertambahan Nilai (PPN), jika berlaku. Properti ini bersifat opsional karena nomor pendaftaran pajak atau nomor pendaftaran PPN tidak berlaku di semua negara. Angka yang Anda masukkan untuk parameter ini ditampilkan di bagian bawah dokumen penagihan.

T/A Tidak
transactionRelayURL

URL sistem lain tempat transaksi dapat direlai, seperti data warehouse.

T/A Tidak
timezone

ID zona waktu untuk operasi organisasi, seperti America/New_York atau Europe/Paris. Singkatan zona waktu, seperti UTC, EST (Waktu Standar Timur), 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: