ONEPOS

Tích hợp API

OnePos API Reference v1

Tích hợp API

API REST của OnePos giúp kết nối CRM, tổng đài, website và quản lý bán hàng với hệ thống nội bộ (ERP, BI, app mobile). Phản hồi JSON, xác thực Bearer token, tương thích mô hình tài liệu REST phổ biến.

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
Cần mở khóa API cho tenant? Liên hệ OnePos để được cấp API key và môi trường sandbox.

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

Ý nghĩa
200Thành công
400Thiếu/sai tham số
401Token không hợp lệ
404Không tìm thấy tài nguyên
429Vượt giới hạn request
500Lỗ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

MethodEndpointMô tả
GET/crm/contactsDanh sách khách hàng
POST/crm/contactsTạo khách hàng
GET/crm/leadsDanh sách lead
GET/crm/dealsPipeline & deal
POST/crm/activitiesGhi 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

MethodEndpointMô tả
GET/call/extensionsDanh sách máy lẻ
GET/call/cdrsLịch sử cuộc gọi (CDR)
GET/call/activeCuộc gọi đang diễn ra
POST/call/click-to-callClick-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

MethodEndpointMô tả
GET/sales/ordersĐơn hàng
POST/sales/ordersTạo đơn
GET/sales/productsSản phẩm & SKU
GET/sales/inventoryTồ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ới
  • call.cdr.completed — kết thúc cuộc gọi
  • sales.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).

Yêu cầu API key
TƯ VẤN NGAY028 7107 9999
ZaloMessenger