Tutorial ini menunjukkan kepada Anda cara menggunakan integrasi dan konektor untuk membuat contoh integrasi yang memicu publikasi pesan Cloud Pub/Sub. Tutorial ini mengasumsikan bahwa Anda memiliki pengetahuan tentang Integrasi Apigee.
Dalam contoh ini, memanggil endpoint API akan memicu publikasi pesan ke topik Cloud Pub/Sub. Langkah-langkah di bawah ini menjelaskan cara mengonfigurasi pemicu API dan koneksi Pub/Sub yang diperlukan untuk menjalankan integrasi yang berhasil.
Sebelum memulai
Sebelum memulai tutorial ini, konfirmasi kredensial login Google Cloud dan detail organisasi Anda. Ini diperlukan untuk mengakses UI konektor. Kredensial Apigee Anda diperlukan untuk mengakses tugas konektor dalam desainer integrasi Apigee. Langkah-langkah prasyarat tambahan dijelaskan di bawah ini:
-
Sebelum membuat koneksi untuk pertama kalinya, selesaikan langkah-langkah berikut:
- Buat instance Apigee baru. Instance Apigee baru dapat
disediakan dengan UI Penyediaan.
Untuk mengetahui daftar region yang mendukung konektor, lihat Wilayah konektor yang didukung.
- Konfirmasi bahwa fitur Integrasi dan konektor Apigee berhak untuk langganan Apigee Anda.
- Aktifkan fitur Integrasi dan konektor Apigee menggunakan perintah berikut:
curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H \ "content-type:application/json" \ "https://apigee.googleapis.com/v1/organizations/PROJECT_ID:setAddons" -XPOST \ -d '{"addonsConfig": {"integrationConfig": {"enabled": true}, "connectorsPlatformConfig": {"enabled": true}}}'
- Jika Anda tidak memiliki akun layanan, buat akun layanan.
Akun layanan adalah jenis Akun Google khusus yang dimaksudkan untuk mewakili akun yang perlu mengautentikasi dan diberi otorisasi untuk mengakses data di Google API. Jika tidak memiliki akun layanan, Anda harus membuat akun layanan. Untuk selengkapnya informasi, lihat Membuat akun layanan.
- Buat instance Apigee baru. Instance Apigee baru dapat
disediakan dengan UI Penyediaan.
- Sebelum membuat koneksi Pub/Sub untuk digunakan dalam integrasi Anda, lakukan hal berikut:
- Membuat topik Pub/Sub dan tambahkan langganan, seperti yang dijelaskan di Panduan memulai Cloud Pub/Sub: Menggunakan konsol.
- Berikan izin
untuk memublikasikan ke topik Pub/Sub Anda. Misalnya, Anda dapat menggunakan peran
roles/pubsub.publisher
untuk memublikasikan ke topik. Untuk mengetahui informasi selengkapnya tentang peran Pub/Sub, lihat Kontrol Akses. - Buat kunci untuk akun layanan. File kunci JSON digunakan dalam langkah berikutnya untuk mengonfigurasi koneksi Pub/Sub.
- Di Konsol Cloud, buka Integration Connectors > Halaman Koneksi lalu pilih atau buat project Google Cloud.
- Klik + CREATE NEW untuk membuka halaman Create Connection.
-
Konfigurasi koneksi:
- Di bagian Create Connection, selesaikan langkah-langkah berikut:
- Connector: Pilih Cloud Pub/Sub dari menu drop-down Konektor yang tersedia.
- Versi konektor: Pilih versi Konektor dari menu drop-down versi yang tersedia.
- Di kolom Connection Name, masukkan nama untuk instance Koneksi.
Nama koneksi harus memenuhi kriteria berikut:
- Nama koneksi dapat menggunakan huruf, angka, atau tanda hubung.
- Huruf harus huruf kecil.
- Nama koneksi harus dimulai dengan huruf dan diakhiri dengan huruf atau angka.
- Nama koneksi tidak boleh lebih dari 63 karakter.
- Jika perlu, masukkan Description untuk instance koneksi.
- Akun Layanan: Pilih akun layanan yang memiliki peran yang diperlukan.
- Project ID: ID project Google Cloud tempat instance Pubsub berada.
- Topic ID: Nama topik tempat pesan akan dipublikasikan.
- Anda juga dapat mengklik + TAMBAHKAN LABEL untuk menambahkan label ke Koneksi dalam bentuk pasangan kunci/nilai.
- Klik NEXT.
- Lokasi: Pilih lokasi untuk koneksi.
- Pilih lokasi tempat Apigee tersedia dari menu drop-down Region.
Wilayah yang didukung untuk konektor meliputi:
Untuk mengetahui daftar semua wilayah yang didukung, lihat Lokasi.
- Klik NEXT.
- Pilih lokasi tempat Apigee tersedia dari menu drop-down Region.
-
Autentikasi: Jenis autentikasi yang didukung oleh koneksi Cloud Pub/Sub:
- AUTH_TYPE_UNSPECIFIED
Masukkan detail berdasarkan autentikasi yang ingin Anda gunakan.
- AUTH_TYPE_UNSPECIFIED
- Klik NEXT.
- Peninjauan: Tinjau detail koneksi dan autentikasi Anda.
- Di bagian Create Connection, selesaikan langkah-langkah berikut:
- Klik Create.
- Buka UI Apigee dan login ke project yang sama tempat koneksi Anda dibuat.
- Klik Develop > Integrasi.
- Klik BUAT BARU.
- Masukkan nama dan deskripsi dalam dialog Create Integration.
- Klik Create untuk membuka desainer integrasi.
- Pada desainer integrasi, klik + Tambahkan tugas/pemicu untuk melihat tugas dan memicu dialog pemilihan.
- Klik Pemicu untuk melihat pemicu yang tersedia.
- Tarik elemen API trigger ke desainer.
- Buka UI Apigee dan login.
- Pilih organisasi Anda menggunakan menu drop-down di sudut kiri atas UI.
- Klik Develop > Integrasi.
- Telusuri atau pilih integrasi yang ingin diedit dari daftar Integrations dan klik untuk membuka desainer integrasi.
- Klik +Tambahkan tugas/pemicu > Tasks untuk melihat daftar tugas yang tersedia.
- Tarik elemen tugas Konektor ke desainer integrasi.
- Klik elemen tugas Konektor pada desainer untuk melihat tugas Konektor panel konfigurasi.
- Atau, klik untuk mengedit nama tugas. Hal ini memungkinkan Anda mengubah nama tugas dari Konektor umum menjadi nama yang bermakna untuk integrasi Anda.
- Pada tab Configuration di bagian Configuration, klik tombol Configure task untuk membuka panel Configure Connector task.
- Di kolom Connection, pilih koneksi Pub/Sub yang Anda buat di langkah sebelumnya dari daftar koneksi yang tersedia.
- Setelah koneksi dipilih, kolom Jenis akan muncul. Untuk contoh ini, pilih Actions, lalu publishMessage dari
daftar tindakan yang tersedia.
- Entity dapat dianggap sebagai objek, atau kumpulan properti, dalam aplikasi yang terhubung atau layanan, yang dapat diekspos ke integrasi melalui antarmuka Konektor. Koneksi Pub/Sub tidak mengekspos entity apa pun.
- Action adalah fungsi class pertama yang tersedia untuk integrasi melalui antarmuka Connector. Fungsi ditetapkan dalam aplikasi atau layanan yang terhubung dan menetapkan perubahan atau serangkaian perubahan yang dapat dilakukan untuk suatu entitas atau beberapa entitas. Koneksi Pub/Sub memiliki satu Action yang tersedia
- Klik Done untuk menyelesaikan konfigurasi koneksi dan menutup panel.
- Panel konfigurasi tugas Connectors untuk koneksi Pub/Sub juga menampilkan variabel Task Input
dan variabel Output Tugas yang dihasilkan secara otomatis oleh Entity dan Operasi atau Tindakan
yang dipilih di langkah sebelumnya
untuk digunakan dalam koneksi. Variabel-variabel ini
dapat diakses sebagai input untuk tugas atau kondisional berikutnya yang dikonfigurasi dalam integrasi saat ini.
Untuk mengonfigurasi Input Tugas:
- Klik pil variabel Konfigurasi input konektor untuk membuka panel Konfigurasi Variabel.
- Di kolom Nilai Default, masukkan teks berikut:
{"message": "test message from integration platform"}
. - Centang kotak Use as an input to integration.
- Klik Simpan.
Anda dapat mengonfigurasi berbagai strategi percobaan ulang untuk menangani error dalam tugas. Strategi percobaan ulang memungkinkan Anda untuk menentukan cara menjalankan ulang tugas jika terjadi {i>error<i}. Untuk informasi selengkapnya, lihat Strategi penanganan error.
- Tambahkan koneksi edge dari elemen pemicu API ke elemen Konektor dengan mengarahkan kursor ke titik kontrol pada elemen pemicu API, lalu mengklik dan menarik garis ke titik kontrol pada elemen tugas Konektor. Titik kontrol dan garis tepi akan menjadi kuning. Tepi menunjukkan alur kontrol dari pemicu API ke tugas Konektor.
- Klik tombol Publikasikan di toolbar desainer integrasi.
- Klik Uji untuk memicu dan menjalankan integrasi. Tindakan ini akan membuka jendela Test Integration, yang menampilkan variabel input (pesan) yang Anda tetapkan di langkah sebelumnya. Jika diinginkan, variabel input dapat diubah di sini.
- Klik Test integration.
- Setelah berhasil, jendela Integrasi Pengujian akan menampilkan pesan berhasil, beserta nilai integrasi payload variabel input dan output.
- Klik Close untuk keluar dari jendela Test Integration.
- Buka halaman Pub/Sub. Pilih topik Pub/Sub Anda, lalu klik View messages untuk mengonfirmasi penerimaan pesan yang dikirim oleh integrasi.
- Periksa log Integrasi Apigee untuk melihat status integrasi tertentu. Untuk melihat log:
- Klik Logs di toolbar desainer integrasi.
- Di halaman Execution Logs, Anda dapat melihat detail tentang setiap upaya untuk menjalankan integrasi.
Setiap entri menyertakan detail upaya eksekusi, termasuk:
- Nama integrasi
- ID eksekusi
- Status
- Waktu mulai
- Durasi
- ID Integrasi
- ID Pemicu
- Klik panah luaskan (>) di samping integrasi yang dijalankan untuk melihat daftar tugas dan variabel dalam integrasi, bersama dengan status tugas dan {i>payload<i} variabel.
- Lihat daftar konektor yang didukung di Apigee.
- Pelajari cara membuat dan mengelola koneksi.
Aktifkan layanan yang diperlukan
Konektor mengharuskan Anda mengaktifkan layanan Google berikut:
Nama | Judul |
apigee.googleapis.com |
API Apigee |
secretmanager.googleapis.com |
API Secret Manager |
connectors.googleapis.com |
API Konektor |
Jika layanan ini belum diaktifkan untuk project Anda sebelumnya, Anda akan diminta untuk mengaktifkannya saat membuat koneksi di halaman {i>Create Connection<i}.
Membuat koneksi Pub/Sub
Untuk mengonfigurasi Koneksi:
Membuat integrasi baru
Untuk membuat integrasi baru, lakukan langkah-langkah berikut:
Menambahkan pemicu API
{i>Trigger<i} diperlukan untuk memulai urutan tugas yang membentuk integrasi. Semua yang tersedia dapat digunakan untuk memulai integrasi. Tutorial ini menggunakan pemicu API untuk memanggil secara langsung menjalankan integrasinya.
Untuk menambahkan pemicu API ke integrasi baru atau yang sudah ada, ikuti langkah-langkah di bawah:
Tidak ada konfigurasi lebih lanjut yang diperlukan untuk pemicu ini. Untuk melihat ID pemicu API,
klik elemen API trigger di desainer integrasi. Panel konfigurasi menampilkan ID Pemicu, yang merupakan
ID yang dibuat mesin dalam format api_trigger/TRIGGER_NAME
.
Menambahkan dan mengonfigurasi tugas
Tugas adalah serangkaian langkah yang dapat dijalankan yang dapat mengambil variabel sebagai input dan menghasilkan variabel sebagai output. Seperti halnya pemicu, setiap tugas yang tersedia dapat digunakan dalam integrasi.
Tutorial ini menggunakan tugas Konektor. Konfigurasi detail tugas dijelaskan dalam langkah-langkah di bawah ini.
Mengonfigurasi tugas Membuat Konektor dengan koneksi Pub/Sub
Untuk mengonfigurasi tugas Konektor di Integrasi Apigee untuk menggunakan koneksi Pub/Sub:
Menguji integrasi
Untuk menguji integrasi baru:
Untuk memverifikasi keberhasilan integrasi Anda:
Selamat! Anda baru saja membuat dan berhasil menguji koneksi Pub/Sub di Integrasi Apigee.