Aksi Permintaan Eksternal: Panduan API & Metode HTTP

1. Pendahuluan

Anda dapat menggunakan permintaan eksternal untuk memanggil antarmuka pihak ketiga dan menggunakan respons dari antarmuka tersebut untuk membantu Anda mengumpulkan data atau menjalankan proses otomatis selanjutnya.

Contohnya:

• Melalui permintaan eksternal, data pengunjung (nama pengguna, nomor telepon, alamat email, dan pesan terakhir yang dikirim oleh pengunjung) dikirim ke URL permintaan untuk memenuhi tujuan pengumpulan dan analisis data platform pihak ketiga.
• Melalui permintaan eksternal, data tertentu dikembalikan dan variabel yang sesuai dihasilkan. Variabel ini dapat digunakan dalam aksi mengirim pesan untuk memenuhi persyaratan balasan otomatis tertentu.

1.1 Apa itu antarmuka API?

API (Application Programming Interface) adalah bagian penting dari aplikasi. Antarmuka adalah alat yang memungkinkan aplikasi perangkat lunak yang berbeda untuk berkomunikasi dan bertukar data satu sama lain. Aplikasi menyediakan titik masuk untuk mengoperasikan data. Titik masuk ini dapat berupa fungsi atau metode kelas, atau alamat URL atau alamat jaringan. Ketika klien memanggil titik masuk ini, aplikasi akan menjalankan operasi kode yang sesuai untuk menyelesaikan fungsi yang sesuai untuk klien.

1.2 Metode permintaan HTTP

Metode HTTP mengacu pada metode yang didefinisikan dalam protokol HTTP standar yang digunakan untuk komunikasi antara klien dan server. Metode ini menentukan bagaimana klien mengoperasikan sumber daya server, sehingga menentukan perilaku antarmuka API yang sesuai. Metode umum meliputi:

• GET: Digunakan untuk meminta server mengembalikan representasi dari sumber daya tertentu, biasanya digunakan untuk mendapatkan data. Metode GET tidak memengaruhi sumber daya server dan aman serta idempoten.
  Misalkan Anda menggunakan aplikasi pembaca berita dan Anda ingin memeriksa berita utama hari ini. Ketika Anda membuka aplikasi dan mengklik tombol Periksa Berita, aplikasi mengirimkan permintaan GET ke server untuk data berita hari ini. Setelah menerima permintaan GET ini, server mengembalikan data yang berisi berita utama hari ini sehingga Anda dapat melihatnya di aplikasi.
• POST: Digunakan untuk mengirimkan data ke server, sering digunakan untuk membuat sumber daya baru atau melakukan operasi non-idempoten. Permintaan POST dapat mengubah status server atau memiliki efek samping.
  Sekarang misalkan Anda ingin memposting komentar di aplikasi pembaca berita yang sama. Ketika Anda membaca sebuah berita, masukkan komentar Anda di kotak komentar dan klik tombol Posting Komentar. Aplikasi akan mengirimkan permintaan POST ke server untuk mengirimkan komentar Anda. Setelah menerima permintaan POST, server akan menyimpan komentar Anda ke database dan mengembalikan respons yang menunjukkan bahwa komentar berhasil diposting.
• PUT: Digunakan untuk memperbarui atau mengganti sumber daya ke server. Biasanya digunakan untuk mengganti sumber daya yang ditentukan sepenuhnya atau membuat sumber daya baru, tetapi memerlukan klien untuk menyediakan representasi sumber daya yang lengkap. Permintaan PUT harus idempoten, yaitu hasil dari beberapa panggilan ke permintaan PUT yang sama harus konsisten.
  Ketika Anda mengedit profil Anda, Anda mungkin menggunakan metode PUT. Misalnya, jika Anda memperbarui informasi profil Anda (seperti nama, tanggal lahir, avatar, dll.) di platform media sosial, ketika Anda mengklik tombol Simpan, klien akan mengirimkan permintaan PUT ke server untuk mengirimkan profil yang diperbarui ke server, dan server akan menggunakan informasi ini untuk memperbarui profil Anda.
• DELETE: Digunakan untuk meminta server menghapus sumber daya yang ditentukan. Sering digunakan untuk menghapus sumber daya yang ditentukan. Permintaan DELETE harus idempoten, yaitu hasil dari beberapa panggilan ke permintaan DELETE yang sama harus konsisten.
  Ketika Anda menghapus postingan di platform media sosial, Anda mungkin menggunakan metode DELETE. Ketika Anda mengklik tombol Hapus, klien mengirimkan permintaan DELETE ke server, meminta penghapusan postingan yang ditentukan, dan server akan menghapus postingan dan konten terkaitnya.

2. Proses Operasi

2.1 Tambahkan aksi permintaan eksternal

Klik tanda + di sebelah kanan > klik Aksi Permintaan Eksternal > Selesai menambahkan.

2.2 Konfigurasi permintaan eksternal

2.2.1 Konfigurasi URL permintaan (wajib)

• Klik Permintaan Eksternal untuk membuka jendela konfigurasi > Pilih metode permintaan (POST, GET, DELETE) > Isi URL permintaan sesuai kebutuhan.

• Sesuai kebutuhan, Anda dapat menambahkan data pengguna dan memanggil URL permintaan. Klik tanda + > klik data yang ingin Anda transfer > dan selesaikan penambahan. (Opsional)

2.2.2 Isi parameter Headers dan Body yang diperlukan untuk URL permintaan (opsional sesuai kebutuhan)

• Tambahkan Headers atau Body sesuai dengan URL permintaan. Klik Tambah > Isi.
• Demikian pula, Anda dapat menambahkan data pengguna. Klik tanda + dan pilih data pengguna yang sesuai sesuai kebutuhan.

2.2.3 Uji Permintaan

Anda dapat menguji konten yang baru saja Anda isi untuk melihat apakah panggilan berhasil atau data callback.

• Klik Uji Permintaan untuk memulai pengujian.
• Jika data yang dikembalikan tidak normal, Anda dapat memodifikasi data, klik Permintaan Ulang, dan uji kembali.

2.2.4 Menggunakan Pemetaan Respons

• Anda dapat menggunakan konten yang dikembalikan oleh respons eksternal, menetapkannya ke variabel yang sesuai, dan menggunakannya dalam aksi mengirim pesan.
• Klik Tambah > Masukkan konten respons sesuai persyaratan (harus diisi sesuai format jalur JSON) > Isi variabel yang sesuai dalam pesan yang akan dikirim sesuai dengan variabel yang ditampilkan kemudian, dan pengiriman pesan variabel tertentu secara otomatis dapat dipicu.

Catatan: Untuk format jalur Json, silakan merujuk ke https://goessner.net/articles/JsonPath/, yang berisi pengantar sampel, seperti yang ditunjukkan pada Gambar 2.

3. Pertanyaan yang Sering Diajukan

3.1 Bisakah saya mendapatkan data dari seluruh data?

Tidak, Anda hanya bisa mendapatkan salah satu item di bawah data.

3.2 Dalam proses otomatisasi, apakah cabang dapat ditentukan berdasarkan nilai kembalian dari permintaan eksternal sesuai dengan nilai kembalian dari ?

Belum didukung. Saat ini, nilai kembalian dari permintaan eksternal hanya mendukung pengiriman pesan.