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 komunikasi konten statis, seperti dokumentasi dan persyaratan penggunaan API, serta konten dinamis yang dikontribusikan oleh komunitas seperti blog dan forum.
Sebagai penyedia API, Anda memerlukan cara untuk mengekspos API, mengedukasi developer tentang API, mendaftarkan developer, dan mengizinkan developer mendaftarkan aplikasi. Mengekspos API Anda kepada developer hanyalah bagian dari upaya untuk menciptakan komunitas yang benar-benar dinamis. Anda juga memerlukan cara bagi komunitas developer untuk memberikan masukan, membuat permintaan dukungan dan fitur, serta mengirimkan konten mereka sendiri yang dapat diakses oleh developer lain.
Apigee Edge menyediakan portal Layanan Developer yang dapat Anda gunakan untuk membuat dan meluncurkan situs kustom Anda sendiri guna menyediakan semua layanan ini kepada komunitas pengembangan Anda. Setiap pelanggan Edge dapat membuat portal developer mereka sendiri, baik di cloud maupun di 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 Drupal (http://www.drupal.org) open source. Drupal menyediakan serangkaian fitur inti dalam bentuk modul yang memudahkan Anda membuat konten untuk, serta mengelola, situs.
Secara default, portal developer memungkinkan Anda membuat dokumentasi API, mendukung blogging, dan menyediakan forum dengan rangkaian pesan. Anda juga dapat menyesuaikan portal developer untuk memenuhi persyaratan spesifik Anda. Penyesuaian memungkinkan Anda mengubah tampilan portal dan juga cara developer berinteraksi dengan portal.
Anda menggunakan menu Drupal untuk melakukan sebagian besar penyesuaian. Jika Anda login ke portal sebagai pengguna dengan hak istimewa admin, menu Drupal akan muncul di bagian atas setiap halaman portal:
Administrasi mengontrol proses saat developer meminta akses ke portal, cara developer mendaftarkan aplikasi yang mengakses API Anda, cara Anda menetapkan peran dan izin tertentu kepada developer yang terkait dengan API Anda, dan kapan harus 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, dan setelan khusus monetisasi melalui portal developer.
Jenis pengguna portal
Gambar berikut menunjukkan dua jenis pengguna portal:
- Developer membentuk komunitas pengguna yang mem-build aplikasi menggunakan API Anda. Developer aplikasi menggunakan portal untuk mempelajari API Anda melalui SmartDocs, 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 mereka
kepada 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 secara opsional merevisi semua perubahan
- Menangani komentar pengguna dan moderasi forum
- Terapkan Kontrol Akses Berbasis Peran (RBAC) untuk mengontrol akses ke fitur di portal. Misalnya, administrator dapat mengaktifkan kontrol untuk mengizinkan pengguna terdaftar membuat postingan forum atau menggunakan konsol pengujian
- Menyesuaikan notifikasi email kepada administrator dan developer untuk pembuatan dan persetujuan pengguna
- Menyesuaikan formulir web seperti halaman "hubungi kami"
Tidak ditampilkan dalam gambar ini adalah jenis pengguna portal ketiga - pengelola produk API. Pengelola produk API bertanggung jawab untuk menentukan cara tim API membuat portal, termasuk:
- Menentukan cara API dikemas ke dalam produk
- Menentukan aturan untuk persetujuan aplikasi
- Jika Monetisasi diaktifkan di portal, menentukan harga dan paket penagihan untuk produk API. Untuk mengetahui informasi selengkapnya tentang Monetisasi, lihat Ringkasan monetisasi.
Menyesuaikan portal developer
Sebagai penyedia API, pertimbangkan cara menyesuaikan portal developer agar paling sesuai dengan API Anda dan untuk memberikan informasi yang diperlukan bagi komunitas developer Anda agar dapat menggunakan API Anda. Beberapa pertimbangan untuk portal kustom Anda meliputi:
- Akses 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, tempat developer, aplikasi, dan API baru dapat disetujui dengan cepat
- Hak dan kredensial terkelola
- Kontrol akses berlapis
- Tampilan dan nuansa yang cocok dengan organisasi Anda
Portal ini sudah ditetapkan sebelumnya dengan konfigurasi dasar. Misalnya, portal ini dikonfigurasi secara default 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 mengirim email kepada administrator untuk menyetujui akun.
- Administrator menyetujui akun, dan email akan dikirim ke developer untuk memberitahukan bahwa mereka kini 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 langsung ini sangat mudah disesuaikan. Misalnya, Anda dapat mengganti skema pendaftaran dan otorisasi default sehingga developer baru 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 default, portal developer menampilkan konten contoh seperti dokumentasi API, postingan blog, dan diskusi forum. Anda dapat menyediakan konten sendiri, dan menyesuaikan tampilan setiap jenis konten.
Untuk informasi selengkapnya, lihat Menyesuaikan tampilan.
Mengelola developer portal
Developer menggunakan portal developer Anda untuk mengakses dan menggunakan API Anda. Administrator melakukan tugas pengelolaan akun, seperti:
- Menyesuaikan proses pendaftaran developer, termasuk kolom pendaftaran, CAPTCHA bawaan, dan persetujuan otomatis atau manual
- Menambahkan atau menyetujui developer. Secara default, setiap developer dapat mendaftar melalui portal developer, tetapi harus disetujui oleh administrator melalui antarmuka pengguna Dev Portal. Administrator juga dapat membuat developer langsung di portal. Portal tersebut kemudian akan otomatis mengirimkan email kepada developer bahwa akun telah dibuat untuknya.
- 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 ke akun developer. Peran dikaitkan dengan berbagai izin, seperti izin untuk membuat buku atau konten lainnya. Anda juga dapat mengubah izin yang terkait dengan 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 |
|