Tài liệu tham khảo SDK

Mọi Keyda SDK — Android, iOS, React Native, Flutter, Ionic — đều áp dụng cùng một giao diện nhỏ gọn. Nếu bạn đã dùng một cái, bạn đã dùng được tất cả.

API

Gọi	Nó làm gì
`init` / `initialize`	Lưu trữ client id của bạn. Xác thực và báo lỗi rõ ràng nếu định dạng không hợp lệ.
`show`	Hiển thị khung chat trên ứng dụng của bạn.
`dismiss`	Đóng khung chat lại.
`isShowing`	Liệu nội dung có đang hiển thị ngay bây giờ hay không.

Cố tình không có gì khác ngoài những thứ này. Không có API gửi tin nhắn, không có số lượng chưa đọc, không có lệnh gọi danh tính người dùng — bởi vì chưa có tính năng nào trong số đó hoạt động hoàn chỉnh từ đầu đến cuối, và một phương thức không hoạt động còn tệ hơn là không có.

URL mà mọi SDK mở ra

{baseUrl}/chat/{clientId}

baseUrl mặc định là https://keyda.in/business và có thể ghi đè trên mọi nền tảng, dùng cho môi trường thử nghiệm hoặc bản cài đặt tự lưu trữ.

Tại sao dùng web view và chi phí bạn phải trả

Chỉ có một giao diện chat duy nhất do nền tảng cung cấp và mọi nền tảng đều tải giao diện đó.

Bạn nhận được gì: mọi thay đổi mà chủ doanh nghiệp thực hiện trên bảng điều khiển — màu điểm nhấn, tin nhắn chào mừng, tên bot, chuyển sang trạng thái hoạt động — đều đến với mọi ứng dụng ngay lập tức mà không cần phát hành bản mới. Một bản sửa lỗi áp dụng ở mọi nơi cùng lúc. Khung chat giống hệt nhau trên các nền tảng.

Chi phí: đoạn chat cần có kết nối. Không có chế độ ngoại tuyến và chưa có thông báo đẩy.

Chúng tôi muốn bạn biết điều này trước khi đưa sản phẩm lên sóng hơn là phát hiện ra nó sau khi đã xong.

Các cam kết từ mỗi SDK

Thoát điều hướng. Liên kết đến bất kỳ nguồn gốc nào khác sẽ mở trong trình duyệt hệ thống thay vì thay thế khung chat. Nếu không có tính năng này, chỉ một lần chạm vào liên kết ở chân trang sẽ chấm dứt cuộc trò chuyện của khách hàng mà không có cách nào quay lại.
Duy trì cuộc trò chuyện. Bộ nhớ DOM được bật, vì vậy khách hàng đóng ứng dụng và quay lại sẽ thấy đoạn chat ở đúng vị trí họ đã dừng (trong vòng 24 giờ).
Bàn phím không bao giờ che khuất ô nhập liệu.
Khu vực an toàn được tôn trọng — không có khung chat nào hiển thị bên dưới tai thỏ hoặc thanh điều hướng.
Không có lỗi sự cố nào ảnh hưởng đến ứng dụng của bạn. Khi tải thất bại, ứng dụng sẽ hiển thị nút thử lại.
Không có công cụ phân tích, không có mã nhận danh thiết bị, không có bên thứ ba phụ thuộc. Việc thêm Keyda SDK không làm tăng thêm trình theo dõi nào vào ứng dụng của bạn.

Định dạng Client id

kb_live_ followed by 8-48 hexadecimal characters

Bất kỳ điều gì khác đều sẽ bị từ chối khi khởi tạo thay vì hiển thị lỗi 404 trước mặt khách hàng. Client id được thiết kế để công khai — nó hiển thị trên bất kỳ trang nào nhúng widget — và không có khả năng đọc hoặc thay đổi tài khoản của bạn. Xem thêm tại giới hạn và bảo mật.

Nguồn

Công khai, theo giấy phép MIT: github.com/KeydaAI/keyda-business-sdks. Thỏa thuận chung mà mọi gói phải tuân theo nằm ở CONTRACT.md ở đầu kho lưu trữ đó.