Ringkasan publikasi

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

Publikasi adalah proses membuat API Anda tersedia untuk digunakan oleh developer aplikasi untuk konsumsi.

Video: Video berikut memberikan pengantar tingkat tinggi tentang publikasi API.

Publikasi API melibatkan tugas-tugas berikut, yang dijelaskan dalam topik ini:

  1. Membuat produk API di Edge yang memaketkan API Anda.
  2. Mendaftarkan developer aplikasi di Edge.
  3. Mendaftarkan aplikasi developer di Edge.
  4. Menyediakan dokumentasi dan dukungan komunitas untuk API Anda.

Tugas 1: Membuat produk API di Edge

Tugas pertama dalam publikasi adalah membuat produk API. Produk API adalah kumpulan resource API yang ditawarkan sebagai paket kepada developer aplikasi untuk digunakan. Buat produk API menggunakan Edge management API atau UI. (Lihat Apa itu produk API? untuk mempelajari produk API lebih lanjut.)

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

Pada gambar ini, API terdiri dari dua produk, yang 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.
  • Merilis produk API kedua dengan harga rendah yang memungkinkan akses baca/tulis ke resource API yang sama dengan versi gratis, tetapi dengan batas akses rendah, seperti 1.000 permintaan per hari.
  • Merilis 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 Edge memberi Anda fleksibilitas untuk membuat produk API yang sesuai dengan persyaratan bisnis API Anda.

Untuk mengetahui informasi selengkapnya tentang cara membuat produk API, lihat Membuat produk API.

Tugas 2: Mendaftarkan developer aplikasi di Edge

Developer membuat aplikasi yang menggunakan API Anda. Developer aplikasi mendaftar di Apigee Edge sebelum dapat mendaftarkan aplikasinya. Saat mendaftarkan aplikasi, mereka akan menerima kunci API yang akan memberi aplikasi akses ke API.

Melalui proses pendaftaran aplikasi, Anda mengontrol siapa 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 tersebut ke API Anda.

Diagram urutan kiri ke kanan yang menampilkan developer, aplikasi, API, dan layanan backend. Ikon developer ditandai. Garis putus-putus mengarah dari developer yang disoroti ke ikon aplikasi yang telah dibuat oleh developer. 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 ke dalam dua produk API: Produk lokasi dan Produk media. Produk Location memiliki resource untuk /countries, /cities, dan /languages, dan produk Media memiliki resource untuk /books, /magazines, dan /movies. Di sebelah kanan API terdapat resource backend yang dipanggil API, termasuk database, bus layanan perusahaan, server aplikasi, dan backend generik.

Sebagai penyedia API, Anda menentukan 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 belakang, serta nama perusahaan. Jika Anda menyetujui permintaan developer, Anda dapat menggunakan Edge management UI untuk mendaftarkan developer secara manual. Lihat Mengelola developer aplikasi untuk mengetahui informasi selengkapnya.

Apigee juga menyediakan alat yang dapat Anda gunakan untuk mengotomatiskan proses pendaftaran developer. Misalnya:

  • Gunakan Apigee Edge management API untuk mengintegrasikan fungsi pendaftaran ke situs yang sudah ada. Edge management API adalah REST API yang dapat Anda gunakan untuk melakukan semua aspek proses pendaftaran developer. Lihat Menggunakan Edge management API untuk Memublikasikan API untuk mengetahui informasi selengkapnya.
  • Gunakan portal Apigee Developer Services untuk mendaftarkan developer. Portal ini memiliki dukungan bawaan untuk pendaftaran developer, tetapi juga memiliki banyak fitur lain untuk mendukung API Anda. Lihat Apa itu portal developer? untuk mengetahui informasi selengkapnya.

Tugas 3: Mendaftarkan aplikasi developer di Edge

Sebelum aplikasi dapat mengakses API Anda, aplikasi tersebut harus didaftarkan di Edge. Namun, hanya developer terdaftar yang dapat mendaftarkan aplikasi di Edge.

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

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

Sebagai respons terhadap pendaftaran aplikasi di Edge, Edge menetapkan kunci API unik ke aplikasi. Aplikasi harus meneruskan kunci API tersebut sebagai bagian dari setiap permintaan ke resource API. Kunci diautentikasi dan, jika valid, permintaan akan diberikan. Kapan saja, Anda sebagai penyedia layanan dapat mencabut kunci se hingga aplikasi tidak dapat lagi mengakses API Anda.

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

  • Menggunakan proses manual yang mengharuskan developer menghubungi organisasi Anda untuk mendaftarkan aplikasinya. Sebagai respons, Anda akan mengirimkan kunci API kepada developer, mungkin melalui email.
  • Menggunakan Edge management API untuk mengintegrasikan fungsi pendaftaran aplikasi dan pengiriman kunci ke situs Anda.
  • Untuk akun Edge berbayar, gunakan portal Apigee Developer Services yang memiliki dukungan bawaan dukungan untuk pendaftaran aplikasi dan pengiriman kunci API.

Untuk mengetahui informasi selengkapnya, lihat Mendaftarkan aplikasi dan mengelola kunci API API.

Tugas 4: Mendokumentasikan API Anda

Pertimbangan penting untuk memublikasikan produk API adalah menyediakan dokumentasi dan a mekanisme masukan developer. Portal developer dengan fitur publikasi sosial semakin banyak digunakan untuk berkomunikasi dengan komunitas pengembangan. Hal ini mencakup komunikasi konten statis seperti dokumentasi API dan persyaratan penggunaan, serta konten dinamis yang dikontribusikan komunitas seperti blog dan forum, serta fitur dukungan pelanggan.

Diagram urutan kiri ke kanan yang menampilkan developer, aplikasi, API, dan layanan backend. Ikon developer ditandai. Di bawah developer terdapat kotak yang merepresentasikan 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 mengarah dari developer yang disoroti ke ikon aplikasi yang telah dibuat oleh developer tersebut. 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 ke dalam dua produk API: Produk lokasi dan Produk media. Produk Location memiliki resource untuk /countries, /cities, dan /languages, dan produk Media memiliki resource untuk /books, /magazines, dan /movies. Di sebelah kanan API terdapat resource backend yang dipanggil API, termasuk database, bus layanan perusahaan, server aplikasi, dan backend generik.

Anda dapat membuat situs sendiri untuk men-deploy dokumentasi atau, jika memiliki akun Edge berbayar, Anda dapat menggunakan portal Apigee Developer Services. 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 Developer Services dengan cara yang membuat dokumentasi API sepenuhnya interaktif. Dokumentasi interaktif dengan SmartDocs berarti pengguna portal dapat:

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

Misalnya, gambar berikut menunjukkan API yang didokumentasikan di portal menggunakan SmartDocs. API ini memberikan informasi cuaca untuk lokasi tertentu:

Topik metode API SmartDocs yang memungkinkan Anda memanggil API cuaca dengan mengklik tombol di topik.

Developer memasukkan nilai untuk parameter kueri 'w' untuk menentukan lokasi, lalu mengklik tombol Send the request untuk melihat permintaan dan respons langsung. Dengan membuat dokumentasi interaktif di API, Anda memudahkan pengguna portal untuk mempelajari, menguji, dan mengevaluasi API Anda.

Edge management API adalah REST API yang memungkinkan Anda mengakses API Services menggunakan klien HTTP apa pun. Apigee menggunakan SmartDocs untuk membuat dokumentasi interaktif untuk Edge management API. Lihat dokumentasi API tersebut di sini.

Untuk mengetahui informasi selengkapnya, lihat Menggunakan SmartDocs untuk mendokumentasikan API.