Thông tin chung
Các thuật ngữ (Glossary)
Liệt kê các thuật ngữ được sử dụng trong API Documentation.
| Thuật ngữ | Mô tả |
|---|---|
| BASE_URL | Đường dẫn gốc của các API. Với Hubport SaaS là https://api.hubport.vn; với bản cài đặt riêng là tên miền API riêng của công ty bạn, ví dụ https://api.mydomain.com (không có dấu / ở cuối) |
| Công ty / Cửa hàng (Company / Shop) | Một đơn vị kinh doanh sử dụng Hubport. Mọi dữ liệu quản trị đều thuộc về một công ty, xác định bằng company_id. |
company_id | ID của công ty (cửa hàng). Xem trong thông tin công ty ở menu Profile của trang quản trị. |
user_id / creator_id | ID tài khoản người dùng (User ID). Một tài khoản có thể là nhân viên của nhiều công ty. creator_id là User ID của người thực hiện thao tác. User ID khác với Employee ID. |
| Employee ID | ID nhân viên trong một công ty cụ thể (mỗi công ty mà tài khoản tham gia có một Employee ID riêng). |
| API Key | API Key là một cặp key (API Key và API Secret) được sử dụng để xác thực khi kết nối với API, gửi trong header Authorization dạng apikey:apisecret. |
| User Login Token | User Login Token là một token được sử dụng để xác thực khi kết nối với API. |
| JWT | Tên gọi khác của User Login Token: token nhận được khi nhân viên đăng nhập, gắn với một tài khoản và một công ty. |
| Refresh Token | Token đi kèm JWT khi đăng nhập, dùng để lấy JWT mới mà không cần đăng nhập lại. |
| SiteTenantId | Header chứa ID của công ty (cửa hàng), bắt buộc khi gọi các API ở mục "Store-front API". |