Lihat konektor yang didukung untuk Integration Aplikasi.

Pemicu API

Pemicu API digunakan untuk langsung memanggil eksekusi untuk integrasi.

Mengonfigurasi pemicu API dalam integrasi memungkinkan Anda melakukan hal berikut:

Untuk membantu Anda memulai pemicu API, lihat tutorial fulfillment 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 Integrasi Aplikasi.

    Buka Integration Aplikasi

  2. Di menu navigasi, klik Integrations

    Halaman Daftar Integrasi akan muncul yang mencantumkan semua integrasi yang tersedia di project Google Cloud.

  3. Pilih integrasi yang ada atau klik Buat integrasi untuk membuat integrasi baru.

    Jika Anda membuat integrasi baru:

    1. Masukkan nama dan deskripsi di panel Buat Integrasi.
    2. Pilih region untuk integrasi.
    3. Pilih akun layanan untuk integrasi. Anda dapat mengubah atau memperbarui detail akun layanan integrasi kapan saja dari panel Ringkasan integrasi di toolbar integrasi.
    4. Klik Create.

    Tindakan ini akan membuka integrasi di editor integrasi.

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

Mengonfigurasi pemicu API

Untuk mengonfigurasi pemicu API, klik elemen Pemicu API 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.
  • 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 Ubah, lalu pilih variabel yang diperlukan dari panel Variabel input pemicu API.
    • Untuk menambahkan variabel baru, khususnya untuk pemicu API yang dipilih, klik Ubah, lalu pilih + Tambahkan variabel baru dari panel Variabel input pemicu API. Untuk 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 untuk pemicu API.
    • Untuk menambahkan atau menghapus variabel integrasi yang ada ke pemicu API, klik Ubah, lalu pilih variabel yang diperlukan dari panel Variabel output pemicu API.
    • Untuk menambahkan variabel baru, khususnya untuk pemicu API yang dipilih, klik Ubah, lalu pilih + Tambahkan variabel baru dari panel Variabel output pemicu API. Untuk informasi tentang jenis data yang didukung, lihat Jenis data variabel yang didukung.

Melihat Spesifikasi OpenAPI untuk pemicu API Anda

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

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 apa pun. Metode ini memicu eksekusi dalam mode sinkron.

Sintaks

curl -X POST \
    -H "authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json" \
    -H "X-Server-Timeout: TIMEOUT_SECONDS" \
    -d '{"trigger_id":"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 standar, lihat Parameter sistem.
  • TRIGGER_NAME: Nama pemicu API dalam integrasi Anda.
  • PROJECT_ID: ID Google Cloud project Anda.
  • LOCATION: Lokasi Google Cloud project Anda.

Contoh

Contoh berikut memanggil integrasi di wilayah us-east1 yang berisi pemicu test_API_1 API 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 '{"trigger_id":"api_trigger/test_API_1"}' \
    "https://us-east1-integrations.googleapis.com/v1/projects/demo-project/locations/us-central1/integrations/-:execute"

Pertimbangan

Saat menggunakan pemicu API, ukuran kumulatif semua variabel input dapat maksimal 8 MB. Jika ukurannya melebihi 8 MB, Integrasi Aplikasi tidak akan menjalankan integrasi dan Anda akan mendapatkan error.

Kuota dan batas

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

Langkah selanjutnya