HiTechCloud CRM API
HiTechCloud CRM: bộ REST API quản lý quan hệ khách hàng — liên hệ, công ty, cơ hội bán hàng, pipeline, hoạt động, ghi chú và webhook thời gian thực.
HiTechCloud CRM API là giao diện lập trình RESTful giúp bạn đồng bộ danh bạ khách hàng, quản lý cơ hội bán hàng và tự động hoá quy trình chăm sóc khách hàng từ website, tổng đài, ERP hay phần mềm kế toán của mình. Toàn bộ dữ liệu liên hệ, công ty, giao dịch và hoạt động đều có thể đọc/ghi qua API và nhận cập nhật tức thời qua webhook.
Các nhóm tính năng chính
Sơ đồ kết nối
Ứng dụng của bạn gọi HiTechCloud CRM API qua HTTPS bằng Authorization: Bearer. API đọc/ghi vào các tài nguyên liên hệ, cơ hội và pipeline rồi trả về khung phản hồi JSON.
Khi dữ liệu thay đổi, HiTechCloud ký thân yêu cầu bằng HMAC-SHA256 (header X-CRM-Signature) rồi gửi HTTP POST tới URL webhook của bạn. Hãy xác minh chữ ký trước khi xử lý.
Môi trường và Base URLs
| Môi trường | Base URL | Mô tả |
|---|---|---|
| Production (Chính thức) | https://crm-gateways.hitechcloud.vn | Dữ liệu khách hàng thật |
| Sandbox (Thử nghiệm) | https://crm-gateways-sandbox.hitechcloud.vn | Môi trường test với dữ liệu mô phỏng độc lập |
| Webhook base | https://crm-gateways.hitechcloud.vn/webhook | Điểm cuối đăng ký và nhận sự kiện |
Quy ước định danh tài nguyên
Mỗi loại tài nguyên có tiền tố định danh riêng để dễ nhận biết trong log và webhook:
| Tài nguyên | Tiền tố ID | Ví dụ |
|---|---|---|
| Liên hệ (Contact) | con_ | con_8f2a1c9d |
| Công ty (Company) | co_ | co_4b7e2f10 |
| Cơ hội (Deal) | deal_ | deal_a19c330e |
| Pipeline / Giai đoạn | pl_ / stg_ | pl_sales, stg_qualified |
| Hoạt động (Activity) | act_ | act_77de9012 |
| Ghi chú (Note) | note_ | note_15aa6b3c |
Định dạng khung phản hồi
Mọi phản hồi tuân theo cấu trúc khung phản hồi JSON nhất quán: trường status, data và meta (chứa phân trang khi là danh sách).
{
"status": "success",
"data": [],
"meta": {
"pagination": {
"total": 100,
"per_page": 20,
"current_page": 1,
"last_page": 5,
"has_more": true
}
}
}/v1/ và yêu cầu header Authorization: Bearer <access_token>. Xem trang Xác thực để lấy token.HiTechCloud CRM API là giao diện lập trình RESTful giúp bạn đồng bộ danh bạ khách hàng, quản lý cơ hội bán hàng và tự động hoá quy trình chăm sóc khách hàng từ website, tổng đài, ERP hay phần mềm kế toán của mình. Toàn bộ dữ liệu liên hệ, công ty, giao dịch và hoạt động đều có thể đọc/ghi qua API và nhận cập nhật tức thời qua webhook.
Các nhóm tính năng chính
Sơ đồ kết nối
Ứng dụng của bạn gọi HiTechCloud CRM API qua HTTPS bằng Authorization: Bearer. API đọc/ghi vào các tài nguyên liên hệ, cơ hội và pipeline rồi trả về khung phản hồi JSON.
Khi dữ liệu thay đổi, HiTechCloud ký thân yêu cầu bằng HMAC-SHA256 (header X-CRM-Signature) rồi gửi HTTP POST tới URL webhook của bạn. Hãy xác minh chữ ký trước khi xử lý.
Môi trường và Base URLs
| Môi trường | Base URL | Mô tả |
|---|---|---|
| Production (Chính thức) | https://crm-gateways.hitechcloud.vn | Dữ liệu khách hàng thật |
| Sandbox (Thử nghiệm) | https://crm-gateways-sandbox.hitechcloud.vn | Môi trường test với dữ liệu mô phỏng độc lập |
| Webhook base | https://crm-gateways.hitechcloud.vn/webhook | Điểm cuối đăng ký và nhận sự kiện |
Quy ước định danh tài nguyên
Mỗi loại tài nguyên có tiền tố định danh riêng để dễ nhận biết trong log và webhook:
| Tài nguyên | Tiền tố ID | Ví dụ |
|---|---|---|
| Liên hệ (Contact) | con_ | con_8f2a1c9d |
| Công ty (Company) | co_ | co_4b7e2f10 |
| Cơ hội (Deal) | deal_ | deal_a19c330e |
| Pipeline / Giai đoạn | pl_ / stg_ | pl_sales, stg_qualified |
| Hoạt động (Activity) | act_ | act_77de9012 |
| Ghi chú (Note) | note_ | note_15aa6b3c |
Định dạng khung phản hồi
Mọi phản hồi tuân theo cấu trúc khung phản hồi JSON nhất quán: trường status, data và meta (chứa phân trang khi là danh sách).
/v1/ và yêu cầu header Authorization: Bearer <access_token>. Xem trang Xác thực để lấy token.{
"status": "success",
"data": [],
"meta": {
"pagination": {
"total": 100,
"per_page": 20,
"current_page": 1,
"last_page": 5,
"has_more": true
}
}
}