Tên miền website
Website của cửa hàng
Lấy địa chỉ website của cửa hàng: tên miền con, tên miền riêng và cấu hình DNS
Chỉ có trên Hubport SaaS
Trên bản cài đặt riêng (máy chủ riêng), endpoint trả HTTP 404 error_saas_mode_inactive.
Endpoint
GET /v1/platformdomains
Yêu cầu đăng nhập. Luôn trả dữ liệu của cửa hàng đang đăng nhập (không nhận company_id từ request). Không cần tính năng
custom_domain: cửa hàng chưa có tính năng vẫn xem được tên miền con và tên miền đã thêm.
Response Schema
HTTP 200 - JSON Object
| Trường | Kiểu | Mô tả |
|---|---|---|
company_id | int | ID cửa hàng |
subdomain | object | Tên miền con miễn phí (bảng dưới) |
primary_url | string | Địa chỉ chính của website: URL tên miền riêng đang active, nếu không thì URL tên miền con |
suspended | bool | Cửa hàng đang bị khoá: khách truy cập website thấy trang "Cửa hàng tạm ngưng hoạt động" |
custom_domain_feature | bool | Gói hiện tại có tính năng tên miền riêng (custom_domain) |
domains | array | Danh sách Domain Object, cũ trước |
config | object | Cấu hình DNS chung (bảng dưới) |
subdomain
| Trường | Kiểu | Mô tả |
|---|---|---|
host | string | Tên miền con, vd tencuahang.hubport.com.vn; rỗng nếu không có |
url | string | URL tên miền con, rỗng nếu không có |
available | bool | Cửa hàng có tên miền con |
reason | string | Khi available = false: suffix_not_configured (hệ thống chưa cấu hình đuôi tên miền con) hoặc screenname_invalid (screenname không dùng được làm tên miền con, liên hệ Hubport để đổi) |
screenname | string | Mã định danh cửa hàng |
config
| Trường | Kiểu | Mô tả |
|---|---|---|
cname_target | string | Đích CNAME cho tên miền riêng |
apex_ips | array of string | IP cho bản ghi A của tên miền gốc |
max_domains | int | Số tên miền riêng tối đa mỗi cửa hàng |
Error Codes
| HTTP | Mã lỗi | Mô tả |
|---|---|---|
| 403 | error_company_required | Phiên đăng nhập không gắn với cửa hàng nào |
| 404 | error_saas_mode_inactive | Không phải Hubport SaaS |
Ví dụ
curl -X GET "https://api.hubport.vn/v1/platformdomains" \
-H "Authorization: <JWT>"{
"company_id": 12,
"subdomain": {
"host": "tencuahang.hubport.com.vn",
"url": "https://tencuahang.hubport.com.vn",
"available": true,
"reason": "",
"screenname": "tencuahang"
},
"primary_url": "https://www.shopcuatoi.vn",
"suspended": false,
"custom_domain_feature": true,
"domains": [
{
"id": 1003,
"domain": "www.shopcuatoi.vn",
"apex": "shopcuatoi.vn",
"url": "https://www.shopcuatoi.vn",
"status": "active",
"source": "shop",
"verified": true,
"redirect_subdomain": true,
"txt_ok": true,
"routing_ok": true,
"apex_ok": true,
"tls_ok": true,
"warnings": [],
"last_error": "",
"verified_at": 1760317500,
"active_at": 1760318400,
"last_check_at": 1760340000,
"next_check_at": 1760361600,
"cert_not_after": 1768094400,
"dns": {
"records": [
{"purpose": "verify", "type": "TXT", "name": "_hubport.shopcuatoi.vn", "host": "_hubport", "value": "hubport-verify=3f9c0a1b2c3d4e5f60718293a4b5c6d7", "ok": true},
{"purpose": "route", "type": "CNAME", "name": "www.shopcuatoi.vn", "host": "www", "value": "shops.hubport.com.vn", "ok": true},
{"purpose": "apex", "type": "A", "name": "shopcuatoi.vn", "host": "@", "value": "203.0.113.10", "ok": true}
],
"cname_target": "shops.hubport.com.vn",
"apex_ips": ["203.0.113.10"],
"registrable": "shopcuatoi.vn"
},
"found": {},
"date_created": 1760317200
}
],
"config": {
"cname_target": "shops.hubport.com.vn",
"apex_ips": ["203.0.113.10"],
"max_domains": 1
}
}