Basic terminology

Application programming interface—antarmuka yang memudahkan satu aplikasi untuk menggunakan kemampuan atau data dari aplikasi lain.

Dengan menentukan titik entri yang stabil dan disederhanakan ke logika dan data aplikasi, API memudahkan developer mengakses dan menggunakan kembali logika aplikasi yang dibuat oleh developer lain. Dalam kasus Web API, logika dan data tersebut diekspos melalui jaringan. Karena aplikasi yang menggunakan API sensitif terhadap perubahan, API juga menyiratkan kontrak. Kontrak ini memberikan jaminan bahwa, seiring waktu, API akan berubah dengan cara yang dapat diprediksi.

Apigee menyediakan banyak informasi tentang API dan praktik terbaik untuk mengembangkan dan menggunakannya. Untuk memulai, lihat webcast Desain API atau download eBook gratis Web API Design: The Missing Link Best Practices for Crafting Interfaces that Developers Love.

Fasad di Edge untuk satu atau beberapa API, layanan HTTP generik, atau aplikasi (seperti Node.js).

Proxy API diimplementasikan sebagai sekumpulan file konfigurasi, kebijakan, dan kode yang mengandalkan serangkaian resource yang disediakan oleh Apigee Edge. Proxy API dapat dibuat dan dikonfigurasi menggunakan UI pengelolaan Apigee Edge, atau dapat diimplementasikan secara lokal di editor teks atau IDE.

Fasad yang disediakan oleh proxy API memisahkan API yang ditampilkan kepada developer dari layanan backend, sehingga melindungi developer dari perubahan kode dan memungkinkan inovasi di edge tanpa memengaruhi tim pengembangan internal Anda. Saat tim pengembangan membuat perubahan backend, developer akan terus memanggil antarmuka yang sama tanpa gangguan. Apigee memungkinkan Anda mengekspos beberapa antarmuka ke API yang sama, sehingga Anda dapat menyesuaikan tanda tangan API untuk memenuhi kebutuhan berbagai segmen developer secara bersamaan.

API yang didefinisikan oleh alamat jaringan dan URI. API terdiri dari jalur dasar dan sekumpulan resource API. Setiap proxy API menentukan jalur dasar dan, secara opsional, beberapa jalur resource API. 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 dan deskripsi tampilan. Edge memungkinkan Anda untuk melampirkan kebijakan dan kode ke URI, sehingga memungkinkan kontrol dan pengelolaan perilaku API yang mendetail.

Kumpulan resource API (URI) yang digabungkan dengan kuota, atau paket layanan, yang dipublikasikan kepada developer aplikasi pada saat desain. Produk API nantinya dapat dipaketkan menjadi paket API untuk monetisasi.

Kunci API terikat dengan satu atau beberapa produk API, yang menerapkan binding antara aplikasi dan paket URI yang diizinkan untuk digunakan oleh aplikasi.

Singkatan dari application. Istilah aplikasi kini merujuk pada aplikasi seluler yang menggunakan API. Developer menerapkan aplikasi dalam berbagai bahasa pemrograman, dan menggunakan berbagai teknologi dan platform. Developer yang ingin menggunakan API mendaftarkan aplikasi dalam organisasi penyedia API di Apigee Edge.

Saat aplikasi didaftarkan, Apigee akan menghasilkan kunci dan rahasia API yang mengidentifikasi aplikasi. Developer menyematkan kunci API dalam aplikasi, yang menampilkan kunci tersebut saat membuat permintaan. Layanan API mengimplementasikan keamanan di sekitar kunci API melalui validasi kunci API langsung atau melalui OAuth.

Konteks eksekusi runtime untuk proxy API. Proxy API harus di-deploy ke lingkungan sebelum API yang diekspos dapat diakses melalui jaringan. Secara default, organisasi disediakan dengan dua lingkungan: test dan prod.

• Lingkungan pengujian biasanya digunakan untuk men-deploy proxy API selama pengembangan.
• Lingkungan prod biasanya digunakan untuk mempromosikan proxy API dari lingkungan pengujian setelah dikembangkan dan diuji sepenuhnya.

Container untuk semua objek di akun Apigee Edge, termasuk proxy API, produk API, paket API, aplikasi, dan developer.

Akun pengguna diperlukan untuk setiap organisasi tempat Anda menjadi anggota. (Sebagian besar pengguna hanya akan memiliki akun di satu organisasi.)

Langkah pemrosesan yang dijalankan sebagai unit logika atomik yang dapat digunakan kembali dalam alur pemrosesan proxy API.

Fungsi berbasis kebijakan standar mencakup mengubah format pesan, menerapkan kontrol akses, memanggil layanan jarak jauh untuk informasi tambahan, menyamarkan data sensitif dari pengguna eksternal, memeriksa konten pesan dari 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.

Versi antarmuka API yang digunakan developer.

Misalnya, pivotaltracker.com/services/v3, atau api.enterprise.apigee.com/v1.

Istilah ini berbeda dari revisi, yang merupakan paket konfigurasi dan kebijakan bernomor yang dikontrol versi yang dipaketkan menjadi Proxy API. Antarmuka API memiliki beberapa versi; proxy API memiliki revisi.