Menambahkan API dan Mengatur Respons API dalam Percakapan
Last updated
Last updated
Untuk menambahkan berbagai layanan tambahan dari sumber eksternal, Anda dapat menggunakan elemen JSON API sehingga pengelolaan beragam data yang ada di dalam chatbot dapat dirancang lebih dinamis, misalnya data terkait informasi pelanggan, hasil pencarian, hingga data transaksi pada sistem CRM.
Selanjutnya, Anda dapat menyaring, mengolah, dan memvalidasi data yang diterima chatbot melalui elemen JSON API dengan menambahkan elemen Filter.
Tarik dan lepas elemen JSON API ke dalam kanvas Anda dan hubungkan elemen tersebut setelah elemen User Input.
Masukkan nama elemen pada bagian teks Enter element name dan lengkapi kolom teks lainnya sesuai dengan API yang ingin dihubungkan ke dalam chatbot Anda.
Anda dapat mempelajari secara singkat detail kolom teks yang perlu dilengkapi pada elemen JSON API, sebagai berikut:
Methods Tentukan jenis permintaan HTTP yang akan dikirimkan ke API dengan memilih salah satu metode yang akan digunakan.
Beberapa metode API beserta fungsi pemakaian yang dapat Anda gunakan pada elemen JSON API adalah:
GET: Mengambil data dari API.
POST: Mengirimkan data ke API.
PUT: Memperbarui data yang ada di API.
DELETE: Menghapus data dari API.
URL URL berfungsi untuk menentukan endpoint API yang akan diakses oleh chatbot. Masukkan URL endpoint yang akan digunakan untuk berinteraksi dengan data atau fungsi API dan pastikan URL sesuai dengan metode yang dipilih.
Headers Header berfungsi sebagai sumber informasi tambahan untuk setiap panggilan API yang dibuat dan merepresentasikan metadata terkait permintaan atau respons API Anda. Masukkan key dari API dan variable untuk headers API. Anda dapat memilih variable yang sebelumnya telah Anda buat dan gunakan untuk menkategorikan pesan pelanggan ke kelompok tertentu, misal nama pelanggan, nomor ID pelanggan, dan data pelanggan lainnya. Klik Add New Headers untuk menambahkan headers baru.
Parameters Parameter adalah komponen untuk memfasilitasi pertukaran data pada OCA dengan API Anda. Masukkan key pada parameter dan pilih tipe data API Anda. Masukkan juga variable untuk parameter API. Klik Add New Parameters untuk menambahkan parameter lainnya.
Body Body umumnya digunakan pada API yang menggunakan metode POST, PUT, atau PATCH dan berfungsi untuk mengirimkan data dalam body permintaan. Pada bagian Body, pilih Form Data atau Row sebagai badan dari API sesuai dengan format data yang diminta oleh API. Jika Anda memilih RAW, masukkan JSON payload yang dibutuhkan dan dapat berupa variable dinamis seperti [collect_email].
Capture Response Melalui Capture Response, chatbot dapat menangkap, menyimpan, dan membantu Anda mengolah berbagai data dari respons API untuk digunakan di langkah selanjutnya dalam percakapan chatbot. Data dari balasan pelanggan dapat Anda gunakan diantara lain untuk disimpan pada database Anda, digunakan selama percakapan berlangsung, memvalidasi data pelanggan, atau memberikan balasan tertentu kepada pelanggan berdasarkan respons yang didapatkan oleh API. Pada bagian ini, masukkan nama field dari respons API yang ingin Anda dapatkan di kolom Enter a key for capture response, misalnya masukkan "Email" jika Anda ingin mendapatkan data alamat email pelanggan Anda. Selanjutnya, masukkan variable di kolom bagian bawah untuk menentukan variable yang akan ditangkap, misalnya [email]. Klik Add New Capture Response jika Anda perlu menambahkan lebih banyak jenis data atau variable lainnya yang ingin ditangkap.
Test API: Anda dapat menguji coba API yang akan Anda tambahkan dengan menggunakan salah satu variable yang telah dipilih. Pilih variable dan masukkan value dari variable tersebut. Anda dapat menambahkan variable lainnya dengan mengklik Add New Variable. Klik Test API ketika Anda sudah mengisi semua data variable untuk uji coba API.
Informasi terkait respons API terhadap variable yang dipilih akan muncul pada bagian Result Test.
Setelah mengisi informasi terkait API yang Anda butuhkan, klik ikon centang pada kanan atas jendela JSON API untuk menyimpannya.
Pada elemen JSON API, Anda dapat mengatur pesan balasan chatbot sesuai dengan pesan yang ditangkap chatbot dari komponen Capture Response.
Hubungkan elemen JSON API dengan elemen Filter untuk menyaring respons API sesuai dengan yang Anda butuhkan. Setiap satu elemen JSON API dapat terhubung ke beberapa elemen Filter untuk Anda dapat memberikan balasan yang sesuai dari respons yang telah disaring.
Tarik dan lepas elemen Filter ke dalam kanvas Anda, kemudian hubungkan dengan elemen JSON API yang ingin Anda atur responsnya.
Pilih nama variable dan pilih metode penyaringan atau pencocokkan data dari balasan pelanggan pada bagian Select a condition. Kemudian, masukkan jenis data yang akan divalidasi pada bagian Enter a value.
Misalnya, Anda ingin mendapatkan dan memvalidasi data berupa alamat email pelanggan Anda, maka Anda dapat memilih nama variable email pada kotak pertama. Kemudian, pilih Equals sebagai metode pencocokkan data dan masukkan variable {Email} pada jenis data yang akan divalidasi.
Setelah melengkapi data untuk menyaring respons API pada elemen Filter, klik ikon centang untuk menyimpan elemen tersebut.
Dengan menyaring respons dari API menggunakan elemen Filter, Anda dapat memastikan chatbot hanya melanjutkan percakapan berdasarkan data yang memenuhi kriteria tertentu sehingga percakapan tetap relevan dan sesuai dengan konteks yang diinginkan. Jika elemen Filter gagal mendapatkan data sesuai dengan kriteria yang ditentukan, Anda dapat menambahkan elemen Else sebagai alternatif balasan dari percakapan chatbot.
Selanjutnya, Anda dapat menambahkan elemen Bot Response setelah elemen Filter untuk menampilkan kembali data yang Anda terima sebagai konfirmasi kepada pelanggan Anda.
