Ringkasan publikasi

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat Dokumentasi Apigee Edge.

Publikasi adalah proses penyediaan API untuk developer aplikasi pengguna.

Video: Video berikut memberikan pengantar API tingkat tinggi publikasi.

Publishing API mencakup tugas berikut, yang dijelaskan dalam topik ini:

  1. Buat produk API yang memaketkan API Anda.
  2. Mendaftarkan developer aplikasi.
  3. Mendaftarkan aplikasi developer.
  4. 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 kepada developer aplikasi untuk digunakan. Buat API produk Anda menggunakan API atau UI Apigee. (Lihat Apa yang dimaksud dengan produk API? untuk mempelajari API lebih lanjut products.)

Diagram urutan kiri-ke-kanan yang menunjukkan developer, aplikasi, API, dan layanan backend. Ikon dan resource API ditandai. Garis putus-putus titik dari pengembang ke ikon aplikasi yang telah dibuat oleh pengembang. Panah dari dan kembali ke aplikasi yang menampilkan alur permintaan dan respons ke ikon API, dengan kunci aplikasi diposisikan di atas permintaan. Ikon dan resource API ditandai. Di bawah ikon API terdapat dua set jalur resource yang dikelompokkan menjadi dua produk API: Produk lokasi dan Produk media. Produk Lokasi memiliki resource untuk /countries, /city, dan /languages, serta Media produk memiliki sumber daya untuk /books, /majalahs, dan /movies. Di sebelah kanan API adalah resource backend yang dipanggil API, termasuk database, bus layanan perusahaan, aplikasi server, dan backend generik.

Pada gambar ini, API terdiri dari dua produk, masing-masing berisi tiga resource API.

Sebagai penyedia API, Anda bertanggung jawab untuk membangun produk API dan API untuk menangani kontrol akses, batasan penggunaan, dan persyaratan bisnis lainnya. Sebagai contoh, Anda mungkin:

  • Merilis produk API gratis yang memungkinkan akses hanya baca ke resource API-nya.
  • Merilis produk API kedua dengan harga rendah yang memungkinkan akses baca/tulis ke API yang sama resource sebagai versi gratis tetapi dengan batas akses yang rendah, seperti 1.000 permintaan per hari.
  • Rilis produk API ketiga dengan harga lebih tinggi yang memungkinkan akses baca/tulis dengan harga yang sama resource API, tetapi dengan batas akses yang tinggi.

Hal penting yang perlu diingat adalah Apigee memberi Anda fleksibilitas untuk membuat produk API yang sesuai dengan persyaratan 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 mereka dapat mendaftarkan aplikasinya. Saat mendaftarkan aplikasinya, mereka menerima kunci API yang akan memberi aplikasi akses ke API.

Melalui proses pendaftaran aplikasi, Anda dapat mengontrol siapa saja yang memiliki akses ke API Anda. Kapan saja, Anda dapat menghapus developer aplikasi, yang akan membatalkan semua kunci API yang terkait dengan developer tersebut, sehingga menolak akses developer ke API Anda.

Diagram urutan kiri-ke-kanan yang menunjukkan developer, aplikasi, API, dan layanan backend. Ikon developer ditandai. Garis putus-putus menunjukkan menyoroti pengembang ke ikon aplikasi yang telah dibuat pengembang. Panah dari dan kembali ke aplikasi yang menampilkan alur permintaan dan respons ke ikon API, dengan kunci aplikasi diposisikan di atas permintaan. Di bawah ikon API terdapat dua set jalur resource yang dikelompokkan menjadi dua produk API: Produk lokasi dan Produk media. Produk Lokasi memiliki resource untuk /countries, /city, dan /languages, serta Media produk memiliki sumber daya untuk /books, /majalahs, dan /movies. Di sebelah kanan API adalah resource backend yang dipanggil API, termasuk database, bus layanan perusahaan, aplikasi server, dan backend generik.

Sebagai penyedia API, Anda yang memutuskan cara mendaftarkan developer. Misalnya, Anda dapat menggunakan proses pendaftaran yang mengharuskan calon developer menghubungi organisasi Anda untuk mendaftar. Calon developer harus memberikan semua informasi yang diperlukan, seperti email alamat, nama depan dan belakang. Jika Anda menyetujui permintaan developer, Anda dapat menggunakan UI Apigee untuk mendaftarkan developer secara manual. Lihat Mendaftarkan developer aplikasi untuk banyak lagi.

Tugas 3: Mendaftarkan aplikasi developer

Sebelum aplikasi dapat mengakses API Anda, aplikasi harus terdaftar. Namun, hanya pengembang terdaftar dapat mendaftarkan aplikasi.

