Chuyển tới nội dung chính

Tài liệu tham chiếu

Phần tham chiếu mô tả mọi endpoint, sự kiện và khung dữ liệu đúng như máy chủ đang chạy. Nội dung được sinh từ mã nguồn và các bản OpenAPI công khai, nên thay đổi theo API. Nếu cần hướng dẫn từng bước, hãy bắt đầu từ phần Hướng dẫn.

Tham chiếuNội dungBase URL
REST APIEmail, Hỗ trợ (chat), Thanh toán, API key và webhook: mọi endpoint kèm tham số, schema yêu cầu và phản hồi, code mẫu và bảng "Try it" để gọi thửhttps://api.hatang.dev
Chat gateway APINhững gì widget website, SDK di động và ứng dụng cho nhân viên gọi: bootstrap, hội thoại, tải tệp, thiết bị, API nhân viênhttps://chat.hatang.dev
Sự kiện webhookMọi sự kiện kèm payloadendpoint của bạn
Giao thức realtimeWebsocket của khách: mọi khung, trường và giới hạnwss://chat.hatang.dev/ws
Mã lỗiMọi mã lỗi của API, giao thức realtime và SMTP relay
Giới hạnGiới hạn tốc độ và kích thước

Phần tham chiếu sinh tự động được viết bằng tiếng Anh, giống tên trường và mã lỗi trong API.

Tham chiếu SDK​

Sinh từ chú thích trong mã nguồn của từng SDK, mỗi SDK một trang (chỉ có tiếng Anh):

SDKTham chiếu
Node (@hatang/sdk)TypeDoc
Flutter (hatang_chat)dartdoc
iOS (HatangChat, HatangChatCore)DocC
Android (dev.hatang:chat, dev.hatang:chat-core)Dokka

Quy ước chung​

  • Xác thực. Lệnh gọi REST gửi Authorization: Bearer ht_.... Xem Xác thực để biết về scope và key thử nghiệm.
  • Định dạng. JSON cả chiều gửi và nhận, UTF-8. Thời gian theo ISO 8601, múi giờ UTC; số tiền (đồng) là số nguyên.
  • Lỗi. Mọi lỗi có dạng { "statusCode", "name", "message" }; xử lý theo name.
  • Phân trang. Endpoint dạng danh sách nhận limit và after, trả về has_more và next_cursor. Xem Phân trang.
  • Idempotency. POST /emails, POST /payments và gửi tin nhắn chat nhận header Idempotency-Key. Xem Idempotency.

Bản đặc tả cho máy đọc​

Dùng được với mọi công cụ OpenAPI (Postman, Insomnia, trình sinh code) hoặc nhập vào bộ kiểm thử của bạn.

Xem trang này dạng Markdown