API7 Enterprise v3.3.0 Mendukung API Portal

Ikhtisar Portal Pengembang

Portal Pengembang adalah platform khusus yang dirancang untuk konsumen API (misalnya, pengembang pihak ketiga dan tim internal) yang menyediakan akses terpadu ke dokumentasi API, alat pengujian, dan sumber daya terkait. Portal ini tidak hanya memfasilitasi pengembang dalam memahami dan mengintegrasikan API dengan cepat, tetapi juga meningkatkan kemampuan visualisasi dan kontrol pada tingkat manajemen dan keamanan. Untuk platform gateway API, menyediakan portal pengembang memungkinkan hal berikut:

1. Ekspos API yang Terstruktur: Dengan mengkonsolidasikan dokumentasi, contoh, dan spesifikasi antarmuka yang terfragmentasi ke dalam platform terpadu, portal ini secara signifikan mengurangi biaya integrasi dan mempercepat integrasi produk dengan sistem eksternal.

2. Meningkatkan Efisiensi R&D dan Operasi: Fitur self-service seperti pencarian dokumentasi, pengujian, dan debugging mengurangi komunikasi berulang dan pemeliharaan dokumentasi, sehingga meningkatkan efisiensi secara keseluruhan.

3. Manajemen dan Pemantauan Terpusat: Platform ini menyediakan pelacakan penggunaan API, analisis respons, dan pemantauan metrik kunci yang lebih baik, serta deteksi dini masalah potensial.

Dalam API7 Enterprise 3.3.0, API7 Gateway sekarang mendukung pembuatan otomatis portal pengembang langsung dari dokumentasi API yang diberikan pengguna. Kemampuan ini memungkinkan organisasi untuk lebih mudah mengekspos sumber daya API kepada pihak eksternal sambil memberikan pengalaman yang konsisten dan nyaman bagi pengembang.

API7 Provider Portal dan Developer Portal

Sebagai platform manajemen API, API7 Provider Portal dan Developer Portal memiliki peran yang saling melengkapi tetapi melayani audiens dan fungsionalitas yang berbeda.

API7 Provider Portal

API7 Provider Portal adalah konsol manajemen yang dirancang khusus untuk penyedia API untuk memfasilitasi manajemen siklus hidup API dengan mudah.

• Target Audiens: Penyedia API dan administrator
• Fungsi Inti:
  • Menerbitkan dan mengelola produk API.
  • Mengelola pengembang.
  • Mengonfigurasi kebijakan untuk akses Developer Portal, seperti melihat API secara anonim dan metode login.
  • Memvisualisasikan statistik akses API, melakukan analisis, dan melacak log.

API7 Developer Portal

API7 Developer Portal menyediakan titik masuk self-service yang terpadu untuk pengembang atau mitra, memungkinkan mereka untuk dengan cepat memahami, mengakses, dan memanfaatkan layanan API.

• Target Audiens: Konsumen API, seperti pengembang pihak ketiga, mitra, atau tim pengembangan internal
• Fungsi Inti:
  • Menyediakan dokumentasi API, panduan penggunaan, dan contoh kode.
  • Menyediakan antarmuka pengujian dan debugging online.
  • Mengelola pendaftaran aplikasi, mendapatkan kunci API, dan menangani kredensial autentikasi.

Cara Menggunakan API7 Portal

Mengakses API7 Provider Portal

Setelah masuk ke dasbor API7 Enterprise, pengguna akan diarahkan ke halaman Manajemen Gateway secara default. Untuk beralih ke API7 Provider Portal, klik tombol toggle di sudut kiri atas. Setelah beralih, judul halaman akan diperbarui menjadi API7 Provider Portal, dan menu di sebelah kiri mencerminkan opsi yang relevan untuk mengelola produk API.

Membuat dan Menerbitkan Produk API

Produk API adalah sumber daya inti di API7 Provider Portal, yang mewakili sekelompok API terkait. Pengembang biasanya berlangganan API pada tingkat produk. Ada dua metode untuk membuat produk API.

1. Berdasarkan Layanan yang Diterbitkan di API7 Gateway

• Pilih layanan yang sudah diterbitkan di API7 Gateway dan kelompokkan ke dalam produk API.
• Dalam produk API, setiap rute yang sesuai dengan layanan diperlakukan sebagai API independen.

