Topik ini menjelaskan cara membuat, melihat, mengedit, dan menghapus koneksi serta destinasi API untuk mengintegrasikan aplikasi lain secara cepat.
Prasyarat
Informasi latar belakang
Anda dapat menggunakan destinasi API untuk memanggil API HTTP atau HTTPS dari sistem SaaS pihak ketiga atau sistem yang Anda kelola sendiri. Metode integrasi low-code ini tidak memerlukan arsitektur tambahan untuk pemanggilan API. Dengan destinasi API, Anda dapat dengan mudah membangun dan menghubungkan aplikasi SaaS serta menghilangkan silodata. Selain itu, beberapa API dapat berbagi satu koneksi, sehingga menyediakan autentikasi yang praktis dan bersifat plug-and-play.
Pemanggilan API pada sistem SaaS pihak ketiga atau sistem yang Anda kelola sendiri melibatkan dua komponen EventBridge: destinasi API dan koneksi.
Destinasi API mendefinisikan metadata suatu API. Saat membuat aturan event, Anda dapat mereferensikan destinasi API yang berbeda untuk mengakses sistem SaaS pihak ketiga atau sistem yang Anda kelola sendiri yang berbeda. Beberapa aturan juga dapat mereferensikan destinasi API yang sama. Jika beberapa aturan mengirimkan event ke API target yang sama, Anda harus mengubah setiap aturan satu per satu jika ada parameter yang perlu diubah. Namun, jika Anda mendefinisikan API target tersebut sebagai destinasi API, Anda hanya perlu mengubah konfigurasi destinasi API tersebut. Semua aturan event yang mereferensikan destinasi API ini akan diperbarui secara otomatis.

Koneksi membangun tautan antara layanan eksternal dan destinasi API. Koneksi mencakup konfigurasi jaringan dan konfigurasi autentikasi. Konfigurasi jaringan menentukan apakah layanan eksternal terhubung ke destinasi API melalui jaringan publik atau jaringan pribadi. Untuk konfigurasi autentikasi, EventBridge mendukung tiga metode umum: autentikasi dasar (basic authentication), OAuth, dan kunci API (api key).
-
basic authentication: Menggunakan username dan password untuk mengakses sumber daya data. Username dan password dikodekan dalam Base64, diberi awalan Basic, lalu dikirim ke layanan target. Jika layanan tersebut berhasil mendekode kredensial dan autentikasi berhasil, layanan tersebut akan merespons permintaan EventBridge. Jika tidak, permintaan ditolak.
-
OAuth: Metode otorisasi yang aman dan andal. OAuth memiliki empat jenis grant: authorization code, implicit, password, dan client credential. Dalam skenario berbasis event, tipe grant client credential umumnya digunakan. Dalam mode ini, Anda harus mengonfigurasi informasi yang diperlukan untuk mendapatkan kredensial klien di EventBridge, termasuk titik akhir otorisasi (authorization endpoint), ID klien (client ID), dan rahasia klien (client secret). EventBridge mendukung metode GET dan POST untuk mengambil kredensial klien.
-
api key: Metode autentikasi yang sederhana. Anda dapat menentukan nama dan nilai kunci kustom untuk akses API. EventBridge mengirimkan kredensial ini dalam Header HTTP ke server untuk autentikasi.

