📌 HƯỚNG DẪN GỌI API THÔNG BÁO ĐỒNG BỘ DỮ LIỆU

1. Mục đích

API này dùng để thông báo cho hệ thống dữ liệu đã thay đổi, cần đồng bộ.

2. Thông tin endpoint

• Method: POST
• URL: https://data.sonla.gov.vn/api/data/sync

3. Header bắt buộc

X-API-KEY: your_api_key_here

📌 Lưu ý:

• Bắt buộc phải truyền X-API-KEY trong header
• API Key sẽ được cấp riêng cho từng đơn vị

4. Cách sử dụng

Chỉ cần gửi request lên API với header hợp lệ, không cần truyền body.

Header yêu cầu:

• X-API-KEY: API Key được cấp

• Authorization: Basic Auth từ tài khoản đăng tải dữ liệu (username:password đã encode base64)

• Content-Type: application/json

Ví dụ: 

curl --location 'https://data.sonla.gov.vn//api/data/sync' \

--header 'X-API-KEY: ****' \

--header 'Content-Type: application/json' \

--header 'Authorization: Basic ****' \

5. Quy định tần suất gọi

• Mỗi lần gọi API phải cách nhau tối thiểu 5 phút
• Nếu gọi sớm hơn sẽ bị từ chối

6. Kết quả trả về

✔️ Thành công

{
"success": true,
"message": "Đồng bộ dữ liệu thành công"
}

❌ Các lỗi thường gặp

Thiếu API Key

{
"error_code": 401,
"message": "X-API-KEY là bắt buộc trong header"
}

API Key không hợp lệ

{
"error_code": 403,
"message": "API Key không hợp lệ"
}

Gọi quá nhanh (< 5 phút)

{
"error_code": 429,
"message": "Vui lòng thử lại sau 5 phút",
"next_sync_time": "YYYY-MM-DD HH:mm:ss"
}

Có lỗi trong quá trình xử lý

{
"error_code": 500,
"message": "Có lỗi xảy ra trong quá trình đồng bộ"
}

7. Lưu ý quan trọng

• 🔑 Không chia sẻ API Key ra ngoài
• ⏱️ Tuân thủ thời gian gọi API (≥ 5 phút/lần)
• 🌐 Đảm bảo server có thể gọi được API