Tugas Call REST Endpoint

Tugas Call REST Endpoint memungkinkan Anda memanggil REST pihak ketiga mana pun API dari integrasi Anda. Respons dari panggilan REST API akan tersedia untuk dalam variabel integrasi dan dapat digunakan dalam tugas downstream lainnya.

Sebelum memulai

  • Agar terhubung ke endpoint autentikasi untuk panggilan REST API, pastikan Anda telah membuat profil OAuth 2.0 atau melampirkan akun layanan yang dikelola pengguna ke integrasi Anda. Jika API Anda tidak memerlukan autentikasi, kolom Authentication profile di panel konfigurasi tugas dapat dibiarkan kosong. Untuk melihat daftar konfigurasi, lihat Properti konfigurasi.

    Jika integrasi Anda memiliki profil OAuth 2.0 dan akun layanan yang dikelola pengguna yang telah dikonfigurasi, profil OAuth 2.0 akan digunakan secara default untuk autentikasi. Jika profil OAuth 2.0 atau akun layanan yang dikelola pengguna tidak dikonfigurasi, eksekusi akan gagal.

  • Jika integrasi Anda memiliki akun layanan yang dilampirkan, berikan peran IAM yang diperlukan ke akun layanan tersebut berdasarkan URL endpoint REST. Misalnya, jika URL endpoint REST Anda memanggil layanan Cloud Storage, berikan peran IAM yang diperlukan untuk layanan Cloud Storage.

    Untuk mengetahui informasi tentang cara memberikan peran ke akun layanan, lihat Mengelola akses ke akun layanan.

  • Pastikan Kontrol Layanan VPC BUKAN disiapkan untuk Integrasi Apigee di project Google Cloud.

Mengonfigurasi tugas REST Endpoint Panggilan

Untuk mengonfigurasi tugas Call REST Endpoint:

  1. Di UI Apigee, pilih Organisasi Apigee Anda.
  2. Klik Develop > Integrasi.
  3. Pilih integrasi yang ada atau buat integrasi baru dengan mengklik Buat Integrasi.

    Jika Anda membuat integrasi baru:

    1. Masukkan nama dan deskripsi dalam dialog Create Integration.
    2. Pilih Region untuk integrasi dari daftar wilayah yang didukung.
    3. Klik Create.

    Tindakan ini akan membuka integrasi di desainer integrasi.

  4. Di menu navigasi desainer integrasi, klik +Tambahkan tugas/pemicu > Tasks untuk melihat daftar tugas yang tersedia.
  5. Klik dan tempatkan elemen Call REST Endpoint di editor integrasi.
  6. Klik elemen Call REST Endpoint pada desainer untuk melihat tugas Call REST Endpoint panel konfigurasi.
  7. Konfigurasi kolom yang ditampilkan menggunakan properti konfigurasi tugas seperti yang dijelaskan dalam tabel di bawah.

    Perubahan pada properti disimpan secara otomatis.

Properti konfigurasi

Tabel berikut menjelaskan properti konfigurasi untuk tugas Call REST Endpoint.

Properti Data type Deskripsi
Label String Opsional: tambahkan label untuk tugas Anda.
Autentikasi String Opsional: mengonfigurasi dan menyimpan detail autentikasi untuk koneksi ke eksternal yang berbeda. Untuk mengetahui informasi selengkapnya, lihat Membuat profil autentikasi di Integrasi Apigee.
URL dasar endpoint String URL endpoint REST tanpa parameter kueri.
Metode HTTP NA Metode HTTP yang akan digunakan.

Anda dapat memilih salah satu metode HTTP berikut:

  • HAPUS
  • DAPATKAN
  • HEAD
  • PATCH
  • POST
  • PUT
Parameter string kueri URL Kunci string kueri : String

Nilai: String

Parameter kueri yang diperlukan untuk panggilan REST API.

Parameter kueri berbentuk pasangan nilai kunci dengan kunci sebagai nama kuncinya dan nilainya adalah nilai kunci yang sesuai. Anda dapat memasukkan lebih dari satu nilai kunci berpasangan dengan mengeklik ikon plus.

Header HTTP Kunci header HTTP: String

Nilai: String

Header HTTP yang diperlukan untuk panggilan REST API.

Header HTTP berbentuk pasangan nilai kunci dengan kunci adalah nama kunci dan nilai adalah nilai kunci yang sesuai. Anda dapat memasukkan lebih dari satu pasangan nilai kunci dengan mengklik ikon plus.

Mengikuti pengalihan Boolean Ikuti pengalihan URL.

Anda dapat memilih salah satu nilai:

  • True : Memanggil URL yang dialihkan jika URL dasar Endpoint diteruskan ke URL lain.
  • Salah: Tidak memanggil URL yang dialihkan jika URL dasar Endpoint diteruskan ke URL lain.
Tugas akan gagal saat terjadi error HTTP Boolean Strategi penanganan pengecualian saat panggilan REST API gagal. Call REST Endpoint akan gagal jika kode respons HTTP adalah 4xx atau 5xx. Untuk mengetahui daftar kode error, lihat Kode error. Untuk kode respons HTTP lainnya, tampilkan kode error dan pesan error dalam respons.

Anda dapat memilih salah satu nilai:

  • Benar : Menampilkan pengecualian.
  • Salah: Tidak memberikan pengecualian. Namun, mengembalikan kode error dan pesan error dalam respons.
Header respons (<Task name>) String Header respons yang tidak dikompresi dari respons REST API.
Isi respons (<Task name>) String Isi respons yang tidak dikompresi dari respons REST API.
Status respons (<Task name>) String Kode respons HTTP dan teks kode yang sesuai dari respons REST API.

Praktik terbaik

Untuk mengetahui informasi tentang batas penggunaan yang berlaku bagi tugas Call REST Endpoint, lihat Batas penggunaan.

Strategi penanganan error

Strategi penanganan error untuk tugas menentukan tindakan yang akan diambil jika tugas gagal karena error sementara. Untuk informasi tentang cara menggunakan strategi penanganan error, dan mengetahui berbagai jenis strategi penanganan error, lihat Strategi penanganan error.

Untuk mempelajari cara menangani strategi percobaan ulang untuk error 4xx atau 5xx, lihat blog Cara mencoba lagi Tugas Penelepon Istirahat berdasarkan Status Respons.