Basic terminology

An 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 memungkinkan developer mengakses dan menggunakan kembali logika aplikasi yang dibuat oleh developer lain dengan mudah. Dalam kasus API Web, logika dan data tersebut diekspos melalui jaringan. Karena aplikasi yang menggunakan API sensitif terhadap perubahan, API juga menyiratkan kontrak. Kontrak ini memberikan tingkat jaminan bahwa, dari waktu ke 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 Desain API Web: Praktik Terbaik Missing Link untuk Membuat Antarmuka yang Disukai Developer.

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

Proxy API diimplementasikan sebagai kumpulan file konfigurasi, kebijakan, dan kode yang mengandalkan kumpulan 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 ke developer dari backend layanan, sehingga melindungi developer dari perubahan kode dan memungkinkan inovasi di edge tanpa memengaruhi tim pengembangan internal Anda. Saat tim pengembangan melakukan perubahan backend, developer 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 ceruk developer secara bersamaan.

API yang ditentukan oleh alamat jaringan dan URI. API terdiri dari jalur dasar dan kumpulan resource API. Setiap proxy API menentukan jalur dasar dan, secara opsional, beberapa jalur resource API. Anda dapat menganggap API sebagai kumpulan URI, yang semuanya memiliki jalur dasar yang sama.

Untuk memudahkan pengelolaan API, Apigee menambahkan nama tampilan dan deskripsi ke URI mentah ini. Edge memungkinkan Anda melampirkan kebijakan dan kode ke URI, sehingga memungkinkan kontrol dan pengelolaan perilaku API Anda yang mendetail.

Kumpulan resource API (URI) yang digabungkan dengan kuota, atau paket layanan, yang dipublikasikan ke developer aplikasi pada waktu desain. Produk API dapat digabungkan ke dalam paket API untuk monetisasi.

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

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

Saat aplikasi didaftarkan, Apigee akan membuat kunci dan secret API yang mengidentifikasi aplikasi. Developer menyematkan kunci API di aplikasi, yang menampilkan kunci saat membuat permintaan. Layanan API menerapkan 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 dieksposnya dapat diakses melalui jaringan. Secara default, organisasi disediakan dengan dua lingkungan: pengujian dan produksi.

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

Penampung untuk semua objek di akun Apigee Edge, termasuk proxy API, produk API 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 dieksekusi sebagai unit logika atomik dan dapat digunakan kembali dalam alur pemrosesan proxy API

Fungsi berbasis kebijakan yang umum mencakup transformasi format pesan, penerapan kontrol akses, pemanggilan layanan jarak jauh untuk informasi tambahan, penyamaran data sensitif dari pengguna eksternal, pemeriksaan konten pesan untuk potensi ancaman, penyimpanan respons umum dalam cache untuk meningkatkan performa, dan sebagainya.

Kebijakan dapat dieksekusi secara kondisional berdasarkan konten atau konteks pesan permintaan atau respons. Misalnya, kebijakan transformasi dapat dieksekusi untuk menyesuaikan format respons jika pesan permintaan dikirim dari smartphone.

Versi antarmuka API yang ditampilkan ke developer.

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

Istilah ini dibedakan dari revisi, yang merupakan paket konfigurasi dan kebijakan yang diberi nomor dan dikontrol versinya yang digabungkan ke dalam Proxy API. Antarmuka API memiliki versi; proxy API memiliki revisi.