Nhảy tới nội dung

Hướng dẫn sử dụng API của Chative.IO

Giới thiệu​

Với Chative.IO, bạn có thể trao đổi dữ liệu giữa các ứng dụng phần mềm dễ dàng bằng API.

Hình ảnh dưới đây cung cấp cái nhìn tổng quan về API, cho thấy các tính năng và chức năng của nó!

Quy ước​

Để tương tác với API, sử dụng URL cơ bản: https://api.chative.io/v1.0/. Đảm bảo sử dụng HTTPS cho tất cả các yêu cầu API để đảm bảo giao tiếp an toàn.

API của Chative.IO tuân theo các quy ước RESTful, sử dụng các phương thức GET, POST, PATCH và DELETE cho tất cả các hoạt động liên quan đến khách hàng. Các dữ liệu yêu cầu và phản hồi được mã hóa theo định dạng JSON.

Các endpoints được hỗ trợ​

Phương thức HTTPEndpoint
GEThttps://api.chative.io/docs/#/Contacts/get_contacts
GEThttps://api.chative.io/docs/#/Contact/get_contacts__contactId_
PATCHhttps://api.chative.io/docs/#/Contact/patch_contacts__contactId_
DELETEhttps://api.chative.io/docs/#/Contact/delete_contacts__contactId_

Mã trạng thái​

Mã thành công​

Mã trạng thái HTTPMô tả
200Hoạt động bình thường

Mã lỗi​

Mã trạng thái HTTPThông báo
400Yêu cầu không hợp lệ
401Thiếu token
401Token không hợp lệ
404{{ tên tài nguyên }} không tìm thấy
429Vượt quá giới hạn. Thử lại sau 1 phút.
500Đã xảy ra sự cố từ phía Chative.

Giới hạn tần suất​

Khi vượt quá giới hạn tần suất, yêu cầu sẽ trả về mã lỗi "rate_limited" (trạng thái phản hồi HTTP 429).

Lưu ý rằng số lượng yêu cầu tối đa cho mỗi yêu cầu là 200.

Đối tượng​

Khách hàng​

Đối tượng này đại diện cho một khách hàng trong ứng dụng Chative.IO.

Các thuộc tính của khách​

Để biết thông tin chi tiết về các thuộc tính của Khách hàng, vui lòng tham khảo tài liệu API.

Cách sử dụng​

Tài liệu này cung cấp cái nhìn tổng quan về các endpoints API mà chúng tôi cung cấp và tài liệu tham khảo chi tiết.

thông tin

Tính năng này chỉ dành cho người dùng đăng ký gói BUSINESS.

API Key là gì?​

API Key là một định danh được sử dụng để xác thực người dùng hoặc nhà phát triển khi yêu cầu tới API của Chative.IO, ví dụ: để lấy danh sách khách hàng hoặc cập nhật thông tin khách.

Thực hiện các bước sau để tạo API Key:

Bước 1: Truy cập vào ứng dụng Chative.IO.

Bước 2: Trên thanh bên trái, nhấp vào biểu tượng Cài đặt.

Bước 3: Trong menu xổ xuống, nhấp vào Developer > Khóa API.

API Key

Bước 4: Nhấp vào Tạo khóa API.

Tạo khóa AP

Cách sử dụng API​

Bước 1: Truy cập vào phần API trong Chative để tạo Khóa API.

Bước 2: Sao chép khóa bí mật liên kết với Khóa API đã tạo. Hãy đảm bảo rằng Khóa API đang hoạt động.

Sao chép API Key

Bước 3: Quay lại trang này và nhấp vào Xác thực. Sau đó, dán khóa bí mật vào trường nhập liệu.

Xác thực

Bước 4: Nhấp vào API mà bạn muốn sử dụng, sau đó chọn Thử ngay để tiếp tục.

Thử ngay

Cập nhật thông tin liên hệ​

Lưu ý rằng cập nhật chỉ được hỗ trợ cho các trường cụ thể, bao gồm:

  • firstName (ví dụ: Peter).
  • lastName (ví dụ: Parker).
  • email (ví dụ: 'user@example.com').
  • gender (ví dụ: 'male').
  • birthday (ví dụ: 1028221200).
  • phone (ví dụ: 0123456789).
  • custom fields: (ví dụ: VIP - Khách VIP)

Cập nhật thông tin

Các kiểu dữ liệu​

Có bốn kiểu dữ liệu được hỗ trợ: văn bản, số, ngày và boolean:

  • Văn bản (ví dụ: 'VIP').
  • Số (ví dụ: 123).
  • Boolean (ví dụ: 'true' hoặc 'false').
  • Ngày (chúng tôi hỗ trợ cả mốc thời gian bằng mili giây và định dạng ISO 8601, ví dụ: '2023-05-02T00:00:00+00:00').