Ringkasan publikasi

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

Publikasi adalah proses menyediakan API bagi developer aplikasi untuk digunakan.

Video: Video berikut memberikan pengantar umum tentang publikasi API.

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

  1. Buat produk API di Edge yang memaketkan API Anda.
  2. Mendaftarkan developer aplikasi di Edge.
  3. Mendaftarkan aplikasi developer di Edge.
  4. Berikan 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 bagi developer aplikasi untuk dipakai. Buat produk API menggunakan API atau UI pengelolaan Edge. (Lihat Apa yang dimaksud dengan produk API? untuk mempelajari produk API lebih lanjut.)

Diagram urutan dari kiri ke kanan yang menunjukkan developer, aplikasi, API, dan layanan backend. Ikon dan resource API ditandai. Garis putus-putus menunjuk dari developer ke ikon aplikasi yang telah dibuat oleh developer. Panah dari dan kembali ke aplikasi menampilkan alur permintaan dan respons ke ikon API, dengan tombol aplikasi diposisikan di atas permintaan. Ikon dan resource API ditandai. Di bawah ikon API terdapat dua kumpulan jalur resource yang dikelompokkan menjadi dua produk API: Produk lokasi dan produk Media. Produk Location memiliki resource untuk /countries, /city, 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.

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:

  • Rilis 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 dengan versi gratis tetapi dengan batas akses rendah, seperti 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 Edge memberi Anda fleksibilitas untuk membuat produk API yang sesuai dengan persyaratan bisnis API Anda.

Untuk 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 aplikasinya, mereka menerima kunci API yang akan memberi aplikasi tersebut akses ke API.

Melalui proses pendaftaran aplikasi, Anda dapat mengontrol siapa yang memiliki akses ke API Anda. Anda dapat menghapus developer aplikasi kapan saja, yang akan membuat semua kunci API yang terkait dengan developer tersebut menjadi tidak valid, sehingga menolak akses developer tersebut ke API Anda.

Diagram urutan dari kiri ke kanan yang menunjukkan developer, aplikasi, API, dan layanan backend. Ikon developer ditandai. Garis putus-putus mengarah dari developer yang ditandai ke ikon aplikasi yang telah dibuat oleh developer. Panah dari dan kembali ke aplikasi menampilkan alur permintaan dan respons ke ikon API, dengan tombol aplikasi diposisikan di atas permintaan. Di bawah ikon API terdapat dua kumpulan jalur resource yang dikelompokkan menjadi dua produk API: Produk lokasi dan produk Media. Produk Location memiliki resource untuk /countries, /city, 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 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 belakang, serta nama perusahaan. Jika menyetujui permintaan developer, Anda dapat menggunakan UI pengelolaan Edge 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. Contoh:

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

Tugas 3: Mendaftarkan aplikasi developer di Edge

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

Diagram urutan dari kiri ke kanan yang menunjukkan developer, aplikasi, API, dan layanan backend. Panah aplikasi, permintaan/respons, dan kunci API ditandai. Garis putus-putus menunjuk dari developer ke ikon aplikasi yang telah dibuat oleh developer. Panah dari dan kembali ke aplikasi menampilkan alur permintaan dan respons ke ikon API, dengan tombol aplikasi diposisikan di atas permintaan. Ikon dan resource API ditandai. Di bawah ikon API terdapat dua kumpulan jalur resource yang dikelompokkan menjadi dua produk API: Produk lokasi dan produk Media. Produk Location memiliki resource untuk /countries, /city, 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 dan memilih dari daftar produk API yang tersedia.

Sebagai respons atas pendaftaran aplikasi di Edge, Edge menetapkan kunci API unik untuk 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 tersebut sehingga aplikasi tidak dapat lagi mengakses API Anda.

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

  • Gunakan proses manual yang mengharuskan developer menghubungi organisasi Anda untuk mendaftarkan aplikasinya. Sebagai respons, Anda harus mengirimkan kunci API kepada developer, mungkin melalui email.
  • Gunakan Edge management API untuk mengintegrasikan fungsi pendaftaran aplikasi dan pengiriman kunci ke dalam situs Anda.
  • Untuk akun Edge berbayar, gunakan portal Layanan Developer Apigee yang telah menyediakan 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 menyediakan dokumentasi dan mekanisme masukan developer. Portal developer dengan fitur publikasi sosial semakin banyak digunakan untuk berkomunikasi dengan komunitas pengembangan. Hal ini mencakup mengomunikasikan konten statis, seperti dokumentasi dan persyaratan penggunaan API, serta konten dinamis hasil kontribusi komunitas seperti blog dan forum, serta fitur dukungan pelanggan.

Diagram urutan dari kiri ke kanan yang menunjukkan developer, aplikasi, API, dan layanan backend. Ikon developer ditandai. Di bawah developer terdapat kotak yang merepresentasikan portal developer. Portal ini berisi dokumentasi, contoh, tutorial, referensi API, dan lainnya. Portal ini juga berisi blog, forum, dan portal dukungan. Garis putus-putus menunjuk dari developer yang ditandai ke ikon aplikasi yang telah dibuat oleh developer. Panah dari dan kembali ke aplikasi menampilkan alur permintaan dan respons ke ikon API, dengan tombol aplikasi yang diposisikan di atas permintaan. Di bawah ikon API terdapat dua kumpulan jalur resource yang dikelompokkan menjadi dua produk API: Produk lokasi dan produk Media. Produk Location memiliki resource untuk /countries, /city, 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 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 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

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

Topik metode SmartDocs API yang memungkinkan Anda memanggil weather API dengan mengklik tombol dalam topik.

Developer memasukkan nilai 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 Layanan API menggunakan klien HTTP apa pun. Apigee menggunakan SmartDocs untuk membuat dokumentasi interaktif bagi Edge Management API. Lihat dokumentasi API tersebut di sini.

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