2. Mengimpor File OpenAPI

• Cepat menghasilkan produk API dengan mengimpor file OpenAPI yang sudah ada.
• Perhatikan bahwa produk yang dibuat dengan cara ini tidak langsung terhubung dengan konfigurasi gateway.

Contoh: Menambahkan Produk API dari API7 Gateway

Untuk menambahkan produk API, klik tombol "Add API Product" dan pilih menu item "From API7 Gateway" untuk mengakses formulir pembuatan produk API.

Pada formulir, Anda perlu mengisi informasi berikut:

1. Dasar: Termasuk nama, deskripsi, label, logo, dll.

2. Jenis Autentikasi: Tentukan apakah persetujuan diperlukan.

3. Visibilitas: Tetapkan ruang lingkup visibilitas produk API.

4. Layanan Gateway yang Terhubung: Pilih layanan gateway yang diterbitkan yang memenuhi dua kondisi berikut:

   • Nama host telah dikonfigurasi.
   • Dokumen OpenAPI telah diunggah.

Menambahkan Produk API Baru

Jika tidak ada layanan yang memenuhi persyaratan, Anda dapat mengikuti langkah konfigurasi di bawah ini.

1. Mengunggah Dokumen OpenAPI dan Mengonfigurasi Nama Host untuk Layanan yang Ada

Di halaman detail layanan atau template layanan, klik OpenAPI Specification di bilah navigasi kiri. Kemudian, unggah dokumen OpenAPI yang sesuai untuk layanan tersebut. Pastikan bahwa definisi API dalam dokumen sesuai persis dengan rute aktual layanan. Ini menjamin dokumentasi API yang akurat bagi pengembang selama debugging dan akses upstream yang berhasil.

Setelah mengunggah dokumen, Anda dapat melihat pratinjau secara real-time, yang mencerminkan dokumentasi API akhir yang akan diakses pengembang.

Selanjutnya, di bagian Routes pada halaman detail layanan atau detail template, konfigurasi hosts di modul Request URL. Secara default, hosts diatur ke "*", yang berarti layanan memproses permintaan dari nama host apa pun.

Untuk menghubungkan layanan ke produk API, nama host yang tepat harus ditentukan. Persyaratan ini memastikan bahwa pengembang dapat mengakses API menggunakan format jalur lengkap: host + path prefix + API.

2. Membuat Layanan Baru untuk Dihubungkan ke Produk API

Jika tidak ada layanan yang telah diterbitkan, Anda dapat membuat layanan baru dengan mengunggah dokumen OpenAPI sebagai template layanan dan menerbitkannya, atau dengan membuat layanan di grup gateway secara langsung. Layanan yang dibuat dengan cara ini secara otomatis mengurai API yang didefinisikan dalam OpenAPI menjadi rute, mempertahankan dokumen tanpa perlu mengunggah ulang. Konfigurasi host seperti yang dijelaskan sebelumnya untuk membuat layanan memenuhi syarat untuk dihubungkan ke produk API.

Setelah konfigurasi gateway selesai, kembali ke provider portal dan klik Add Linked Gateway Service. Pilih layanan yang diterbitkan yang diperlukan untuk menyelesaikan penghubungan.

Secara default, produk API yang baru dibuat akan berada dalam status draf, tidak terlihat oleh pengembang. Sebelum menerbitkan, tinjau dokumentasi API, pengaturan visibilitas, dan pengaturan autentikasi. Disarankan untuk mengonfigurasi notifikasi acara produk API (misalnya, persetujuan atau pembatalan langganan) untuk menghindari kehilangan pembaruan penting.

Menerbitkan Produk API

Setelah memverifikasi produk API, klik tombol Publish di sudut kanan atas dan konfirmasi. Pengembang yang sesuai dengan pengaturan visibilitas kemudian dapat mengakses produk melalui Developer Portal.

Mengakses API7 Developer Portal

Anda dapat mengakses API7 Developer Portal dengan dua cara:

1. Kunjungi URL Developer Portal.
2. Klik tombol Developer Portal di menu kiri dasbor API7 Portal.

Di beranda API7 Developer Portal, klik tombol Login di sudut kanan atas untuk masuk.

Membuat Pengembang

