Custom API
Buka di CMSLayar Custom API mendefinisikan HTTP API yang dapat dipanggil agent Anda selama percakapan, misalnya untuk mengecek pesanan atau membuat tiket. Terdapat di sidebar agent pada Tools → Custom API. Perubahan yang Anda buat di sini hanya tersimpan setelah Anda mengklik Save all changes.
Custom API
| Import OpenAPI Schema | Membuka dialog import untuk membuat API dari OpenAPI schema. |
| Add New API | Membuka panel New API. |
| Add Category | Menampilkan field Category name untuk membuat category. Nama yang sudah ada tidak dapat ditambahkan. |
| Set Authentication | Membuka panel Set Authentication untuk menerapkan satu authentication ke banyak API sekaligus. |
| Empty state | "No APIs Configured" ditampilkan saat belum ada API maupun category. |
| Save all changes | Menyimpan seluruh perubahan API, category, dan urutan setelah Anda mengonfirmasi. |
Daftar API dan Category
| Baris API | Menampilkan nama dan deskripsi API. Klik untuk membuka panel Edit API. |
| Drag handle | "Drag to reorder". Seret API untuk mengubah urutannya atau memindahkannya ke category lain (atau keluar dari semua category). |
| Switch Enable / Disable | Mengaktifkan atau menonaktifkan API untuk agent tanpa menghapusnya. |
| Tombol hapus | Menghapus API dari daftar. Belum ada yang tersimpan sampai Anda mengklik Save all changes. |
| Rename category | Mengganti nama category. |
| Delete category | Menghapus category yang kosong. Tidak dapat diklik selama category masih berisi API ("Cannot delete: category is not empty"). |
| Category kosong | Menampilkan "No APIs in this category. Drag an API here to add it." |
New API / Edit API: Basic Information
| Action Name | Nama API yang unik dan deskriptif (wajib), misalnya retrieveWeatherData. |
| Description | Menjelaskan secara rinci apa yang dilakukan API. Agent menggunakannya untuk memutuskan kapan memanggil API. |
| HTTP Method | GET, POST, PUT, DELETE, atau PATCH. |
| Target URI | Endpoint yang dipanggil API. |
| Loading Text Type | Apa yang dilihat pengguna saat API berjalan: None, Fixed, Dynamic, atau Auto. |
| Loading Text / Loading Text Prompt | Muncul untuk Fixed (teks persis yang ditampilkan) dan Dynamic (prompt yang dipakai agent untuk menulis teksnya). |
| Rules | Instruksi kapan dan bagaimana API digunakan, misalnya "Only provide responses for supported locations". |
| Response Prompt | Cara agent menyajikan hasilnya. |
| Additional Properties | Mengizinkan API menerima parameter yang tidak ada di daftar properties. |
| Send Metadata | Mengirim konteks percakapan dan pengguna (info agent, user, message, dan channel) bersama setiap request, sebagai header dan, tergantung HTTP method, di query string atau request body. |
New API / Edit API: Authentication
| Auth Type | None, Basic, Bearer, Custom, atau Oauth. |
| Key | Bearer: token. Custom: nilai header. |
| Username / Password | Kredensial untuk Basic authentication. |
| Header Name | Custom: nama header yang membawa key. |
| OAuth Provider | Client Credentials atau Google Service Account (JWT Bearer). |
| Token URL | Endpoint token OAuth. |
| Client ID / Client Secret / Scopes | Pengaturan Client Credentials. |
| Google Service Account JSON | Google Service Account: unggah file JSON key dari Google Cloud Console. Pada API yang sudah ada, Anda dapat mengunggah file baru untuk menggantinya. |
| User Delegation (Optional) / API Scopes | Google Service Account: user yang diwakili, dan Google API scope yang diminta. |
New API / Edit API: Properties
| Property Name | Nama parameter. |
| Property Type | Boolean, Number, atau String. |
| Location | Lokasi pengiriman nilai: Querystring, Header, Body, atau Path. |
| Required Parameter | Menandai parameter sebagai wajib. |
| Property Enum | Daftar nilai yang diizinkan (opsional). |
| Property Description | Memberi tahu agent apa yang harus diisi pada parameter. |
| Add New Property | Menambahkan parameter lain. |
| Test API | Muncul saat mengedit API yang sudah ada. Membuka tampilan test. |
| Add New API / Update API | Menerapkan isi panel ke daftar. Klik Save all changes setelahnya untuk menyimpan. |
Test API
| Back to Configuration | Kembali ke form API. |
| API Details | HTTP method, authentication, endpoint, dan deskripsi API. |
| Parameters | Input untuk setiap property yang dikonfigurasi. |
| Metadata | Muncul saat Send Metadata aktif: Agent ID, User ID, User Email, Inquiry Message ID, Media Type, Messenger Product, dan Messenger Account Code, dikirim bersama request. |
| Call API | Mengirim request. |
| API Response | Status code, Response Headers, dan Response Body, masing-masing dengan tombol copy. |
Import OpenAPI Schema
| Schema Format | JSON atau YAML (wajib). |
| Schema File | Seret dan lepas atau pilih file JSON atau YAML. |
| Override Authentication | No mempertahankan authentication yang ada atau tanpa authentication; Yes menerapkan authentication yang Anda atur di sini ke semua API hasil import. |
| Paste your OpenAPI schema here | Editor schema (langkah 2). |
| Import Preview | Menampilkan New APIs dan Updated APIs sebelum import. |
| Start Import | Menambahkan API ke daftar. Ringkasan mengonfirmasi hasilnya; periksa authentication lalu klik Save all changes. |
Set Authentication
| Field authentication | Field yang sama dengan bagian Authentication pada API. |
| Select APIs to update | Semua API dikelompokkan per category, dengan checkbox, Select All, dan Clear All. |
| OK | Meminta konfirmasi, lalu menimpa authentication pada API yang dipilih. Klik Save all changes setelahnya. |
| Cancel | Menutup panel tanpa perubahan. |
Panduan terkait: Menghubungkan API Anda