Giới thiệu
OnePos API được tổ chức theo REST: URL theo tài nguyên, phản hồi JSON, mã HTTP chuẩn và các động từ GET, POST, PUT, PATCH, DELETE.
- One CRM — khách hàng, lead, deal, hoạt động
- One Call — tổng đài, máy lẻ, CDR, cuộc gọi đang diễn ra
- One Web — website, form thu lead, tích hợp CRM
- One Sales — đơn hàng, sản phẩm, tồn kho
- Webhook — nhận sự kiện realtime từ OnePos
Xác thực
Dùng Bearer token trong header Authorization. Tạo và thu hồi key trong OnePos Dashboard → Cài đặt → API Keys.
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
Accept: application/json
Mọi request phải qua HTTPS. Request không có token hoặc qua HTTP sẽ bị từ chối.
Base URL & lỗi
Base path cho môi trường production:
https://api.onepos.vn/v1
Ví dụ liệt kê khách hàng CRM:
GET https://api.onepos.vn/v1/crm/contacts?limit=20
Mã lỗi HTTP
| Mã | Ý nghĩa |
|---|---|
200 | Thành công |
400 | Thiếu/sai tham số |
401 | Token không hợp lệ |
404 | Không tìm thấy tài nguyên |
429 | Vượt giới hạn request |
500 | Lỗi máy chủ OnePos |
Phân trang
Các endpoint danh sách hỗ trợ limit (mặc định 20, tối đa 100) và starting_after (UUID bản ghi trước đó) — cursor pagination.
One CRM
| Method | Endpoint | Mô tả |
|---|---|---|
GET | /crm/contacts | Danh sách khách hàng |
POST | /crm/contacts | Tạo khách hàng |
GET | /crm/leads | Danh sách lead |
GET | /crm/deals | Pipeline & deal |
POST | /crm/activities | Ghi nhận cuộc gọi / ghi chú |
POST https://api.onepos.vn/v1/crm/contacts
{
"full_name": "Nguyễn Văn A",
"phone": "0975215237",
"email": "contact@example.com",
"source": "website"
}
One Call
| Method | Endpoint | Mô tả |
|---|---|---|
GET | /call/extensions | Danh sách máy lẻ |
GET | /call/cdrs | Lịch sử cuộc gọi (CDR) |
GET | /call/active | Cuộc gọi đang diễn ra |
POST | /call/click-to-call | Click-to-call từ CRM |
Tham khảo mô hình tài liệu tổng đài REST tương tự FS PBX API (CDR, extensions, active calls).
One Sales
| Method | Endpoint | Mô tả |
|---|---|---|
GET | /sales/orders | Đơn hàng |
POST | /sales/orders | Tạo đơn |
GET | /sales/products | Sản phẩm & SKU |
GET | /sales/inventory | Tồn kho theo kho |
Webhook
Đăng ký URL nhận sự kiện POST từ OnePos (ký HMAC-SHA256 trong header X-OnePos-Signature).
crm.lead.created— lead mớicall.cdr.completed— kết thúc cuộc gọisales.order.paid— đơn thanh toán
POST https://api.onepos.vn/v1/webhooks
{
"url": "https://your-app.com/onepos/hooks",
"events": ["crm.lead.created", "call.cdr.completed"]
}
Hỗ trợ
Email kỹ thuật: contact@onepos.vn · Hotline: 0975 215 237
Khi báo lỗi API, gửi kèm request_id trong response JSON và thời điểm gọi (UTC+7).
