Glosarium

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

Ada beberapa konsep yang merupakan ide umum dengan makna unik di Apigee.

Istilah Definisi
API Proxy yang bertindak sebagai fasad untuk API yang ada. Daripada memanggil API yang ada, developer mulai memanggil API baru yang dihasilkan oleh Apigee. Fasad ini memisahkan antarmuka publik dari API backend, sehingga melindungi developer dari perubahan backend, sekaligus memungkinkan Anda berinovasi di edge tanpa memengaruhi tim pengembangan internal. Saat Anda membuat perubahan backend, developer akan terus memanggil API yang sama tanpa gangguan. Dalam skenario lanjutan, Apigee memungkinkan Anda mengekspos beberapa antarmuka ke API yang sama, sehingga Anda dapat menyesuaikan tanda tangan API untuk memenuhi kebutuhan berbagai niche developer secara bersamaan.
Resource dan jalur dasar API API terdiri dari jalur dasar dan kumpulan resource (juga dikenal sebagai jalur resource). Untuk setiap API, Anda menentukan satu URL root dan beberapa jalur resource. Anda dapat menganggap API sebagai kumpulan URI, yang semuanya memiliki jalur dasar yang sama. Untuk mempermudah pengelolaan API, Apigee melengkapi URI mentah ini dengan nama dan deskripsi tampilan.
Konsumen API Sinonim dengan "developer aplikasi", yang menggunakan API yang dibuat oleh penyedia API.
Developer API Software engineer di organisasi penyedia API yang membuat API. API tersebut digunakan oleh developer aplikasi (konsumen API) untuk mem-build aplikasi.
Paket API Kumpulan produk API yang ditampilkan kepada developer sebagai paket, dan biasanya dikaitkan dengan paket tarif.
Produk API Kumpulan resource API (URI) yang digabungkan dengan paket layanan dan ditampilkan kepada developer sebagai paket. Produk API juga dapat menyertakan beberapa metadata khusus untuk bisnis Anda guna pemantauan atau analisis. Satu atau beberapa resource dapat dimonetisasi dengan menyertakannya dalam produk API, yang kemudian dapat dipaketkan ke dalam paket API untuk monetisasi.
Penyedia API Penyedia API membuat API (menggunakan Edge) untuk digunakan oleh konsumen API (developer aplikasi).
developer aplikasi Di Edge, developer aplikasi mendaftarkan aplikasi mereka ke penyedia API, yang merupakan cara developer aplikasi mendapatkan kunci API yang mereka perlukan untuk memanggil proxy API penyedia.
aplikasi Developer Anda menggunakan aplikasi untuk mengakses resource dalam produk API Anda. Saat membuat aplikasi, Anda memilih produk API yang akan disertakan, dan Apigee akan membuat kunci. Setiap aplikasi memiliki satu kunci yang memberikan akses ke beberapa produk API. Aplikasi memungkinkan Anda mengontrol siapa yang dapat mengakses resource Anda. Anda dapat mengontrol siapa saja yang memiliki akses ke produk API Anda dengan mencabut dan memuat ulang kunci aplikasi. Selain itu, Anda dapat mengontrol akses ke paket resource dengan mencabut atau menghapus akses ke produk dalam aplikasi.
detail saldo Untuk developer prabayar, saldo di akun developer.
penyesuaian tertutup Penyesuaian yang telah diterapkan dalam dokumen penagihan yang dipublikasikan.
bulan penagihan ditutup Bulan kalender lengkap yang dokumen penagihannya telah dipublikasikan.
batas kustom Batas (seperti batas jumlah transaksi pada produk API) yang dapat Anda siapkan secara eksplisit menggunakan monetisasi. Juga disebut batas eksplisit.
paket tarif kategori developer Paket tarif yang berlaku untuk semua developer dalam kategori tertentu dan tersedia untuk dibeli oleh semua developer dalam kategori tersebut.
paket tarif developer Paket tarif yang berlaku untuk developer tertentu dan hanya tersedia untuk dibeli oleh developer tersebut.
agen yang diungkapkan Dalam hukum komersial, orang yang diberi otorisasi untuk bertindak atas nama orang lain (disebut prinsipal) untuk membuat hubungan hukum dengan pihak ketiga. Dalam monetisasi, model pajak dapat disiapkan untuk paket pendapatan bersama sehingga penyedia API bertindak sebagai agen yang diungkapkan dari developer untuk mengumpulkan pendapatan (dan mungkin pajak penjualan) atas nama developer.
model pajak yang diungkapkan Model pajak tempat penyedia API bertindak sebagai agen yang diungkapkan dari developer.
lingkungan Konteks eksekusi runtime untuk API. API harus di-deploy ke lingkungan sebelum dapat diakses saat runtime. Secara default, organisasi Apigee disediakan dengan dua lingkungan: 'test' dan 'prod'. Lingkungan 'pengujian' biasanya digunakan untuk men-deploy API yang sedang diuji. Lingkungan 'prod' biasanya digunakan untuk men-deploy API untuk penggunaan produksi.
model pajak campuran Model pajak tempat penyedia API bertindak sebagai agen yang diungkapkan dari developer. Namun, penyedia API membayar pajak penjualan yang dikumpulkan dari pelanggan mereka kepada otoritas pajak setempat atas nama developer.
batas implisit Batas (seperti batas saldo prabayar developer) yang ditetapkan oleh monetisasi.
monetisasi Komponen Layanan Developer Apigee Edge yang menyediakan cara yang mudah digunakan dan fleksibel untuk memonetisasi produk API.
jumlah bulanan yang digunakan Total penggunaan developer untuk bulan tertentu, yang mencakup biaya penyiapan + biaya transaksi + biaya berulang.
pembayaran bulanan Pembayaran berulang yang dilakukan oleh developer berdasarkan paket yang dibeli. Paket tarif dapat memiliki biaya berulang yang ditagih kepada developer setiap bulan, terlepas dari penggunaannya.
laporan netting Dokumen keuangan yang menunjukkan saldo bersih antara invoice dan laporan pembagian keuntungan.
penyesuaian terbuka Penyesuaian yang belum diterapkan dalam dokumen penagihan yang dipublikasikan.
bulan penagihan terbuka Bulan kalender lengkap yang dokumen penagihannya yang “final” belum dipublikasikan.
organisasi Penampung untuk semua objek di akun Apigee Anda, termasuk API, produk API, paket API, aplikasi, dan developer. Akun pengguna diperlukan untuk setiap organisasi yang anggotanya mungkin Anda. (Sebagian besar pengguna hanya akan memiliki akun di satu organisasi.) Anda harus memberikan kredensial (nama pengguna dan sandi) serta nama organisasi dengan setiap permintaan API yang Anda kirimkan.
katalog paket Daftar paket API. Setiap paket dicantumkan dengan produk API dan paket tarifnya.
saldo prabayar Jumlah uang yang tersedia bagi developer prabayar untuk membayar di muka untuk paket API.
developer prabayar Developer yang membayar di muka untuk penggunaan produk API. Dana akan dipotong dari saldo developer prabayar saat produk API digunakan. Developer harus mempertahankan saldo prabayar yang cukup untuk membeli produk API. Developer diberi status prabayar atau pascabayar oleh penyedia API.
kebijakan Langkah pemrosesan yang dijalankan sebagai unit logika atomik yang dapat digunakan kembali dalam alur API. Kebijakan umum mencakup permintaan pemilihan rute ke endpoint yang tepat, mengubah format pesan, menerapkan kontrol akses, memanggil layanan jarak jauh untuk informasi tambahan, menyamarkan data sensitif dari pengguna eksternal, memeriksa konten pesan untuk potensi ancaman, meng-cache respons umum untuk meningkatkan performa, dan sebagainya. Kebijakan dapat dijalankan secara bersyarat berdasarkan konten atau konteks pesan permintaan atau respons. Misalnya, kebijakan transformasi dapat dijalankan untuk menyesuaikan format respons jika pesan permintaan dikirim dari smartphone.
developer pascabayar Developer yang ditagih bulanan (melalui invoice) untuk penggunaan produk API. Developer membayar penggunaan produk API berdasarkan persyaratan pembayaran yang ditetapkan oleh paket yang disertakan dalam invoice. Developer diberi status pascabayar atau prabayar oleh penyedia API.
titik harga Rentang kemungkinan harga yang dapat digunakan untuk memasarkan sesuatu.
paket tarif kartu tarif Paket tarif yang mengenakan tarif tetap atau variabel kepada developer untuk setiap transaksi yang melibatkan produk API yang dimonetisasi.
paket tarif Spesifikasi biaya, tagihan lainnya, dan pembagian keuntungan untuk penggunaan produk API yang ditawarkan dalam paket API yang dimonetisasi.
Jalur resource
Konsep RESTful, jalur resource adalah Uniform Resource Identifier (URI) yang mengidentifikasi jalur jaringan ke resource tertentu.
paket rasio pembagian keuntungan Paket tarif yang persentase pendapatannya dihasilkan dari setiap transaksi yang melibatkan produk API yang dimonetisasi dibagikan kepada developer aplikasi yang mengeluarkan permintaan.
rencana pembagian keuntungan dan tarif Paket tarif yang persentase pendapatannya dihasilkan dari setiap transaksi yang melibatkan produk API yang dimonetisasi dibagikan kepada developer aplikasi yang mengeluarkan permintaan. Developer juga dikenai biaya tetap atau variabel untuk setiap transaksi.
faktur penagihan mandiri Dokumen keuangan yang dibuat, bukan laporan pembagian keuntungan. Laporan ini menjelaskan jumlah yang harus dibayarkan kepada developer, dan berfungsi sebagai invoice kepada Penyedia API atas nama developer.
paket tarif standar Paket tarif yang tersedia untuk dibeli oleh semua developer.
tax Total pajak yang diterapkan ke penggunaan dan biaya developer.
isi ulang Tindakan yang dilakukan oleh developer prabayar untuk menambahkan dana ke saldo prabayar.
kebijakan pencatatan transaksi Mekanisme yang memungkinkan monetisasi untuk mengambil parameter transaksi dan atribut kustom. Monetisasi memerlukan informasi ini untuk melakukan pemrosesan monetisasi, seperti menerapkan paket tarif ke permintaan dan respons API berdasarkan atribut kustom yang diambil dalam setiap transaksi.
agen yang tidak diungkapkan Organisasi (atau operator) yang berpartisipasi dalam penyediaan aplikasi pokok, sehingga dianggap membeli konten atas nama developer (hanya untuk tujuan pajak). Sebagai agen yang tidak diungkapkan, organisasi (atau operator) dapat mengumpulkan dan memperhitungkan pajak yang terutang dari pengguna akhir. Status ini hanya relevan untuk tujuan pajak — status hukum developer dalam rantai pasokan tidak terpengaruh.
model pajak yang tidak diungkapkan Model pajak yang digunakan penyedia API untuk memotong pajak yang dikumpulkan dari pengguna akhir dan membayarnya kepada otoritas pajak setempat.
versi Versi antarmuka API yang ditampilkan kepada developer. Misalnya, pivotaltracker.com/services/v3, atau api.enterprise.apigee.com/v1. (Istilah ini berbeda dengan 'revisi', yang merupakan paket konfigurasi dan kebijakan yang diberi nomor dan dikontrol versi yang dipaketkan ke dalam Proxy API. Singkatnya, antarmuka API memiliki versi, sedangkan Proxy API memiliki revisi.