Cấu hình cửa hàng
Setting Object Schema
Đối tượng đại diện cho một dòng cấu hình (group + key) của cửa hàng
Mỗi cấu hình của cửa hàng được lưu thành một dòng riêng, xác định duy nhất bởi cặp group + key trong phạm vi công ty. Danh sách các key cấu hình theo công ty (email/SMTP, theme storefront, SSO khách hàng, URL ứng dụng...) xem tại Danh sách key cấu hình.
JSON Schema
| Trường (Field) | Kiểu (Type) | Mô tả (Description) |
|---|---|---|
company_id | int | ID công ty |
creator_id | int | ID người cập nhật gần nhất |
id | int | ID dòng cấu hình |
group | string | Nhóm cấu hình (chỉ gồm a-z, 0-9, _). Ví dụ: email, website, customer_sso, system |
key | string | Tên key cấu hình (chỉ gồm a-z, 0-9, _) |
value | string | Giá trị cấu hình (luôn là chuỗi). Với key chỉ ghi (secret) luôn trả về *** |
value_extra | string | Giá trị mở rộng (dùng cho nội dung dài như mẫu in). Với key chỉ ghi, nếu có giá trị cũng trả về *** |
note | string | Ghi chú |
ip_address | string | IP của lần cập nhật gần nhất |
date_created | int | Thời gian tạo (Unix timestamp) |
date_modified | int | Thời gian cập nhật (Unix timestamp) |
Che giá trị bí mật
| Loại key | Quy tắc trả về |
|---|---|
Key chỉ ghi: smtp_password, customer_sso_remote_api_token | value luôn là *** với mọi người dùng, kể cả người có quyền company.setting. Không có API nào đọc lại được giá trị thật |
Key có tên chứa key, secret, password, token | value là *** nếu người gọi không có quyền company.setting |
| Các key còn lại | Trả về giá trị thật |
Lưu ý
Khi gửi lại form cấu hình qua Lưu cấu hình, nếu value của key chỉ ghi là *** thì hệ thống giữ nguyên giá trị đang lưu. Muốn xoá secret, gửi chuỗi rỗng "".
Ví dụ
{
"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
}