Cấu hình cửa hàng
Danh sách cấu hình
Lấy các dòng cấu hình của cửa hàng, lọc theo group / key
Endpoint
GET /v1/settings
Chỉ trả về cấu hình của công ty đang đăng nhập. Yêu cầu đăng nhập (JWT hoặc API Key), không yêu cầu quyền riêng; giá trị bí mật được che theo quy tắc ở Setting Object.
Query Parameters
| Tên | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
id | int | Không | Lọc theo ID dòng cấu hình |
group | string | Không | Lọc theo nhóm (exact match). Ví dụ: email, website, customer_sso, system |
key | string | Không | Lọc theo key (exact match) |
keyword | string | Không | Tìm theo key, giá trị hoặc ghi chú. Với key chỉ ghi (smtp_password, customer_sso_remote_api_token) chỉ khớp theo key/ghi chú, không khớp theo giá trị |
Kết quả sắp xếp theo id tăng dần, tối đa 500 dòng, không phân trang.
Response Schema
HTTP 200 - JSON Object
| Trường | Kiểu | Mô tả |
|---|---|---|
total | int | Số dòng trả về |
currentpage | int | Luôn là 1 |
limit | int | Luôn là 500 |
items | array | Mảng Setting Object |
Lưu ý
Key chưa từng được lưu sẽ không có trong items; khi đó cửa hàng đang dùng mặc định hệ thống cho key đó (xem Danh sách key cấu hình).
Ví dụ
curl -X GET "https://api.hubport.vn/v1/settings?group=email" \
-H "Authorization: <JWT>"{
"total": 3,
"currentpage": 1,
"limit": 500,
"items": [
{
"company_id": 12,
"creator_id": 3,
"id": 1048,
"group": "email",
"key": "email_custom_enable",
"value": "1",
"value_extra": "",
"note": "",
"ip_address": "203.113.10.5",
"date_created": 1760317200,
"date_modified": 1760320800
},
{
"company_id": 12,
"creator_id": 3,
"id": 1049,
"group": "email",
"key": "smtp_server",
"value": "smtp.shopabc.vn",
"value_extra": "",
"note": "",
"ip_address": "203.113.10.5",
"date_created": 1760317200,
"date_modified": 1760320800
},
{
"company_id": 12,
"creator_id": 3,
"id": 1052,
"group": "email",
"key": "smtp_password",
"value": "***",
"value_extra": "",
"note": "",
"ip_address": "203.113.10.5",
"date_created": 1760317200,
"date_modified": 1760320800
}
]
}