Ikhtisar API Terbuka
Metode autentikasi, format respons, kode kesalahan, dan kode bahasa yang didukung.
{API} di bawah ini merujuk pada alamat layanan, yang dapat dilihat di halaman "Integrasi" (接入) pada panel admin.
Semua permintaan menyertakan Authorization: Bearer sk_live_... (dibuat di halaman "Integrasi" pada panel admin, hanya ditampilkan satu kali, dan hanya disimpan di server).
Respons selalu berbentuk {"code": "SUCCESS", "message": "", "data": ...}. Saat gagal, code adalah kode error yang stabil, gunakan itu sebagai acuan; message hanya untuk dibaca manusia. Semua nominal selalu berupa string.
Kode Error
| code | Skenario |
|---|---|
UNAUTHORIZED | API Key tidak valid atau sudah tidak berlaku |
VALIDATION_ERROR | Parameter tidak benar, field yang bermasalah ada di data |
NOT_FOUND | Resource tidak ditemukan (termasuk resource yang bukan milik Anda) |
PLAN_LIMIT_REACHED | Melebihi batas jumlah produk, kapasitas knowledge base, atau jumlah seat pada paket |
CONVERSATION_CLOSED | Sesi sudah berakhir, silakan buat sesi baru |
CONVERSATION_OPEN | Sesi belum berakhir, belum bisa memberi rating |
RATE_LIMITED | Permintaan terlalu sering |
USER_TOKEN_INVALID | Signature user_token salah atau sudah kedaluwarsa |
CHECKOUT_FAILED | Konfirmasi pesanan sudah tidak berlaku, atau API pembuatan pesanan sementara tidak dapat diakses (saat mengklik "Konfirmasi Pesanan" di widget) |
ORIGIN_NOT_ALLOWED | Situs saat ini tidak ada dalam daftar situs yang diizinkan untuk embedding |
LANGUAGE_NOT_SUPPORTED | Bahasa ini tidak didukung atau belum diaktifkan |
CHANNEL_CHECK_FAILED | Verifikasi AppID / AppSecret kanal gagal, alasan dari WeChat ada di message |
CHANNEL_REMOVED | Kanal asal sesi sudah dihapus, balasan tidak dapat dikirim |
Kode bahasa yang didukung: zh-CN, zh-TW, en, ja, ko, de, fr, es, pt, it, ru, ar, th, vi, id, ms, tr, nl, pl. Penulisan seperti zh-Hant, pt-BR, en_US akan otomatis dikonversi ke kode yang sesuai.
Apakah halaman ini membantu?
Terakhir diperbarui:
