Anda sedang melihat dokumentasi Apigee Edge.
Buka
dokumentasi Apigee X. info
Apigee Edge menghadirkan portal terintegrasi yang mudah digunakan untuk mendokumentasikan dan mengelola akses ke API Anda, serta memupuk komunitas developer aplikasi.
Semua pengguna Apigee Edge memiliki akses ke alat pengembangan portal terintegrasi yang memungkinkan mereka membangun portal developer mereka sendiri dengan cepat, sehingga memberikan alternatif untuk pengembangan portal berbasis Drupal. Untuk perbandingan fitur, lihat Perbandingan fitur portal developer.
Tonton video singkat ini untuk memperkenalkan cara membuat dan memublikasikan portal terintegrasi.
Fitur dan manfaat utama
Portal terintegrasi ini memberi Anda fitur dan manfaat utama berikut:| Fitur | Manfaat |
|---|---|
| Pengembangan konten portal | Kembangkan konten portal Anda dengan cepat dan mudah.
|
| Tampilan dan nuansa portal | Sesuaikan tampilan dan nuansa portal Anda sepenuhnya menggunakan style sheet SCSS dan branding yang dipersonalisasi. |
| Dokumentasi API | Membuat otomatis dokumentasi referensi API berdasarkan Spesifikasi OpenAPI Anda. |
| Pendaftaran layanan mandiri | Menyediakan pendaftaran layanan mandiri bagi developer untuk membangun aplikasi menggunakan API Anda. |
| Pengelolaan audiens | Kontrol siapa saja yang dapat mengakses konten portal dan API |
| Analytics | Mengonfigurasi pelacakan Google Analytics dan analisis kustom. |
| Penyesuaian lanjutan | Lakukan penyesuaian portal lanjutan, antara lain:
|
Mulai buat portal Anda
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 |
Termasuk pendaftaran domain apigee.io dengan Daftar Akhiran Publik
|
Melarang "supercookies" ditetapkan pada subdomain apigee.io
|
| Mendukung konfigurasi Kebijakan keamanan konten (CSP) | Melindungi dari pembuatan skrip lintas situs (XSS) dan serangan injeksi kode lainnya |
Memerlukan:
|
Melindungi dari serangan HTML, SQL, atau injeksi backend |
Menyertakan header XSS x-content-type-options: nosniff
|
Mencegah browser mencoba menebak jenis MIME |
Menyertakan header XSS x-frame-options: deny
|
Melarang penyematan konten portal ke dalam iFrame |
Menyertakan header XSS x-xss-protection: 1
|
Melarang pemuatan halaman jika halaman tersebut mendeteksi serangan pembuatan skrip lintas situs (XSS) yang tercermin |
| Menggunakan token CSRF | Melindungi dari pemalsuan permintaan lintas situs |
Memanfaatkan:
|
Perlindungan data pelanggan |
Cara portal terintegrasi berkomunikasi dengan Edge
Sebagian besar informasi yang digunakan oleh portal developer disimpan di Apigee Edge. Portal ini bertindak sebagai klien untuk Edge. Jika diperlukan, portal developer mengirimkan permintaan REST HTTP atau HTTPS untuk mengambil informasi dari atau mengirim informasi ke Edge. Misalnya, saat pengguna portal mendaftarkan aplikasi baru di portal, portal akan mengirimkan permintaan ke Edge untuk menyimpan informasi tentang aplikasi.
Bagian berikut memberikan detail lebih lanjut.
Tempat pendaftaran aplikasi dan kunci API disimpan
Saat pengguna portal menyelesaikan proses pendaftaran aplikasi di portal terintegrasi, portal akan mengirimkan informasi tentang aplikasi ke Apigee Edge, termasuk nama aplikasi dan produk API yang terkait dengan aplikasi tersebut. Jika Edge berhasil mendaftarkan aplikasi, Edge 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 Edge dan tidak disimpan di portal. Saat pengguna portal menggunakan portal untuk melihat informasi tentang aplikasi, misalnya melalui halaman Aplikasi Saya, portal akan membuat permintaan ke Edge dengan kunci API untuk mengakses informasi.
Demikian pula, saat pengguna portal menambahkan, menghapus, atau memodifikasi aplikasi, portal mengirimkan modifikasi ke Edge untuk disimpan.
Karena semua informasi tentang aplikasi dan kunci API disimpan di Edge, administrator Edge dapat mengubah informasi dengan menggunakan UI Edge 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 Mendaftarkan aplikasi dan mengelola kunci API.
Tempat informasi akun developer aplikasi disimpan
Informasi akun developer disimpan di Edge, sebagai berikut:
- Dengan menggunakan penyedia identitas bawaan, saat pengguna portal membuat akun, informasi akan 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 akan disinkronkan dan tersedia di Edge pada halaman Developer.
Informasi akun pengguna berikut disimpan di Edge:
- Nama depan dan belakang
- Alamat email
- Nama pengguna
- Status akun portal (aktif atau tidak aktif)
- Peran portal (pengguna terautentikasi, administrator, lainnya)
- Izin berbasis peran
- Tim yang diikuti oleh pengguna portal (jika Anda telah mendaftar dalam rilis beta fitur tim)
Alamat email adalah kunci utama yang digunakan oleh Edge untuk mengidentifikasi developer dan masing-masing harus unik. Dari kunci utama, Edge akan membuat ID developer unik untuk setiap organisasi tempat developer berada.
Untuk mengetahui informasi selengkapnya, lihat Mendaftarkan developer aplikasi.
Tempat informasi tim developer disimpan (beta)
Jika tim developer dibuat di portal oleh pengguna portal, informasi tim developer akan disimpan di Edge, termasuk:
- Nama dan deskripsi tim developer
- Anggota tim pengembang dan peran mereka
- Aplikasi yang ditugaskan kepada tim developer
- Audiens yang ditetapkan ke tim developer
- Waktu pembuatan tim developer
Alamat email unik yang dibuat secara otomatis dibuat untuk tim developer dan berfungsi sebagai kunci utama yang digunakan oleh Edge untuk mengidentifikasi tim developer.
Untuk mengetahui informasi selengkapnya, lihat Berbagi tanggung jawab atas aplikasi menggunakan tim developer (beta) dan Mengelola tim developer.
Tentang portal contoh
Saat Anda membuat portal baru, akan disediakan sekumpulan halaman awal untuk digunakan 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. Contoh tema portal menggunakan tema desain material dan SCSS.
Berikut adalah halaman beranda dari portal contoh.
Halaman awal yang disediakan dengan portal contoh mencakup:
| Halaman | Deskripsi |
|---|---|
| Beranda | Halaman beranda portal yang menjelaskan API yang ditampilkan. Berfungsi sebagai halaman beranda default untuk portal Anda (index.html). Mendemonstrasikan penggunaan komponen materi sudut, seperti yang dijelaskan dalam Menambahkan komponen materi sudut. |
| Mulai Cepat | Serangkaian langkah cepat yang menunjukkan cara menyesuaikan portal. Klik Mulai Cepat di portal contoh untuk langkah menambahkan konten ke halaman Mulai. |
| Mulai | Contoh halaman konten. Lihat halaman Memulai di portal contoh untuk mempelajari cara mengedit halaman ini dan menambahkannya ke navigasi atas. |
| 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 tidak dapat mengedit konten halaman ini secara langsung; karena halaman tidak akan muncul di daftar halaman. Anda dapat mengubah gaya halaman menggunakan editor tema portal. |
| Apl Saya | Daftar aplikasi terdaftar untuk pengguna yang diotorisasi. Lihat Cara pengguna portal berinteraksi dengan portal Anda. Catatan: Konten halaman ini dibuat secara otomatis berdasarkan aplikasi pengguna yang terdaftar. Anda tidak dapat mengedit konten halaman secara langsung; konten tidak akan muncul di 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 Login. 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 khusus ke halaman Buat Akun. Anda tidak dapat mengedit konten halaman secara langsung; konten tidak akan muncul di daftar halaman. |
| Persyaratan dan Ketentuan | Contoh halaman persyaratan dan ketentuan. |
Dukungan browser
Portal terintegrasi Apigee mendukung versi browser yang sama dengan Apigee Edge.