Koneksi
Buat koneksi
Saat membuat destinasi API, Anda mengaitkannya dengan sebuah koneksi. Koneksi tersebut menentukan metode autentikasi dan pengaturan jaringan untuk pemanggilan API.
-
Masuk ke EventBridge console. Di panel navigasi sebelah kiri, pilih Integrations > API Destinations.
-
Di bilah menu atas, pilih wilayah, lalu klik tab Connection Configuration.
-
Di tab Connection, klik Create. Di panel Create Connection, atur parameter berikut lalu klik OK.
Parameter
Deskripsi
Contoh
Name
Nama koneksi.
testName
Description
Deskripsi koneksi.
test
Authentication
Metode autentikasi untuk koneksi. Nilai yang valid:
-
Basic
-
OAuth Client Credential
-
API Key
Basic
Username
Username untuk otorisasi. Parameter ini hanya diperlukan jika Authentication diatur ke Basic.
Admin
Password
Password untuk otorisasi. Parameter ini hanya diperlukan jika Authentication diatur ke Basic.
******
Endpoint
URL titik akhir otorisasi untuk mendapatkan
access_token. Parameter ini hanya diperlukan jika Authentication diatur ke OAuth Client Credential.https://postman-echo.com/oauth1
HTTP Method
Metode permintaan yang digunakan untuk mendapatkan
access_token. Parameter ini hanya diperlukan jika Authentication diatur ke OAuth Client Credential.POST
Client ID
ID klien yang Anda otorisasi untuk mendapatkan
access_token. Parameter ini hanya diperlukan jika Authentication diatur ke OAuth Client Credential.Admin
Client Secret
Rahasia dari ID klien yang diotorisasi. Parameter ini hanya diperlukan jika Authentication diatur ke OAuth Client Credential.
******
OAuth HTTP Parameter
Header permintaan, isi badan (body), dan parameter kueri yang ditambahkan ke permintaan untuk mendapatkan
access_token. Parameter ini hanya diperlukan jika Authentication diatur ke OAuth Client Credential.Parameter:Header key:name Value:eventbridgeAPI Key Name
Nama kunci untuk otorisasi. Parameter ini hanya diperlukan jika Authentication diatur ke API Key.
Admin
API Key Value
Nilai kunci yang diotorisasi. Parameter ini hanya diperlukan jika Authentication diatur ke API Key.
******
Network
Jenis koneksi jaringan antara destinasi API dan aplikasi pihak ketiga. Nilai default adalah Internet.
Public Network
-
Operasi lainnya
Setelah membuat koneksi, Anda dapat melihat, mengedit, dan menghapusnya di konsol.
-
Untuk melihat detail: Di kolom Actions koneksi, klik Details untuk melihat informasi dasar, konfigurasi autentikasi, konfigurasi jaringan, dan destinasi API yang terikat.
-
Untuk mengedit koneksi: Di kolom Actions koneksi, klik Edit untuk mengubah deskripsi koneksi.
-
Untuk menghapus koneksi: Di kolom Actions koneksi, klik Delete. Tinjau informasi di kotak dialog Show Tooltip, lalu klik OK untuk menghapus koneksi.
Destinasi API
Buat destinasi API
-
Masuk ke EventBridge console. Di panel navigasi sebelah kiri, pilih Integrations > API Destinations.
-
Di bilah menu atas, pilih wilayah, lalu klik tab API Destinations.
-
Di tab API Destination, klik Create. Di panel Create API Destination, atur parameter berikut lalu klik OK.
-
Di bagian Basic Information, atur Method ke Custom, lalu masukkan nama dan deskripsi untuk destinasi API.
-
Di bagian API Configuration, atur URL ke alamat API dari sumber daya server yang ingin Anda akses. Atur HTTP Method ke metode permintaan untuk mengakses URL tersebut.
-
Di bagian Connection, pilih Create Connection atau Select Existing Connection, lalu klik OK.
-
Create Connection: Konfigurasikan nama, deskripsi, konfigurasi autentikasi, dan konfigurasi jaringan untuk koneksi seperti yang dijelaskan di Buat koneksi.
-
Select Existing Connection: Pilih koneksi yang telah dikonfigurasi sebelumnya dari daftar drop-down.
-
-
Pilih destinasi API sebagai target event
-
Masuk ke EventBridge console. Di panel navigasi sebelah kiri, klik Event Buses.
-
Di bilah menu atas, pilih wilayah. Di halaman Event Buses, klik nama event bus target.
-
Di panel navigasi sebelah kiri, klik Event Rules, lalu klik Create Rule.
-
Di panel Create Rule, lengkapi konfigurasi berikut lalu klik Create.
-
Konfigurasikan informasi dasar dan pola event untuk aturan tersebut. Untuk informasi selengkapnya, lihat Buat aturan event.
-
Di tab Configure Targets, pilih Triggered by API Operation dari daftar drop-down Service Type.
-
Untuk membuat destinasi API kustom: Di bagian Basic Information, pilih Custom sebagai metode pembuatan. Lalu, lengkapi konfigurasi dengan mengikuti langkah-langkah di bagian Buat destinasi API.
-
Untuk menggunakan destinasi API yang sudah ada: Di bagian Basic Information, pilih Use Existing API Destination sebagai metode pembuatan, lalu pilih destinasi API yang telah dikonfigurasi sebelumnya dari daftar drop-down.
-
-
Operasi lainnya
Setelah membuat destinasi API, Anda dapat melihat, mengedit, dan menghapusnya di konsol.
-
Untuk melihat detail: Di kolom Actions destinasi API, klik Details untuk melihat informasi dasar, konfigurasi API, dan koneksi.
-
Untuk mengedit destinasi API: Di kolom Actions destinasi API, klik Edit untuk mengubah deskripsi dan konfigurasi API-nya.
-
Untuk menghapus destinasi API: Di kolom Actions destinasi API, klik Delete. Tinjau informasi di kotak dialog Show Tooltip, lalu klik OK untuk menghapus destinasi API.