Destinasi API mengarahkan event dari EventBridge ke titik akhir HTTP mana pun—baik platform SaaS pihak ketiga maupun layanan Anda sendiri—dengan pendekatan low-code tanpa memerlukan arsitektur tambahan. Setiap destinasi API dipasangkan dengan koneksi yang menyimpan kredensial autentikasi. Konfigurasikan kredensial sekali dalam koneksi, lalu gunakan ulang koneksi tersebut di beberapa destinasi API dan aturan event.
Saat Anda memperbarui destinasi API, setiap aturan event yang mereferensikannya akan secara otomatis menerapkan perubahan tersebut—tanpa perlu mengedit aturan satu per satu.
Cara kerja destinasi API dan koneksi
Destinasi API menentukan *ke mana* event dikirim: URL titik akhir HTTP dan metode permintaan. Koneksi menentukan *bagaimana* melakukan koneksi dan autentikasi: konfigurasi jaringan serta jenis dan parameter kredensial.
Pemisahan ini memberikan dua keuntungan:
Autentikasi yang dapat digunakan ulang. Satu koneksi dapat melayani beberapa destinasi API yang menggunakan metode autentikasi yang sama. Jika destinasi API memerlukan autentikasi berbeda, buat koneksi terpisah.
Manajemen titik akhir terpusat. Perubahan pada destinasi API akan diterapkan ke semua aturan event yang mereferensikannya.
Metode autentikasi
Koneksi mendukung tiga metode autentikasi:
| Metode | Cara kerja | Kapan digunakan |
|---|---|---|
| Basic | EventBridge mengenkripsi username dan password dalam format Base64, menambahkan awalan Basic, lalu mengirim nilai tersebut dalam Header HTTP Authorization. Layanan tujuan kemudian mendekode dan memverifikasi kredensial sebelum merespons. | API target menggunakan autentikasi HTTP Basic. |
| OAuth Client Credential | EventBridge meminta access_token dari titik akhir OAuth menggunakan client ID dan client secret, lalu menyertakan token tersebut dalam permintaan selanjutnya. OAuth mendukung empat jenis grant: authorization code, implicit authorization code, password, dan client credential. Dalam skenario berbasis event, client credentials umumnya digunakan. Metode GET dan POST didukung untuk permintaan token. | API target menggunakan alur OAuth 2.0 client credentials. |
| API Key | EventBridge mengirim pasangan kunci-nilai kustom dalam Header HTTP untuk setiap permintaan. | API target melakukan autentikasi dengan kunci API statis. |
Prasyarat
Sebelum memulai, pastikan Anda telah:
Buat koneksi
Koneksi menyimpan kredensial autentikasi untuk satu atau beberapa destinasi API. Buat koneksi sebelum atau saat membuat destinasi API.
Masuk ke Konsol EventBridge. Di panel navigasi kiri, pilih Integration Center > API Destination.
Di bilah navigasi atas, pilih wilayah tempat Anda ingin membuat koneksi.
Klik tab Connection Configuration, lalu klik Create.
Di panel Create Connection, konfigurasikan parameter berikut dan klik OK.
| Parameter | Deskripsi | Contoh |
|---|---|---|
| Name | Nama koneksi. | testName |
| Description | Deskripsi singkat tentang koneksi. | test |
| Authentication | Metode autentikasi. Nilai yang valid: Basic, OAuth Client Credential, API Key. | Basic |
| Username | Username untuk autentikasi Basic. Wajib diisi jika Authentication diatur ke Basic. | Admin |
| Password | Password untuk autentikasi Basic. Wajib diisi jika Authentication diatur ke Basic. | ****** |
| Endpoint | URL yang digunakan untuk memperoleh access_token. Wajib diisi jika Authentication diatur ke OAuth Client Credential. | https://postman-echo.com/oauth1 |
| HTTP Method | Metode permintaan yang digunakan untuk memperoleh access_token. Wajib diisi jika Authentication diatur ke OAuth Client Credential. | POST |
| Client ID | Client ID yang digunakan untuk memperoleh access_token. Wajib diisi jika Authentication diatur ke OAuth Client Credential. | Admin |
| ClientSecret | Client secret. Wajib diisi jika Authentication diatur ke OAuth Client Credential. | ****** |
| OAuth HTTP Parameter | Header tambahan, parameter body, atau parameter kueri yang disertakan dalam permintaan access_token. Wajib diisi jika Authentication diatur ke OAuth Client Credential. | Parameter: Header, key: name, Value: eventbridge |
| ApiKeyName | Nama kunci untuk autentikasi API Key. Wajib diisi jika Authentication diatur ke API Key. | Admin |
| ApiKeyValue | Nilai kunci untuk autentikasi API Key. Wajib diisi jika Authentication diatur ke API Key. | ****** |
| Network | Jenis jaringan. Nilai default: Internet. | Internet |
Buat destinasi API
Masuk ke Konsol EventBridge. Di panel navigasi kiri, pilih Integration Center > API Destination.
Di bilah navigasi atas, pilih wilayah tempat Anda ingin membuat destinasi API.
Klik tab API Destination, lalu klik Create.
Di panel Create API Destination, konfigurasikan bagian berikut dan klik OK:
Basic Information: Atur Method ke Custom, lalu tentukan nama dan deskripsi destinasi API.
API Configuration: Atur URL ke titik akhir API layanan target, dan atur HTTP Method ke metode permintaan (misalnya, GET atau POST).
Connection Configuration: Pilih salah satu opsi berikut:
Create Connection — Konfigurasikan koneksi baru dengan mengikuti langkah-langkah di Buat koneksi.
Select Existing Connection — Pilih koneksi yang sudah ada dari daftar drop-down.
Gunakan destinasi API sebagai target event
Setelah membuat destinasi API, referensikan sebagai target dalam aturan event untuk mengarahkan event yang sesuai ke titik akhir destinasi.
Masuk ke Konsol EventBridge. Di panel navigasi kiri, klik Event Buses.
Di bilah navigasi atas, pilih wilayah. Klik nama event bus yang ingin Anda kelola.
Di panel navigasi kiri, klik Event Rules, lalu klik Create Rule.
Di panel Create Rule, selesaikan langkah berikut dan klik Create:
Pada tab Configure Basic Info dan Configure Event Pattern, konfigurasikan aturan event. Untuk detail selengkapnya, lihat Membuat aturan event.
Di langkah Configure Targets, pilih Triggered by API Operation dari daftar drop-down Service Type.
Untuk membuat destinasi API baru secara langsung, pilih Custom untuk Method dan konfigurasikan pengaturan seperti dijelaskan di Buat destinasi API.
Untuk menggunakan destinasi API yang sudah ada, pilih Use Existing Item untuk Method dan pilih destinasi API dari daftar drop-down.
Kelola koneksi
Setelah membuat koneksi, Anda dapat melihat, mengedit, atau menghapusnya dari tab Connection Configuration.
| Operasi | Langkah |
|---|---|
| Lihat detail | Klik Details di kolom Actions untuk melihat informasi dasar, konfigurasi autentikasi, konfigurasi jaringan, dan destinasi API yang terikat. |
| Edit | Klik Edit di kolom Actions untuk mengubah deskripsi koneksi. |
| Hapus | Klik Delete di kolom Actions. Baca pesan konfirmasi dan klik OK. |
Kelola destinasi API
Setelah membuat destinasi API, Anda dapat melihat, mengedit, atau menghapusnya dari tab API Destination.
| Operasi | Langkah |
|---|---|
| Lihat detail | Klik Details di kolom Actions untuk melihat informasi dasar, konfigurasi API, dan konfigurasi koneksi. |
| Edit | Klik Edit di kolom Actions untuk mengubah deskripsi dan konfigurasi API. |
| Hapus | Klik Delete di kolom Actions. Baca pesan konfirmasi dan klik OK. |