Pemicu API

Pemicu API digunakan untuk langsung memanggil eksekusi untuk integrasi.

Mengonfigurasi pemicu API dalam integrasi memungkinkan Anda melakukan hal berikut:

• Tetapkan payload permintaan dan respons menggunakan variabel input dan output khusus pemicu.
• Buat dan lihat Spesifikasi OpenAPI (OAS) untuk integrasi Anda.
• Memanggil integrasi secara sinkron atau asinkron.

Untuk membantu Anda mulai menggunakan pemicu API, lihat tutorial pemenuhan API. Tutorial ini menunjukkan cara membuat integrasi dengan pemicu API yang menerima permintaan API untuk mengambil informasi pelanggan.

Menambahkan pemicu API

Untuk menambahkan pemicu API ke integrasi Anda, lakukan langkah-langkah berikut:

1. Di konsol Google Cloud , buka halaman Application Integration.

   Buka Application Integration

2. Di menu navigasi, klik Integrations

   Halaman Integrations List akan muncul dan mencantumkan semua integrasi yang tersedia di project Google Cloud.

3. Pilih integrasi yang ada atau klik Create integration untuk membuat integrasi baru.

   Jika Anda membuat integrasi baru:

   1. Masukkan nama dan deskripsi di panel Create Integration.
   2. Pilih region untuk integrasi.
      Catatan: Dropdown Regions hanya mencantumkan region yang disediakan di project Google Cloud Anda. Untuk menyediakan region baru, klik Enable Region. Lihat Mengaktifkan wilayah baru untuk mengetahui informasi selengkapnya.
   3. Pilih akun layanan untuk integrasi. Anda dapat mengubah atau memperbarui detail akun layanan integrasi kapan saja dari panel Integration summary di toolbar integrasi.
      Catatan: Opsi untuk memilih akun layanan hanya ditampilkan jika Anda telah mengaktifkan tata kelola integrasi untuk region yang dipilih.
   4. Klik Create.

   Integrasi yang baru dibuat akan terbuka di editor integrasi.

4. Di menu navigasi editor integrasi, klik Triggers untuk melihat daftar pemicu yang tersedia.
5. Klik dan tempatkan elemen API trigger ke desainer.

Mengonfigurasi pemicu API

Untuk mengonfigurasi pemicu API, klik elemen API trigger di editor integrasi. Panel konfigurasi pemicu API akan muncul dan menampilkan kolom berikut:

• Label: Nama pemicu API yang terlihat dalam integrasi Anda. Anda dapat mengubah label menjadi nama pilihan Anda.
• Catatan: Anda dapat menambahkan catatan ke pemicu API untuk memberikan informasi tambahan tentang pemicu.
• ID Pemicu: ID unik yang ditetapkan ke pemicu API dalam format api_trigger/TRIGGER_NAME.
  Catatan: Anda dapat memiliki lebih dari satu pemicu API dalam integrasi. Setiap pemicu API diberi ID Pemicu yang unik.
• Variabel input: Memicu variabel input tertentu yang dapat Anda gunakan untuk menetapkan payload permintaan untuk pemicu API.
  • Untuk menambahkan atau menghapus variabel integrasi yang ada ke pemicu API, klik Modify dan pilih variabel yang diperlukan dari panel API trigger input variables.
  • Untuk menambahkan variabel baru, khususnya untuk pemicu API yang dipilih, klik Modify dan pilih + Add new variable dari panel API trigger input variables. Untuk mengetahui informasi tentang jenis data yang didukung, lihat Jenis data variabel yang didukung.
• Variabel output: Memicu variabel output tertentu yang dapat Anda gunakan untuk menetapkan payload respons bagi pemicu API.
  • Untuk menambahkan atau menghapus variabel integrasi yang ada ke pemicu API, klik Modify dan pilih variabel yang diperlukan dari panel API trigger output variables.
  • Untuk menambahkan variabel baru, khususnya untuk pemicu API yang dipilih, klik Modify dan pilih + Add new variable dari panel API trigger output variables. Untuk mengetahui informasi tentang jenis data yang didukung, lihat Jenis data variabel yang didukung.
Catatan: Anda dapat membuat variabel input dan output dari panel Variables dan panel konfigurasi pemicu API.
• Application Integration otomatis menambahkan variabel yang dibuat dari panel konfigurasi pemicu API ke pemicu tertentu tersebut sebagai variabel input atau output.
• Anda dapat menambahkan variabel secara manual dari satu pemicu API ke pemicu API lainnya sebagai variabel input atau output.
• Secara default, semua elemen dalam integrasi Anda dapat mengakses variabel yang dibuat dari panel Variables.
• Mengubah Jenis variabel dari suatu variabel akan memengaruhi semua elemen dalam integrasi Anda yang menggunakan variabel tersebut.

Melihat Spesifikasi OpenAPI untuk pemicu API Anda

Application Integration memberikan kemampuan untuk membuat dan melihat Spesifikasi OpenAPI secara dinamis dari integrasi yang Anda publikasikan dan dikonfigurasi dengan satu atau beberapa pemicu API. Untuk mengetahui informasi tentang cara melihat Spesifikasi OpenAPI, lihat Melihat Spesifikasi OpenAPI untuk integrasi Anda.

Catatan: Halaman ini berfokus pada pemanggilan pemicu API menggunakan API v1. Spesifikasi OpenAPI yang dibuat untuk integrasi Anda mungkin menyertakan definisi untuk versi API lainnya, seperti v2.

Memanggil pemicu API menggunakan panggilan API

Setelah memublikasikan integrasi yang memiliki pemicu API yang dikonfigurasi, Anda dapat menggunakan metode projects.locations.integrations.execute untuk memanggil pemicu tersebut dari aplikasi mana pun. Metode ini memicu eksekusi dalam mode sinkron.

Sintaksis

curl -X POST \
    -H "authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json" \
    -H "X-Server-Timeout: TIMEOUT_SECONDS" \
    -d '{"triggerId":"api_trigger/TRIGGER_NAME"}' \
    "https://LOCATION-integrations.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/integrations/-:execute"

Ganti kode berikut:

• TIMEOUT_SECONDS: Waktu tunggu dalam detik untuk panggilan API. Secara default, waktu tunggunya adalah 120 detik. Untuk mengetahui daftar kumpulan parameter permintaan yang telah ditentukan, lihat Parameter sistem.
• TRIGGER_NAME: Nama pemicu API dalam integrasi Anda.
• PROJECT_ID: ID project Google Cloud Anda.
• LOCATION: Region integrasi, misalnya us-east1.

Contoh

Contoh berikut memanggil integrasi di region us-east1 yang berisi pemicu API test_API_1 di project Google Cloud demo-project:

curl -X POST \
    -H "authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json" \
    -H "X-Server-Timeout: 300" \
    -d '{"triggerId":"api_trigger/test_API_1"}' \
    "https://us-east1-integrations.googleapis.com/v1/projects/demo-project/locations/us-east1/integrations/-:execute"

Pertimbangan

Saat menggunakan pemicu API, ukuran kumulatif semua variabel input dapat mencapai maksimum 8 MB. Jika ukurannya melebihi 8 MB, Application Integration tidak akan menjalankan integrasi dan Anda akan mendapatkan error.

Kuota dan batas

Untuk mengetahui informasi tentang kuota dan batas, lihat Kuota dan batas.

Langkah berikutnya

• Pelajari semua tugas dan pemicu.
• Pelajari cara menguji dan memublikasikan integrasi.
• Pelajari penanganan error.
• Pelajari log eksekusi integrasi.