Halaman ini berlaku untuk Apigee dan Apigee Hybrid.
Lihat dokumentasi
Apigee Edge.
Apigee menyediakan portal terintegrasi yang mudah digunakan untuk mendokumentasikan dan mengelola akses ke API Anda, serta memupuk komunitas developer aplikasi Anda.
Semua pengguna Apigee memiliki akses ke alat pengembangan portal terintegrasi yang memungkinkan mereka membangun portal developer sendiri dengan cepat, sehingga memberikan alternatif untuk pengembangan portal berbasis Drupal. Untuk perbandingan fitur, lihat Perbandingan fitur portal developer.
Fitur dan manfaat utama
Portal terintegrasi ini menyediakan fitur dan manfaat utama berikut:Fitur | Manfaat |
---|---|
Pengembangan konten portal | Kembangkan konten portal Anda dengan cepat dan mudah.
|
Tampilan portal | Sesuaikan sepenuhnya tampilan dan nuansa portal Anda menggunakan lembar gaya SCSS dan branding yang dipersonalisasi. |
Dokumentasi API | Buat dokumentasi referensi API secara otomatis berdasarkan Spesifikasi OpenAPI Anda. |
Pendaftaran layanan mandiri | Menyediakan pendaftaran layanan mandiri bagi developer untuk membuat aplikasi menggunakan API Anda. |
Pengelolaan audiens | Mengontrol siapa yang dapat mengakses konten dan API portal |
Analytics | Konfigurasi pelacakan Google Analytics dan analisis kustom. |
Penyesuaian lanjutan | Lakukan penyesuaian portal lanjutan, termasuk:
|
Cara Apigee menangani keamanan di portal terintegrasi
Tabel berikut menjelaskan cara Apigee menangani keamanan melalui fitur bawaan di portal terintegrasi.
Fitur | Alamat |
---|---|
Memerlukan HTTPS dan transport layer security (TLS) | Menerapkan komunikasi terenkripsi |
Mencakup pendaftaran domain apigee.io dengan Daftar Suffix Publik
|
Tidak mengizinkan "supercookie" disetel di subdomain apigee.io
|
Wajib:
|
Melindungi dari serangan injeksi HTML, SQL, atau backend |
Mencakup header XSS x-content-type-options: nosniff
|
Mencegah browser mencoba menebak jenis MIME |
Mencakup header XSS x-frame-options: deny
|
Tidak mengizinkan penyematan konten portal ke dalam iFrame |
Mencakup header XSS x-xss-protection: 1
|
Mencegah halaman dimuat saat mendeteksi serangan pembuatan skrip lintas situs (XSS) yang dipantulkan |
Menggunakan token CSRF | Melindungi dari pemalsuan permintaan lintas situs |
Memanfaatkan:
|
Perlindungan data pelanggan |
Cara portal terintegrasi berkomunikasi dengan Apigee
Sebagian besar informasi yang digunakan oleh portal developer disimpan di Apigee. Portal ini bertindak sebagai klien untuk Apigee. Jika diperlukan, portal developer akan mengirim permintaan REST HTTP atau HTTPS untuk mengambil informasi dari atau mengirim informasi ke Apigee. Misalnya, saat pengguna portal mendaftarkan aplikasi baru di portal, portal akan mengirimkan permintaan ke Apigee untuk menyimpan informasi tentang aplikasi tersebut.
Bagian berikut memberikan detail selengkapnya.
Tempat penyimpanan pendaftaran aplikasi dan kunci API
Saat pengguna portal menyelesaikan proses pendaftaran aplikasi di portal terintegrasi, portal akan mengirimkan informasi tentang aplikasi ke Apigee, termasuk nama aplikasi dan produk API yang terkait dengan aplikasi. Jika Apigee berhasil mendaftarkan aplikasi, Apigee akan menampilkan satu kunci API ke portal. Pengguna portal menggunakan kunci API tersebut untuk mengakses produk API yang terkait dengan aplikasi.
Informasi tentang aplikasi dan kunci API hanya disimpan di Apigee; informasi tersebut tidak disimpan di portal. Saat pengguna portal menggunakan portal untuk melihat informasi tentang aplikasi, misalnya melalui halaman Aplikasi Saya, portal akan membuat permintaan ke Apigee dengan kunci API untuk mengakses informasi tersebut.
Demikian pula, saat pengguna portal menambahkan, menghapus, atau mengubah aplikasi, portal akan mengirimkan perubahan ke Apigee untuk disimpan.
Karena semua informasi tentang aplikasi dan kunci API disimpan di Apigee, administrator Apigee dapat mengubah informasi tersebut menggunakan UI Apigee atau API pengelolaan. Misalnya, administrator dapat:
- Menambahkan, menghapus, atau mengubah aplikasi developer
- Menyetujui atau mencabut kunci API untuk aplikasi developer
Untuk mengetahui informasi selengkapnya, lihat Mengontrol akses ke API Anda dengan mendaftarkan aplikasi.
Tempat informasi akun developer aplikasi disimpan
Informasi akun developer disimpan di Apigee, sebagai berikut:
- Dengan menggunakan penyedia identitas bawaan, saat pengguna portal membuat akun, informasi tersebut disimpan di penyedia identitas dan ditampilkan di halaman Pengguna.
- Dengan menggunakan penyedia identitas SAML, saat pengguna portal login ke portal, catatan bayangan informasi akan disimpan di penyedia identitas dan ditampilkan di halaman Pengguna.
- Setelah pengguna portal mendaftarkan aplikasi developer, informasi akun pengguna disinkronkan dan tersedia di Apigee di halaman Developer.
Informasi akun pengguna berikut disimpan di Apigee:
- Nama depan dan belakang
- Alamat email
- Nama pengguna
- Status akun portal (aktif atau tidak aktif)
- Peran portal (pengguna yang diautentikasi, administrator, lainnya)
- Izin berbasis peran
- Tim tempat pengguna portal menjadi anggota (jika Anda telah mendaftar dalam rilis Pratinjau fitur tim)
Alamat email adalah kunci utama yang digunakan oleh Apigee untuk mengidentifikasi developer dan setiap alamat email harus unik. Dari kunci utama, Apigee membuat ID developer unik untuk setiap organisasi tempat developer berada.
Untuk mengetahui informasi selengkapnya, lihat Mendaftarkan developer aplikasi.
Tempat informasi tim developer disimpan (Pratinjau)
Saat tim developer dibuat di portal oleh pengguna portal, informasi tim developer akan disimpan di Apigee, termasuk:
- Nama dan deskripsi tim developer
- Anggota tim developer dan perannya
- Aplikasi yang tim developernya ditetapkan
- Audiens yang ditetapkan ke tim developer
- Waktu tim developer dibuat
Alamat email unik yang dibuat secara otomatis akan dibuat untuk tim developer dan berfungsi sebagai kunci utama yang digunakan oleh Apigee untuk mengidentifikasi tim developer.
Untuk mengetahui informasi selengkapnya, lihat Membagikan tanggung jawab atas aplikasi menggunakan tim developer (Pratinjau) dan Mengelola tim developer.
Tentang portal contoh
Saat Anda membuat portal baru, serangkaian halaman awal disediakan untuk Anda gunakan sebagai titik awal. Halaman awal berisi konten demo untuk membantu menginspirasi pengembangan portal Anda sendiri saat Anda mengganti teks dan gambar dengan konten unik Anda. Tema portal contoh menggunakan tema desain material dan SCSS.
Berikut ini halaman beranda portal contoh.
Halaman awal yang disediakan dengan contoh portal mencakup:
Halaman | Deskripsi |
---|---|
Beranda | Halaman beranda portal yang menjelaskan API yang ditampilkan. Berfungsi sebagai halaman beranda default untuk portal Anda (index.html). Menunjukkan penggunaan komponen angular material, seperti yang dijelaskan dalam Menambahkan komponen angular material. |
Mulai | Contoh halaman konten. Pelajari cara mengedit halaman ini dan menambahkannya ke navigasi atas dengan mengikuti tutorial langkah demi langkah. |
API | Daftar API yang tersedia. Saat Anda membuat dokumentasi referensi API interaktif, link ke konten akan ditambahkan ke halaman ini secara otomatis. Catatan: Konten halaman ini dibuat secara otomatis berdasarkan API yang Anda publikasikan ke portal Anda. Anda tidak dapat mengedit konten halaman ini secara langsung; halaman ini tidak muncul dalam daftar halaman. Anda dapat mengubah gaya halaman menggunakan editor tema portal. |
Aplikasi Saya | Daftar aplikasi terdaftar untuk pengguna yang diotorisasi. Lihat Cara pengguna portal berinteraksi dengan portal Anda. Catatan: Isi halaman ini dibuat secara otomatis berdasarkan aplikasi pengguna terdaftar. Anda tidak dapat mengedit konten halaman secara langsung; halaman tersebut tidak muncul dalam daftar halaman. Anda dapat mengubah gaya halaman menggunakan editor tema. |
Login | Halaman login untuk pengguna terdaftar. Pengguna baru dapat mendaftar dari halaman ini dengan mengklik Buat akun. Lihat Cara pengguna portal berinteraksi dengan portal Anda. Catatan: Halaman Login disertakan di portal Anda secara otomatis. Anda dapat menyesuaikan logo di halaman Login dan menambahkan kolom pendaftaran kustom ke halaman Buat Akun. Anda tidak dapat mengedit konten halaman secara langsung; halaman tersebut tidak muncul dalam daftar halaman. " |
Persyaratan dan Ketentuan | Contoh halaman persyaratan dan ketentuan. |