DÀNH CHO NHÀ PHÁT TRIỂNKiến thức có nguồn.
v1.0Kiến thức có nguồn.
Sẵn sàng tích hợp.
API JSON cho nội dung và công cụ của SODINHDANH.COM. Bản MVP công khai, có giới hạn tần suất truy cập.
| Phương thức | Đường dẫn | Chức năng |
|---|---|---|
| GET | /api/v1/entries | Nội dung đã xuất bản. Lọc kind, q; phân trang limit, offset. |
| GET | /api/v1/entries/{kind}/{slug} | Chi tiết bách khoa, thuật ngữ hoặc văn bản, kèm nguồn. |
| GET | /api/v1/administrative-units | Bộ mẫu mã hành chính. Lọc code và ngày at=YYYY-MM-DD. |
| POST | /api/v1/validate | Kiểm tra định dạng. Không lưu hoặc trả lại đầu vào. |
| GET | /api/v1/mapsviet/businesses/{taxCode} | Đối chiếu mã tổ chức với MapsViet khi đã cấu hình. |
| GET | /api/health | Tình trạng kết nối cơ sở dữ liệu và schema. |
Bắt đầu với mã hành chính
Giữ mã dưới dạng chuỗi để bảo toàn số 0 ở đầu.
fetch('/api/v1/administrative-units?code=01')
.then(response => response.json())
.then(result => console.log(result.data));Kiểm tra định dạng mã tỉnh
POST với JSON. Kết quả chỉ nói về cấu trúc, không xác nhận cấp mã.
fetch('/api/v1/validate', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ kind: 'province', value: '01' })
});60 yêu cầu/phút cho nội dung và mã hành chính; 30 cho kiểm tra định dạng; 15 cho MapsViet. Hạn mức áp dụng theo khách qua proxy tin cậy, hoặc dùng chung nếu chưa cấu hình proxy. Phản hồi 429 có Retry-After. Không bật CORS mặc định.
Trường personal của API được xử lý tạm thời trên máy chủ; giao diện công cụ dùng kiểm tra tại trình duyệt. Phản hồi lỗi có mã lỗi và requestId, không chứa mã đã nhập.