Halaman ini berlaku untuk Apigee dan Apigee Hybrid.
Baca dokumentasi Apigee Edge.
Publikasi adalah proses menyediakan API bagi developer aplikasi untuk digunakan.
Video: Video berikut memberikan pengantar umum tentang publikasi API.
Publishing API melibatkan tugas-tugas berikut, yang dijelaskan dalam topik ini:
- Buat produk API yang memaketkan API Anda.
- Mendaftarkan developer aplikasi.
- Mendaftarkan aplikasi developer.
- Berikan dokumentasi dan dukungan komunitas untuk API Anda.
Tugas 1: Membuat produk API
Tugas pertama dalam publikasi adalah membuat produk API. Produk API adalah kumpulan resource API yang ditawarkan sebagai paket bagi developer aplikasi untuk digunakan. Buat produk API dengan menggunakan API atau UI Apigee. (Lihat Apa yang dimaksud dengan produk API? untuk mempelajari produk API lebih lanjut.)
Dalam gambar ini, API terdiri dari dua produk, masing-masing berisi tiga resource API.
Sebagai penyedia API, Anda bertanggung jawab untuk membuat API dan produk API guna menangani kontrol akses, batasan penggunaan, dan persyaratan bisnis lainnya. Misalnya, Anda dapat:
- Merilis produk API gratis yang memungkinkan akses hanya baca ke resource API-nya.
- Rilis produk API kedua dengan harga rendah yang memungkinkan akses baca/tulis ke resource API yang sama seperti versi gratis tetapi dengan batas akses rendah, misalnya 1.000 permintaan per hari.
- Rilis produk API ketiga dengan harga lebih tinggi yang memungkinkan akses baca/tulis ke resource API yang sama tetapi dengan batas akses tinggi.
Hal penting yang perlu diingat adalah Apigee memberikan fleksibilitas untuk membuat produk API yang sesuai dengan kebutuhan bisnis API Anda.
Untuk informasi selengkapnya tentang cara membuat produk API, lihat Mengelola produk API.
Tugas 2: Mendaftarkan developer aplikasi
Developer membuat aplikasi yang menggunakan API Anda. Developer aplikasi mendaftar di Apigee sebelum dapat mendaftarkan aplikasinya. Saat mendaftarkan aplikasinya, mereka akan menerima kunci API yang akan memberi aplikasi tersebut akses ke API.
Melalui proses pendaftaran aplikasi, Anda dapat mengontrol siapa saja yang memiliki akses ke API Anda. Anda dapat menghapus developer aplikasi kapan saja. Hal ini akan membatalkan validasi semua kunci API yang terkait dengan developer tersebut, sehingga menolak akses developer tersebut ke API Anda.
Sebagai penyedia API, Anda memutuskan cara mendaftarkan developer. Misalnya, Anda dapat menggunakan proses pendaftaran manual yang mengharuskan calon developer menghubungi organisasi Anda untuk mendaftar. Calon developer harus memberikan semua informasi yang diperlukan, seperti alamat email, nama depan dan nama belakang. Jika menyetujui permintaan developer, Anda dapat menggunakan UI Apigee untuk mendaftarkan developer secara manual. Baca bagian Mendaftarkan developer aplikasi untuk mengetahui informasi selengkapnya.
Tugas 3: Mendaftarkan aplikasi developer
Sebelum aplikasi dapat mengakses API, aplikasi harus terdaftar. Namun, hanya developer terdaftar yang dapat mendaftarkan aplikasi.
Pada saat pendaftaran aplikasi, developer memilih satu atau beberapa produk API. Misalnya, Anda dapat memublikasikan beberapa produk API sesuai dengan berbagai jenis layanan dan paket harga. Developer aplikasi kemudian dapat mengambil dan memilih dari daftar produk API yang tersedia.
Sebagai respons atas pendaftaran aplikasi di Apigee, Apigee menetapkan kunci API unik ke aplikasi. Aplikasi tersebut harus meneruskan kunci API tersebut sebagai bagian dari setiap permintaan ke resource API. Kunci tersebut diautentikasi dan, jika valid, permintaan akan disetujui. Kapan saja, Anda sebagai penyedia layanan dapat mencabut kunci, sehingga aplikasi tidak dapat lagi mengakses API Anda.
Sebagai penyedia API, Anda dapat menentukan cara mendaftarkan aplikasi. Anda dapat:
- Gunakan proses manual yang mengharuskan developer menghubungi organisasi Anda untuk mendaftarkan aplikasi mereka. Sebagai respons, Anda akan mengirimkan kunci API kepada developer, mungkin melalui email.
- Gunakan Apigee API untuk mengintegrasikan fungsi pendaftaran aplikasi dan pengiriman kunci ke situs Anda.
- Untuk akun Apigee berbayar, gunakan portal Layanan Developer Apigee yang memiliki dukungan bawaan untuk pendaftaran aplikasi dan pengiriman kunci API.
Untuk mengetahui informasi selengkapnya, lihat Mendaftarkan aplikasi dan mengelola kunci API.
Tugas 4: Mendokumentasikan API Anda
Pertimbangan penting untuk memublikasikan produk API adalah memberikan dokumentasi dan mekanisme masukan bagi developer. Portal developer dengan fitur publikasi sosial makin banyak digunakan untuk komunikasi dengan komunitas pengembangan. Hal ini termasuk mengomunikasikan konten statis, seperti dokumentasi API dan persyaratan penggunaan, serta konten dinamis hasil kontribusi komunitas seperti blog dan forum, serta fitur dukungan pelanggan.
Anda dapat membuat situs sendiri untuk men-deploy dokumentasi Anda atau, jika memiliki akun Apigee berbayar, Anda dapat menggunakan portal Layanan Developer Apigee. Portal ini memiliki dukungan bawaan untuk dokumentasi, blog, forum, dan jenis konten lainnya yang diperlukan untuk mendukung komunitas developer Anda.
SmartDocs memungkinkan Anda mendokumentasikan API di portal Layanan Developer dengan cara yang membuat dokumentasi API sepenuhnya interaktif. Dokumentasi interaktif dengan SmartDocs berarti pengguna portal dapat:
- Baca tentang API
- Mengirim permintaan real time ke API
- Melihat respons langsung yang ditampilkan dari API
Untuk mengetahui informasi selengkapnya, lihat bagian berikut:
- Portal terintegrasi: Memublikasikan API Anda
- Drupal 10: Dokumentasikan API Anda