Ada dua cara untuk membuat akun pengembang:

• Pendaftaran Mandiri: Pengembang mendaftar sendiri di halaman login.
• Undangan Administrator: Administrator membuat akun melalui dasbor API7 Portal.

Pendaftaran Mandiri

Klik tombol Sign up di halaman login, dan lengkapi formulir dengan nama pengguna dan kata sandi.

Pendaftaran yang Diprakarsai Administrator

Di dasbor API7 Portal, navigasikan ke bagian Developers dan klik Invite Developer. Isi formulir dengan nama pengguna dan kata sandi satu kali, dan secara opsional berikan nama tampilan untuk identifikasi.

Setelah menambahkan pengembang, bagikan nama pengguna dan kata sandi kepada pengguna. Saat pertama kali masuk, mereka harus mengatur ulang kata sandi mereka.

Melihat Produk API

Setelah masuk, pengembang dapat mengklik API Hub untuk melihat semua produk API yang diterbitkan.

Selain melihat dokumentasi API, sistem juga mendukung pembuatan contoh kode multi-bahasa untuk setiap API di halaman detail. Pengembang dapat menyalin contoh kode ini ke lingkungan pengembangan mereka untuk pengujian.

Debugging Produk API

Selain itu, pengembang dapat menguji API langsung dengan mengklik tombol Test Request.

Setelah mengklik Test Request, Anda dapat melihat panel pengujian online.

• Request URL dihasilkan secara otomatis berdasarkan konfigurasi layanan yang terkait dengan produk API.
• Metode Autentikasi defaultnya adalah Key Auth dan secara otomatis mengisi API Key untuk akun pengembang saat ini.

Pengembang hanya perlu melengkapi parameter permintaan yang diperlukan sesuai dengan definisi antarmuka API untuk melanjutkan debugging.

Berlangganan Produk API

Jika produk API dibatasi untuk pengguna tertentu, administrator provider portal dapat menonaktifkan opsi Unsubscribed developers can view API details dalam pengaturan visibilitas produk. Ini memastikan bahwa pengembang harus berlangganan produk sebelum mengakses atau memanggil API-nya.

Ketika pengembang mengakses halaman detail produk API di bawah pengaturan ini, tombol "Subscribe to Unlock" akan ditampilkan. Mengklik tombol ini mengirimkan permintaan langganan kepada administrator penyedia.

Jika proses persetujuan diaktifkan untuk produk API, pengembang harus menunggu persetujuan administrator sebelum mendapatkan akses untuk melihat detail.

Di menu Organisasi API7 Provider Portal, jika ada persetujuan yang tertunda, titik merah akan muncul di sebelah item menu Approvals sebagai indikator. Mengklik item menu ini akan mengarahkan ke halaman manajemen persetujuan.

Halaman persetujuan dirancang untuk mengelola permintaan pengembang untuk mengakses sumber daya API. Administrator dapat meninjau informasi permintaan berikut di halaman ini: jenis acara, nama sumber daya, pemohon, dan waktu pengajuan. Melalui antarmuka, administrator dapat mengambil tindakan untuk Menyetujui atau Menolak permintaan.

Keputusan persetujuan secara langsung memengaruhi izin akses API pengembang:

• Setujui: Pengembang mendapatkan akses untuk melihat halaman detail produk API dan memanggil API.
• Tolak: Pengembang harus berkomunikasi dengan administrator, melakukan penyesuaian yang diperlukan berdasarkan umpan balik, dan mengajukan kembali permintaan.

Kesimpulan

API7 Enterprise mengintegrasikan platform gateway API dengan portal pengembang untuk menciptakan solusi manajemen API yang efisien bagi penyedia API dan pengembang.

API7 Provider Portal memungkinkan penyedia API untuk dengan mudah menerbitkan, mengelola, dan memantau produk API sambil secara efektif mengoordinasikan sumber daya pengembang. Sementara itu, pengembang dapat dengan cepat memahami, mengintegrasikan, dan memanfaatkan layanan API secara efisien, mempercepat pengembangan aplikasi. Kedua portal ini bekerja secara sinergis untuk menyederhanakan proses manajemen siklus hidup API, membuat setiap langkah—dari penyebaran hingga pemanggilan—lebih lancar dan efisien.