Anda sedang melihat dokumentasi Apigee Edge.
Buka
dokumentasi Apigee X. info
Portal developer dengan fitur publikasi sosial semakin banyak digunakan untuk berkomunikasi dengan komunitas developer. Hal ini mencakup mengomunikasikan konten statis, seperti dokumentasi dan persyaratan penggunaan API, serta konten dinamis kontribusi komunitas seperti blog dan forum.
Sebagai penyedia API, Anda memerlukan cara untuk mengekspos API, mengedukasi developer tentang API Anda, mendaftarkan developer, dan mengizinkan developer mendaftarkan aplikasi. Mengekspos API Anda kepada developer hanyalah bagian dari pembuatan komunitas yang benar-benar dinamis. Anda juga memerlukan cara bagi komunitas developer untuk memberikan masukan, memberikan dukungan dan permintaan fitur, serta mengirimkan konten mereka sendiri yang dapat diakses oleh developer lain.
Apigee Edge menyediakan portal Layanan Developer yang dapat digunakan untuk membangun dan meluncurkan situs yang disesuaikan milik Anda guna menyediakan semua layanan ini kepada komunitas pengembangan Anda. Setiap pelanggan Edge dapat membuat portal developer mereka sendiri, baik di cloud maupun secara lokal.
Video berikut memperkenalkan portal Layanan Developer Apigee.
Gambar berikut menunjukkan halaman beranda portal developer default:
Portal developer pada dasarnya adalah sistem pengelolaan konten (CMS) berdasarkan project open source Drupal (http://www.drupal.org). Drupal menyediakan serangkaian fitur inti dalam bentuk modul yang memudahkan Anda membuat konten, serta mengelola situs.
Secara langsung, portal developer memungkinkan Anda membuat dokumentasi API, mendukung blogging, dan menyediakan forum thread. Anda juga dapat menyesuaikan portal developer untuk memenuhi persyaratan spesifik Anda. Penyesuaian memungkinkan Anda mengubah tampilan portal dan cara developer berinteraksi dengan portal.
Anda dapat menggunakan menu Drupal untuk melakukan sebagian besar penyesuaian. Jika Anda login ke portal sebagai pengguna yang memiliki hak istimewa admin, menu Drupal akan muncul di bagian atas setiap halaman portal:
Administrasi mengontrol proses tempat developer meminta akses ke portal, cara developer mendaftarkan aplikasi yang mengakses API Anda, cara menetapkan peran dan izin khusus kepada developer yang terkait dengan API Anda, dan kapan mencabut akses developer ke API.
Anda juga dapat menggunakan portal developer untuk mengonfigurasi dan mengontrol monetisasi. Monetisasi memberi developer akses layanan mandiri ke Penagihan & Laporan, Katalog & Paket, serta setelan khusus monetisasi melalui portal developer.
Jenis pengguna portal
Gambar berikut menampilkan dua jenis pengguna portal:
- Developer membentuk komunitas pengguna yang membuat aplikasi menggunakan API Anda. Developer aplikasi menggunakan portal untuk mempelajari API melalui SmartDocs, untuk mendaftarkan akun di portal, mendaftarkan aplikasi yang menggunakan API Anda, berinteraksi dengan komunitas developer, dan melihat informasi statistik tentang penggunaan aplikasi mereka di dasbor.
-
Tim API adalah penyedia API yang membuat konten portal, menyediakan API
untuk developer aplikasi, menyediakan dokumentasi API, dan menyediakan mekanisme bagi
developer untuk mendaftarkan aplikasi dan mendapatkan kunci API. Tim API melakukan konfigurasi dasar
portal developer untuk:
- Mengonfigurasi permintaan otomatis atau manual untuk kunci API
- Mengelola dokumentasi, forum, dan blog API serta merevisi semua perubahan jika diinginkan
- Menangani moderasi forum dan komentar pengguna
- Terapkan Role-based Access Control (RBAC) untuk mengontrol akses ke berbagai fitur di portal. Misalnya, administrator dapat mengaktifkan kontrol untuk mengizinkan pengguna terdaftar membuat postingan forum atau menggunakan konsol pengujian
- Sesuaikan notifikasi email bagi administrator maupun developer untuk pembuatan dan persetujuan pengguna
- Sesuaikan formulir web, seperti halaman "hubungi kami"
Tidak ditampilkan dalam gambar ini adalah jenis pengguna portal ketiga - API product manager. Product manager API bertanggung jawab untuk menentukan cara tim API membangun portal, termasuk:
- Menentukan cara API dikemas ke dalam produk
- Menetapkan aturan untuk persetujuan aplikasi
- Jika Monetisasi diaktifkan di portal, tentukan paket harga dan penagihan untuk produk API. Untuk informasi selengkapnya tentang Monetisasi, baca Ringkasan monetisasi.
Menyesuaikan portal developer
Sebagai penyedia API, pertimbangkan cara menyesuaikan portal developer agar cocok dengan API Anda dan memberikan informasi yang diperlukan bagi komunitas developer agar dapat menggunakan API Anda. Beberapa pertimbangan untuk portal kustom Anda meliputi:
- Akses yang mudah ke API Anda
- Dokumentasi, seperti panduan cara kerja dan dokumen referensi
- Konten kontribusi komunitas seperti blog dan forum diskusi
- Kode contoh
- Proses pendaftaran yang mudah sehingga developer, aplikasi, dan API baru dapat disetujui dengan cepat
- Hak dan kredensial terkelola
- Kontrol akses bertingkat
- Tampilan dan nuansa yang sesuai dengan organisasi Anda
Portal ini sudah ditentukan sebelumnya dengan konfigurasi dasar. Misalnya, secara mandiri, portal dikonfigurasi untuk mengizinkan siapa saja mendaftar sebagai developer, tetapi administrator harus menyetujui setiap pendaftaran sebelum developer dapat login ke portal. Setelah persetujuan pendaftaran, developer dapat mendaftarkan aplikasi untuk meminta kunci API dan menggunakan portal untuk mengakses resource API.
Langkah-langkah dalam proses pendaftaran default adalah:
- Developer mendaftar melalui portal developer. Sebagai respons, portal akan mengirimkan email ke administrator untuk menyetujui akun.
- Administrator menyetujui akun tersebut, dan email dikirim ke developer yang memberitahukan bahwa kini mereka dapat login.
- Developer mendaftarkan aplikasi dan memilih produk API yang digunakan oleh aplikasi. Sebagai respons, portal menetapkan kunci API unik ke aplikasi.
- Developer meneruskan kunci API saat membuat permintaan ke API Anda.
Pengalaman unik ini sangat mudah disesuaikan. Misalnya, Anda dapat mengganti skema otorisasi dan pendaftaran default sehingga developer baru akan otomatis disetujui dan login setelah pendaftaran. Atau, Anda dapat mewajibkan developer untuk menyetujui serangkaian persyaratan dan ketentuan sebelum mereka dapat login untuk pertama kalinya.
Anda juga memiliki kontrol penuh atas konten yang tersedia di portal developer. Secara langsung, portal developer menyajikan konten contoh seperti dokumentasi API, postingan blog, dan diskusi forum. Anda dapat menyediakan konten Anda sendiri dan menyesuaikan tampilan setiap jenis konten.
Untuk mengetahui informasi selengkapnya, lihat Menyesuaikan tampilan.
Mengelola portal developer
Developer menggunakan portal developer Anda untuk mengakses dan menggunakan API Anda. Administrator melakukan tugas pengelolaan akun, seperti:
- Menyesuaikan proses pendaftaran developer, termasuk kolom pendaftaran, bawaan Captcha, dan persetujuan otomatis atau manual
- Menambahkan atau menyetujui developer. Secara default, semua developer dapat mendaftar melalui portal developer, tetapi perlu disetujui oleh administrator melalui antarmuka pengguna Portal Dev. Administrator juga dapat membuat developer langsung di portal. Portal tersebut kemudian akan otomatis mengirimkan email kepada developer bahwa akun telah dibuat untuk mereka.
- Mengubah akun developer. Misalnya, administrator dapat mengubah status akun pengguna dari aktif menjadi diblokir atau mengubah informasi profil developer seperti nama perusahaan.
- Menghapus developer. Administrator dapat menonaktifkan atau menghapus akun developer.
- Menetapkan peran dan izin: Administrator dapat menetapkan peran tertentu untuk akun developer. Sebuah peran dikaitkan dengan berbagai izin, seperti izin untuk membuat buku atau konten lainnya. Anda juga dapat mengubah izin yang terkait dengan sebuah peran atau membuat peran baru.
Untuk informasi selengkapnya, lihat Menambahkan dan mengelola akun pengguna.
Ringkasan fitur portal developer
Tabel berikut berisi ringkasan fitur portal developer:
| Fitur | Detail |
|---|---|
| Dukungan browser | |
|
Pendaftaran pengguna |
|
|
Pengelolaan pengguna |
|
|
Tampilan portal |
|
|
Pengelolaan konten dan komunitas |
|
|
Izin |
|
|
Pengelolaan kunci API |
|
|
|
|
|
Blog |
|
|
Forum |
|
|
Dokumentasi |
|
|
Menu |
|
|
Telusuri |
|
|
Pemeriksa Link |
|