Diagram urutan kiri-ke-kanan yang menunjukkan developer, aplikasi, API, dan layanan backend. Panah aplikasi, permintaan/respons, dan kunci API ditandai. Titik-titik titik garis dari pengembang ke ikon aplikasi yang telah dibuat oleh pengembang. Panah dari dan kembali ke aplikasi yang menampilkan alur permintaan dan respons ke ikon API, dengan kunci aplikasi diposisikan di atas permintaan. Ikon dan resource API ditandai. Di bawah ikon API terdapat dua set jalur resource yang dikelompokkan menjadi dua produk API: Produk lokasi dan Produk media. Produk Lokasi memiliki resource untuk /countries, /city, dan /languages, serta Media produk memiliki sumber daya untuk /books, /majalahs, dan /movies. Di sebelah kanan API adalah resource backend yang dipanggil API, termasuk database, bus layanan perusahaan, aplikasi server, dan backend generik.

Pada saat pendaftaran aplikasi, developer memilih satu atau beberapa produk API. Misalnya, Anda mungkin memublikasikan beberapa produk API sesuai dengan jenis layanan dan harga yang berbeda paket. Developer aplikasi kemudian dapat memilih dan memilih dari daftar produk API yang tersedia.

Sebagai respons atas pendaftaran aplikasi di Apigee, Apigee menetapkan kunci API unik ke aplikasi. Aplikasi harus meneruskan kunci API tersebut sebagai bagian dari setiap permintaan ke resource API. Kunci tersebut diotentikasi dan, jika valid, permintaan akan diberikan. Anda sebagai penyedia layanan dapat mencabut kunci itu kapan saja sehingga aplikasi tidak dapat lagi mengakses API Anda.

Sebagai penyedia API, Anda memutuskan cara mendaftarkan aplikasi. Anda dapat:

  • Gunakan proses manual yang mengharuskan developer menghubungi organisasi Anda untuk mendaftarkan aplikasinya. Sebagai respons, Anda akan mengirimkan kunci API kepada developer, mungkin dengan email Anda.
  • Menggunakan Apigee API untuk mengintegrasikan fungsi pendaftaran aplikasi dan pengiriman kunci ke situs Anda.
  • Untuk akun Apigee berbayar, gunakan portal Layanan Developer Apigee yang telah dilengkapi untuk pendaftaran aplikasi dan pengiriman kunci API.

Untuk informasi selengkapnya, lihat Mendaftarkan aplikasi dan mengelola API .

Tugas 4: Mendokumentasikan API Anda

Pertimbangan penting untuk memublikasikan produk API adalah menyediakan dokumentasi dan mekanisme masukan developer. Portal developer dengan fitur publikasi sosial semakin digunakan untuk berkomunikasi dengan komunitas pengembangan. Ini termasuk mengomunikasikan konten dinamis, seperti dokumentasi API dan persyaratan penggunaan, serta konten dinamis konten seperti blog dan forum, serta fitur dukungan pelanggan.

Diagram urutan kiri-ke-kanan yang menunjukkan developer, aplikasi, API, dan layanan backend. Ikon developer ditandai. Di bawah pengembang adalah kotak yang mewakili portal developer. Portal ini berisi dokumentasi API, contoh, tutorial, Referensi API, dan lainnya. Portal ini juga berisi blog, forum, dan portal dukungan. Garis putus-putus menunjuk dari developer yang disorot ke ikon aplikasi yang dimiliki developer dibuat. Panah dari dan kembali ke aplikasi menunjukkan alur permintaan dan respons ke ikon API, dengan kunci aplikasi yang diposisikan di atas permintaan. Di bawah ikon API terdapat dua set jalur resource yang dikelompokkan menjadi dua produk API: Produk lokasi dan Produk media. Produk Lokasi memiliki resource untuk /countries, /city, dan /languages, serta Media produk memiliki sumber daya untuk /books, /majalahs, dan /movies. Di sebelah kanan API adalah resource backend yang dipanggil API, termasuk database, bus layanan perusahaan, aplikasi server, dan backend generik.

Anda dapat membuat situs sendiri untuk men-deploy dokumentasi atau, jika memiliki Apigee berbayar Anda dapat menggunakan portal Apigee Developer Services. Portal ini memiliki dukungan bawaan untuk dokumentasi, blog, forum, dan jenis konten lainnya yang diperlukan untuk memberikan dukungan komunitas developer Anda.

SmartDocs memungkinkan Anda mendokumentasikan API di portal Layanan Developer dengan cara agar dokumentasi API menjadi sepenuhnya interaktif. Dokumentasi interaktif dengan SmartDocs berarti pengguna portal dapat:

  • Baca tentang API
  • Mengirim permintaan langsung ke API
  • Melihat respons langsung yang ditampilkan dari API

Untuk informasi selengkapnya, lihat bagian berikut: