Glosarium

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

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

Masa Berlaku Definisi
API Proxy yang bertindak sebagai facade untuk API yang sudah ada. Daripada memanggil API yang sudah ada, developer mulai memanggil API baru yang dihasilkan oleh Apigee. Fasad ini memisahkan antarmuka publik Anda dari API backend Anda, melindungi developer dari perubahan backend, sekaligus memungkinkan Anda untuk berinovasi di edge tanpa memengaruhi tim pengembangan internal Anda. Saat Anda membuat perubahan backend, developer akan terus memanggil API yang sama tanpa gangguan. Dalam skenario yang lebih canggih, Apigee memungkinkan Anda mengekspos beberapa antarmuka ke API yang sama, sehingga Anda tidak perlu menyesuaikan tanda tangan API untuk memenuhi kebutuhan berbagai segmen developer secara bersamaan.
Jalur dasar dan resource API API terdiri dari jalur dasar dan serangkaian resource (juga dikenal sebagai jalur resource). Untuk setiap API, Anda menentukan satu URL root dan beberapa jalur resource. Anda dapat menganggap API hanya sebagai sekumpulan URI, yang semuanya memiliki jalur dasar yang sama. Untuk mempermudah pengelolaan API, Apigee menambahkan URI mentah ini dengan nama tampilan dan deskripsi.
Konsumen API Sinonim dengan "developer aplikasi", yang menggunakan API yang dibuat oleh penyedia API.
Developer API Software engineer di organisasi penyedia API yang mem-build API. API tersebut digunakan oleh developer aplikasi (konsumen API) untuk membuat aplikasi.
Paket API Kumpulan produk API yang disajikan kepada developer sebagai satu paket, dan biasanya dikaitkan dengan paket tarif.
Produk API Kumpulan resource API (URI) yang digabungkan dengan paket layanan dan ditampilkan kepada developer sebagai satu paket. Produk API juga dapat menyertakan beberapa metadata khusus bisnis Anda untuk pemantauan atau analisis. Satu atau beberapa resource dapat dimonetisasi dengan menyertakannya dalam produk API, yang kemudian dapat digabungkan menjadi paket API untuk monetisasi.
Penyedia API Penyedia API mem-build API (menggunakan Edge) untuk digunakan oleh konsumen API (developer aplikasi).
developer aplikasi Di Edge, developer aplikasi mendaftarkan aplikasinya ke penyedia API, dan begitu developer aplikasi mendapatkan kunci API yang diperlukan untuk memanggil proxy API penyedia.
aplikasi Developer Anda menggunakan aplikasi untuk mengakses resource di produk API Anda. Saat membuat aplikasi, Anda memilih produk API yang akan disertakan, dan Apigee akan menghasilkan 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. Anda juga 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 ditutup Penyesuaian yang telah diterapkan dalam dokumen penagihan yang dipublikasikan.
bulan penagihan ditutup Bulan kalender lengkap yang dokumen penagihannya telah diterbitkan.
batas kustom Batasan (seperti batasan jumlah transaksi pada produk API) yang dapat Anda siapkan secara eksplisit menggunakan monetisasi. Juga disebut dengan batas eksplisit.
paket tarif kategori developer Paket tarif yang berlaku untuk semua developer dalam kategori tertentu dan dapat dibeli oleh semua developer dalam kategori tersebut.
paket tarif developer Paket tarif yang berlaku untuk developer tertentu dan hanya dapat dibeli oleh developer tersebut.
agen yang diungkapkan Dalam hukum komersial, orang yang diberi wewenang untuk bertindak atas nama orang lain (disebut akun utama) untuk menciptakan hubungan hukum dengan pihak ketiga. Dalam monetisasi, model pajak dapat disiapkan untuk paket pendapatan bersama sehingga penyedia API bertindak sebagai agen developer yang diungkapkan untuk mengumpulkan pendapatan (dan mungkin pajak penjualan) atas nama developer.
model pajak yang diungkapkan Model pajak dengan penyedia API bertindak sebagai agen yang diungkapkan dari developer.
lingkungan Konteks eksekusi runtime untuk API. API harus di-deploy ke lingkungan sebelum dapat diakses pada saat runtime. Secara default, organisasi Apigee disediakan dengan dua lingkungan: 'test' dan 'prod'. Lingkungan 'pengujian' biasanya digunakan untuk men-deploy API yang sedang menjalani pengujian. Lingkungan 'prod' biasanya digunakan untuk men-deploy API untuk penggunaan produksi.
model pajak hibrida Model pajak dengan penyedia API bertindak sebagai agen yang diungkapkan dari developer. Namun, penyedia API membayar pajak penjualan yang dikumpulkan dari pelanggannya 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 penggunaan bulanan Total penggunaan developer untuk bulan tertentu, yang mencakup biaya penyiapan + biaya transaksi + biaya berulang.
pembayaran bulanan Pembayaran berulang yang dilakukan oleh pengembang berdasarkan paket yang dibeli. Paket tarif dapat memiliki biaya berulang yang ditagihkan kepada developer setiap bulan, terlepas dari penggunaannya.
pernyataan jaringan Dokumen keuangan yang menunjukkan saldo bersih antara invoice dan laporan pembagian keuntungan.
buka penyesuaian Penyesuaian yang belum diterapkan dalam dokumen penagihan yang dipublikasikan.
bulan penagihan terbuka Bulan kalender lengkap di mana dokumen penagihan “final” belum dipublikasikan.
organisasi Container untuk semua objek di akun Apigee Anda, termasuk API, produk API, paket API, aplikasi, dan developer. Akun pengguna diperlukan untuk setiap organisasi tempat Anda mungkin menjadi anggota. (Sebagian besar pengguna hanya akan memiliki akun di satu organisasi.) Anda harus memberikan kredensial (nama pengguna dan sandi) serta nama organisasi Anda bersama setiap permintaan API yang dikirimkan.
katalog paket Daftar paket API. Setiap paket dicantumkan beserta produk API dan paket tarifnya.
saldo prabayar Sejumlah 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 dipotong dari saldo developer prabayar saat produk API digunakan. Developer harus memiliki 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 standar mencakup merutekan permintaan 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 menemukan potensi ancaman, menyimpan respons umum dalam cache 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 setiap bulan (melalui invoice) atas 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 Kisaran harga untuk menentukan apakah sesuatu dapat dipasarkan.
paket tarif kartu tarif Paket tarif yang memungkinkan developer dikenai tarif tetap atau variabel untuk setiap transaksi yang melibatkan produk API yang dimonetisasi.
paket tarif Spesifikasi biaya, biaya lain, dan pembagian keuntungan untuk penggunaan produk API yang ditawarkan dalam paket API yang dimonetisasi.
resource
jalur
Konsep RESTful, jalur resource adalah resource seragam yang diidentifikasi (URI) yang mengidentifikasi jalur jaringan ke resource tertentu.
rencana tarif pembagian keuntungan Paket tarif yang mana persentase pendapatan yang dihasilkan dari setiap transaksi yang melibatkan produk API yang dimonetisasi akan dibagikan kepada developer aplikasi yang membuat permintaan.
pembagian keuntungan dan paket kartu tarif Paket tarif yang mana persentase pendapatan yang dihasilkan dari setiap transaksi yang melibatkan produk API yang dimonetisasi akan dibagikan kepada developer aplikasi yang membuat permintaan. Developer juga ditagih biaya tetap atau variabel untuk setiap transaksi.
invoice penagihan mandiri Dokumen keuangan yang dibuat, bukan laporan pembagian keuntungan. Perjanjian ini menjelaskan jumlah yang harus dibayar kepada developer, dan bertindak sebagai invoice kepada Penyedia API atas nama developer.
paket tarif standar Paket tarif yang dapat dibeli oleh semua developer.
tax Total pajak yang dikenakan pada penggunaan dan biaya developer.
menambah saldo 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 khusus. Monetisasi memerlukan informasi ini untuk melakukan pemrosesan monetisasinya, seperti menerapkan paket tarif pada permintaan dan respons API berdasarkan atribut khusus yang dicatat dalam setiap transaksi.
agen yang tidak diungkapkan Organisasi (atau operator) yang ambil bagian dalam penyediaan aplikasi dasar, 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 ditagihkan dari pengguna akhir. Status ini hanya relevan untuk tujuan pajak — status hukum developer dalam supply chain tidak akan terpengaruh.
model pajak yang tidak diungkapkan Model pajak ketika penyedia API memotong pajak yang dikumpulkan dari pengguna akhir dan membayarnya ke otoritas pajak setempat.
versi Versi antarmuka API yang digunakan developer. Misalnya, pivotaltracker.com/services/v3, atau api.enterprise.apigee.com/v1. (Istilah ini dibedakan dari 'revisi', yang merupakan paket konfigurasi dan kebijakan bernomor yang dikontrol versi yang dipaketkan menjadi Proxy API. Singkatnya, antarmuka API memiliki beberapa versi, sedangkan Proxy API memiliki revisi.