Membuat portal terintegrasi

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Baca dokumentasi Apigee Edge.

Apigee menyediakan portal terintegrasi yang mudah digunakan untuk mendokumentasikan dan mengelola akses ke API Anda, serta mendukung komunitas developer aplikasi Anda.

Semua pengguna Apigee memiliki akses ke alat pengembangan portal terintegrasi yang memungkinkan mereka membangun portal developer mereka sendiri dengan cepat, yang memberikan alternatif pengembangan portal berbasis Drupal. Untuk perbandingan fitur, lihat Perbandingan fitur portal developer.

Video: Tonton video singkat ini untuk pengenalan cara membuat dan memublikasikan portal terintegrasi.

Fitur dan manfaat utama

Portal terintegrasi memberi Anda fitur dan manfaat utama berikut:
Fitur Manfaat
Pengembangan konten portal Kembangkan konten portal dengan cepat dan mudah.
  • Buat halaman menggunakan editor halaman yang mudah digunakan
  • Menggunakan Markdown dan HTML untuk membuat konten
  • Tambahkan menu untuk menavigasi portal Anda
Tampilan dan nuansa portal Sesuaikan sepenuhnya tampilan dan nuansa portal Anda menggunakan lembar gaya SCSS dan branding yang dipersonalisasi.
Dokumentasi API Membuat dokumentasi referensi API secara otomatis berdasarkan Spesifikasi OpenAPI Anda.
Pendaftaran 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
Analisis Mengonfigurasi Google Analytics dan pelacakan analisis kustom.
Penyesuaian lanjutan Lakukan penyesuaian portal lanjutan, termasuk:
  • Sesuaikan domain Anda
  • Menambahkan kolom pendaftaran kustom
  • Perluas portal Anda menggunakan skrip
  • Mengonfigurasi email Anda

Cara Apigee menangani keamanan di portal terintegrasi

Tabel berikut menjelaskan cara Apigee menangani keamanan melalui fitur bawaan dalam portal terintegrasi.

Fitur Alamat
Memerlukan HTTPS dan Transport Layer Security (TLS) Menerapkan komunikasi terenkripsi
Mencakup pendaftaran domain apigee.io dengan Daftar Suffix Publik Melarang "supercookies" disetel pada subdomain apigee.io
Memerlukan:
  • Sanitasi input formulir
  • Injeksi JavaScript di seluruh situs dibatasi untuk administrator
Melindungi dari serangan HTML, SQL, atau injeksi backend
Menyertakan x-content-type-options: nosniff header XSS Mencegah browser mencoba menebak jenis MIME
Menyertakan x-frame-options: deny header XSS Melarang penyematan konten portal ke dalam iFrame
Menyertakan x-xss-protection: 1 header XSS Melarang pemuatan halaman saat mendeteksi serangan pembuatan skrip lintas situs (XSS) yang direfleksikan
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 perlu, portal developer mengirimkan permintaan REST HTTP atau HTTPS untuk mengambil informasi dari atau mengirim informasi ke Apigee. Misalnya, saat pengguna portal mendaftarkan aplikasi baru di portal, portal itu akan mengirimkan permintaan ke Apigee untuk menyimpan informasi tentang aplikasi.

Bagian berikut memberikan detail selengkapnya.

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, termasuk nama aplikasi dan produk API yang terkait dengan aplikasi tersebut. 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; tidak disimpan di portal. Jika pengguna portal menggunakan portal untuk melihat informasi tentang aplikasi, misalnya melalui halaman Aplikasi Saya, portal tersebut akan membuat permintaan ke Apigee dengan kunci API untuk mengakses informasi tersebut.

Demikian pula, saat pengguna portal menambahkan, menghapus, atau memodifikasi aplikasi, portal mengirimkan modifikasi 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. Sebagai contoh, seorang administrator dapat:

  • Menambahkan, menghapus, atau mengubah aplikasi developer
  • Menyetujui atau mencabut kunci API untuk aplikasi developer

Untuk informasi selengkapnya, lihat Mengontrol akses ke API dengan mendaftarkan aplikasi.

Tempat informasi akun developer aplikasi disimpan

Informasi akun developer disimpan di Apigee, sebagai berikut:

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 terautentikasi, administrator, lainnya)
  • Izin berbasis peran
  • Tim yang merupakan anggota dari pengguna portal (jika Anda telah mendaftar dalam rilis fitur tim beta)

Alamat email adalah kunci utama yang digunakan oleh Apigee untuk mengidentifikasi developer dan setiap alamat email harus unik. Dari kunci utama, Apigee menghasilkan ID developer yang unik untuk setiap organisasi tempat developer berada.

Untuk mengetahui informasi selengkapnya, lihat Mendaftarkan developer aplikasi.

Tempat informasi tim developer disimpan (beta)

Saat tim developer dibuat di portal oleh pengguna portal, informasi tim developer akan disimpan di Apigee, 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 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 (beta) dan Mengelola tim developer.

Tentang portal contoh

Saat Anda membuat portal baru, serangkaian halaman awal akan disediakan 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 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 bahan sudut, seperti yang dijelaskan dalam Menambahkan komponen material sudut.
Mulai Contoh halaman konten. Pelajari cara mengedit halaman ini dan menambahkannya ke navigasi atas dengan mengikuti tutorial.
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; konten tidak ditampilkan 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: Konten halaman ini dibuat secara otomatis berdasarkan aplikasi pengguna yang terdaftar. Anda tidak dapat mengedit konten halaman secara langsung; konten 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 Login. Lihat Cara pengguna portal berinteraksi dengan portal Anda.

Catatan: Halaman Login akan otomatis disertakan di portal Anda. 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 muncul dalam daftar halaman. "
Persyaratan dan Ketentuan Contoh halaman persyaratan dan ketentuan.