Response Format
Cấu trúc response chuẩn của API iNET
Tất cả API của iNET trả về JSON với cấu trúc wrapper nhất quán. Dữ liệu thực tế nằm trong field data.
Response thành công
JSON
{
"success": true,
"data": {
"domainName": "inet.vn",
"available": "unavailable"
},
"meta": {
"request_id": "req_abc123",
"latency_ms": 245,
"endpoint": "/domain/check",
"timestamp": "2026-03-31T08:00:00.000Z"
}
}
Các field chính
| Field | Kiểu | Mô tả |
|---|---|---|
success | boolean | true nếu thành công |
data | object/array | Kết quả thao tác trả về |
meta | object | Thông tin request (request_id, latency, ...) |
Lưu ý: Cấu trúc response trong tài liệu mô tả chi tiết nội dung phân giải trong field data. Khi gọi API, dữ liệu cuối cùng nằm trong biến response.data.
Meta fields
| Field | Kiểu | Mô tả |
|---|---|---|
request_id | string | ID duy nhất của request (dùng để debug/support) |
latency_ms | number | Thời gian xử lý (milliseconds) |
endpoint | string | Endpoint đã gọi |
timestamp | string | Thời điểm xử lý (ISO 8601) |
Response lỗi
JSON
{
"success": false,
"data": null,
"meta": {
"request_id": "req_xyz789",
"endpoint": "/domain/check",
"timestamp": "2026-03-31T08:00:01.000Z"
}
}
Lỗi do hệ thống từ chối (xác thực sai, quá giới hạn truy cập, tham số không hợp lệ):
JSON
{
"error": "Trường 'name' là bắt buộc",
"statusCode": 400
}
Ví dụ truy cập data
curl -H "Authorization: Bearer YOUR_API_KEY" \
"https://developers.inet.vn/api/gateway/v1/domain/check?name=mysite.vn"Pagination (nếu có)
Một số endpoint trả danh sách phân trang (vd: /domain, /email). Dữ liệu phân trang nằm trong data:
JSON
{
"success": true,
"data": {
"number": 0,
"size": 20,
"totalPages": 5,
"totalElements": 42,
"content": [
{ "id": 1, "name": "example.vn", "status": "active" }
]
}
}
| Field | Kiểu | Mô tả |
|---|---|---|
data.content | array | Danh sách items |
data.number | integer | Trang hiện tại (0-based) |
data.size | integer | Số items mỗi trang |
data.totalPages | integer | Tổng số trang |
data.totalElements | integer | Tổng số items |
Content-Type
- Request:
Content-Type: application/json(với POST/PUT/PATCH) - Response: luôn trả về
application/json
CORS
API hỗ trợ CORS cho tất cả domain. Bạn có thể gọi API trực tiếp từ browser (frontend JavaScript).
Encoding
- Request và response đều sử dụng UTF-8
- Tên miền có dấu (IDN) được hỗ trợ — API tự động xử lý Punycode