Permintaan API Eksternal

Permintaan API Eksternal memungkinkan Anda menentukan template permintaan dan kemudian memicu panggilan keluar ke API apa pun dari dalam proses bisnis. Dengan mereka, Anda dapat menghubungkan proyek Anda ke layanan pihak ketiga mana pun, meskipun belum ada modul untuk itu di pasar.

Definisi

Konsultasikan spesifikasi bagaimana permintaan harus disusun dalam dokumentasi API dari penyedia layanan yang ingin Anda hubungi.

1. Untuk menentukan template permintaan baru, buka tab "Logika Bisnis" di sidebar (1), alihkan ke tab "Permintaan API Eksternal" (2), dan klik "Permintaan API Baru" (3).

2. Beri nama permintaan baru dan, opsional, deskripsi.

3. Pilih metode permintaan HTTP dan URL-nya.

4. Tentukan parameter URL, parameter kueri (hanya untuk permintaan GET), header, dan isi permintaan dengan memasukkan nama parameter (1), jenisnya (2), dan mengklik "Tambahkan Param" (3).

Nilai sebenarnya dari parameter ini akan ditentukan pada saat pelaksanaan proses bisnis, saat permintaan dipicu.

Untuk memahami perbedaan antara URL dan parameter kueri, baca selengkapnya di sini. Terlepas dari standarnya, dokumentasi API dari penyedia layanan yang ingin Anda hubungi adalah sumber informasi terbaik tentang cara membuat permintaan.

Anda juga dapat mengisi otomatis header dan isi permintaan dengan memasukkan sampel JSON, sistem akan membuat semua parameter yang diperlukan secara otomatis.

Anda tidak perlu menambahkan parameter baru di setiap tab. Beberapa permintaan mungkin tidak berisi parameter URL, header, atau isi sama sekali, misalnya.

Jika permintaan Anda berisi objek (misalnya mobil -> warna, ukuran, dll.), Anda harus membuat model virtual untuk memproses objek ini nanti dalam proses bisnis Anda. Lakukan dengan memilih "Model" di pemilih tipe parameter, dan perkenalkan elemen turunan yang akan Anda perlukan. Anda dapat membuat sarang objek sebanyak yang Anda butuhkan (yaitu objek di dalam objek) dan membuat larik model virtual. Jika Anda telah menggunakan isi otomatis, proses ini selesai secara otomatis.

5. Ubah pengaturan permintaan, seperti verifikasi SSL, batas waktu, dan penanganan kesalahan di tab "Pengaturan".

6. Uji permintaan dengan mengklik "Test Request" dan memasukkan semua parameter yang diperlukan. Periksa respons dari server dan isi otomatis header dan isi respons secara otomatis, atau lakukan secara manual.

7. Simpan template permintaan dengan mengklik "Simpan Permintaan".

Menggunakan

Setelah Anda menentukan dan menyimpan permintaan baru, blok baru akan tersedia di Editor Proses Bisnis untuk memicunya.

Anda harus menyediakannya dengan semua komponen yang ingin Anda tambahkan ke permintaan (URL dan parameter kueri, header, dan isi) sebagai model data, yang dapat dibuat menggunakan blok ini. Dalam output, Anda akan dapat mengekstrak isi respons yang diformat, headernya, dan status respons. Anda dapat memperluas model ini menggunakan blok ini.

Anda tidak harus menghubungkan semua input data agar permintaan dapat dipicu dengan benar. Misalnya, jika Anda memiliki permintaan tanpa parameter URL, Anda tidak perlu membuat modelnya dan menghubungkannya.

Untuk setiap model virtual yang telah Anda tetapkan, 2 blok baru akan ditambahkan ke Editor Proses Bisnis Anda untuk membuat dan mengembangkannya.

Pemantauan

Setiap kali Anda memicu permintaan API, sistem akan menampilkan jenis dan alamatnya ke log, isi permintaan, kode status HTTP respons, dan isi respons. Anda dapat menampilkan info lain, seperti kolom tertentu dari badan respons, atau latensi ke log menggunakan blok Write to Log.