Hub API Apigee
Konektor hub API Apigee memungkinkan Anda mengelola, menemukan, dan mengatur API dalam portofolio organisasi Anda.
Versi yang didukung
Konektor ini mendukung hub API Apigee versi v1.
Sebelum memulai
-
Di project Google Cloud Anda, lakukan tugas berikut:
- Pastikan konektivitas jaringan telah disiapkan. Untuk mengetahui informasi tentang pola jaringan, lihat Konektivitas jaringan.
- Berikan peran IAM roles/connectors.admin kepada pengguna yang mengonfigurasi konektor.
- Aktifkan layanan berikut:
secretmanager.googleapis.com(Secret Manager API)connectors.googleapis.com(Connectors API)
Untuk memahami cara mengaktifkan layanan, lihat Mengaktifkan layanan. Jika layanan atau izin ini belum diaktifkan untuk project Anda sebelumnya, Anda akan diminta untuk mengaktifkannya saat mengonfigurasi konektor.
- Jika Anda menggunakan autentikasi akun layanan, bukan autentikasi OAuth 2.0, pastikan izin yang sesuai diberikan ke akun layanan. Untuk mengetahui informasi selengkapnya, lihat Peran IAM bawaan.
Membuat koneksi hub API Apigee
Koneksi khusus untuk sumber data. Artinya, jika Anda memiliki banyak sumber data, Anda harus membuat koneksi terpisah untuk setiap sumber data. Untuk membuat koneksi, lakukan hal berikut:
- Di Konsol Cloud, buka halaman Integration Connectors > Connections lalu pilih atau buat project Google Cloud.
- Klik + Buat baru untuk membuka halaman Buat Koneksi.
- Di bagian Lokasi, pilih lokasi dari daftar Wilayah, lalu klik Berikutnya.
Untuk mengetahui daftar semua region yang didukung, lihat Lokasi.
- Di bagian Detail Koneksi, lakukan hal berikut:
- Pilih Apigee API hub dari daftar Connector.
- Pilih versi konektor dari daftar Connector version.
- Di kolom Nama Koneksi, masukkan nama untuk instance koneksi. Nama koneksi dapat berisi huruf kecil, angka, atau tanda hubung. Nama harus diawali dengan huruf dan diakhiri dengan huruf atau angka, serta tidak boleh lebih dari 49 karakter.
- Secara opsional, masukkan Deskripsi untuk instance koneksi.
- Secara opsional, aktifkan Cloud Logging,
lalu pilih level log. Secara default, level log ditetapkan ke
Error. - Akun Layanan: Pilih akun layanan yang memiliki peran yang diperlukan.
- (Opsional) Konfigurasi setelan node Koneksi.
- Jumlah minimum node: Masukkan jumlah minimum node koneksi.
- Maximum number of nodes: Masukkan jumlah maksimum node koneksi.
- Klik Berikutnya.
Node adalah unit (atau replika) koneksi yang memproses transaksi. Jumlah node yang diperlukan untuk memproses lebih banyak transaksi untuk koneksi akan bertambah dan sebaliknya, jumlah node yang diperlukan untuk memproses lebih sedikit transaksi akan berkurang. Untuk memahami pengaruh node terhadap harga konektor, lihat Harga untuk node koneksi. Jika Anda tidak memasukkan nilai apa pun, secara default node minimum ditetapkan ke 2 (untuk ketersediaan yang lebih baik) dan node maksimum ditetapkan ke 50.
- Di bagian Destinations, masukkan detail host jarak jauh (sistem backend) yang ingin Anda hubungkan.
- Di kolom Jenis Tujuan, pilih tujuan.
- Di kolom Alamat host, tentukan nama host atau alamat IP tujuan.
Jika perlu, untuk memasukkan tujuan tambahan, klik +TAMBAHKAN TUJUAN.
- Klik Berikutnya.
-
Di bagian Authentication, masukkan detail autentikasi.
- Pilih Jenis autentikasi dan masukkan detail yang relevan.
Jenis autentikasi berikut didukung oleh koneksi hub API Apigee:
- OAuth 2.0 - Kode otorisasi
- Autentikasi akun layanan
- Klik Berikutnya.
Untuk memahami cara mengonfigurasi jenis autentikasi ini, lihat Mengonfigurasi autentikasi.
- Pilih Jenis autentikasi dan masukkan detail yang relevan.
- Tinjau detail koneksi dan autentikasi Anda, lalu klik Buat.
Mengonfigurasi autentikasi
Masukkan detail berdasarkan autentikasi yang ingin Anda gunakan.
- OAuth 2.0 - Kode otorisasi: Pilih opsi ini untuk mengautentikasi menggunakan alur login pengguna berbasis web. Tentukan detail berikut:
- Client ID: Client ID yang diperlukan untuk terhubung ke layanan hub Apigee API backend Anda.
- Cakupan: Daftar cakupan yang diinginkan yang dipisahkan koma. Untuk melihat semua cakupan OAuth 2.0 yang didukung untuk layanan Google yang Anda perlukan, lihat bagian yang relevan di halaman Cakupan OAuth 2.0 untuk Google API.
- Client secret: Pilih Secret Manager secret. Anda harus membuat Secret Manager secret sebelum mengonfigurasi otorisasi ini.
- Versi secret: Versi secret Secret Manager untuk secret klien.
-
Autentikasi akun layanan: Pilih opsi ini untuk mengautentikasi menggunakan akun layanan yang Anda berikan pada langkah sebelumnya saat mengonfigurasi koneksi ini. Pastikan Anda telah memberikan peran dan izin IAM yang relevan kepada akun layanan yang diperlukan untuk autentikasi.
- Cakupan: Pilih cakupan OAuth 2.0 yang diperlukan dari drop-down. Untuk mengetahui informasi selengkapnya, lihat Cakupan akses.
Untuk jenis autentikasi Authorization code, setelah membuat koneksi, Anda harus mengizinkan koneksi.
Memberi otorisasi koneksi
Jika Anda menggunakan kode otorisasi OAuth 2.0 untuk mengautentikasi koneksi, selesaikan tugas berikut setelah Anda membuat koneksi.
- Di halaman Koneksi,
temukan koneksi yang baru dibuat.
Perhatikan bahwa Status untuk konektor baru akan menjadi Otorisasi diperlukan.
- Klik Otorisasi diperlukan.
Tindakan ini akan menampilkan panel Edit otorisasi.
- Salin nilai Redirect URI ke aplikasi eksternal Anda.
- Verifikasi detail otorisasi.
- Klik Otorisasi.
Jika otorisasi berhasil, status koneksi akan disetel ke Aktif di halaman Koneksi.
Otorisasi ulang untuk kode otorisasi
Jika Anda menggunakan jenis autentikasi Authorization code dan telah melakukan perubahan konfigurasi di hub Apigee API,
Anda harus mengotorisasi ulang koneksi hub Apigee API. Untuk memberikan kembali otorisasi koneksi, lakukan langkah-langkah berikut:
- Klik koneksi yang diperlukan di halaman Koneksi.
Tindakan ini akan membuka halaman detail koneksi.
- Klik Edit untuk mengedit detail koneksi.
- Verifikasi detail OAuth 2.0 - Authorization code di bagian Authentication.
Jika diperlukan, lakukan perubahan yang diperlukan.
- Klik Simpan. Tindakan ini akan mengarahkan Anda ke halaman detail koneksi.
- Klik Edit otorisasi di bagian Autentikasi. Tindakan ini akan menampilkan panel Authorize.
- Klik Otorisasi.
Jika otorisasi berhasil, status koneksi akan disetel ke Aktif di halaman Koneksi.
Batasan sistem
Konektor hub API Apigee dapat memproses maksimum 20 transaksi per detik, per node, dan membatasi transaksi apa pun yang melebihi batas ini. Secara default, Integration Connectors mengalokasikan 2 node (untuk ketersediaan yang lebih baik) untuk koneksi.
Untuk mengetahui informasi tentang batas yang berlaku untuk Integration Connectors, lihat Batas.
Menggunakan koneksi hub API Apigee dalam integrasi
Setelah Anda membuat koneksi, koneksi tersebut akan tersedia di Integrasi Aplikasi. Anda dapat menggunakan koneksi dalam integrasi melalui tugas Konektor.
Tindakan
Konektor ini menyediakan lapisan abstraksi untuk objek layanan backend yang terhubung. Anda hanya dapat mengakses objek backend
melalui abstraksi ini. Abstraksi ini ditampilkan kepada Anda sebagai tindakan. Action adalah fungsi
kelas utama yang tersedia untuk integrasi
melalui antarmuka konektor. Tindakan memungkinkan Anda membuat
perubahan pada satu atau beberapa entitas, dan bervariasi dari konektor
ke konektor. Namun, ada kemungkinan
konektor tidak mendukung tindakan apa pun,
dalam hal ini daftar Actions akan kosong.
Masalah umum
Konektor hub API Apigee memiliki batas konfigurasi. Resource yang dapat ditelusuri dibatasi hingga 2,5 MB, dan file spesifikasi API memiliki batas 10 MB. Untuk mengetahui informasi selengkapnya, lihat Batas pada hub API Apigee.
Mendapatkan bantuan dari komunitas Google Cloud
Anda dapat memposting pertanyaan dan mendiskusikan konektor ini di komunitas Google Cloud di Forum Cloud.
Langkah berikutnya
- Pahami cara menangguhkan dan melanjutkan koneksi.
- Pahami cara memantau penggunaan konektor.
- Pahami cara melihat log konektor.