Trạng thái hệ thống

Endpoint cung cấp trạng thái hiện thời của tất cả dịch vụ CareSoft được giám sát. Dữ liệu đã được gộp & rút gọn, sẵn sàng cho hệ thống giám sát của khách hàng.

GET /https://status.caresoft.vn/api/v1/heartbeat

Endpoint cung cấp trạng thái hiện thời của tất cả dịch vụ CareSoft được giám sát.

1. Yêu cầu (HTTP Request)

Thuộc tính	Giá trị
Phương thức	GET
Đường dẫn	https://status.caresoft.vn/api/v1/heartbeat
Tham số query	pretty (tùy chọn) – trả JSON có thụt dòng (dễ đọc thủ công).
Header	Không bắt buộc

Ví dụ

GET https://status.caresoft.vn/api/v1/heartbeat

2. Phản hồi (HTTP Response)

2.1. Mã trạng thái

Mã	Ý nghĩa
200 OK	Thành công & trả về JSON hợp lệ.
502 Bad Gateway	Dữ liệu tạm thời chưa có.

2.2. Headers nổi bật

Header	Kiểu	Mô tả
Content-Type	application/json	Luôn là JSON UTF‑8.
X-Cache-Generated	RFC3339 timestamp	Thời điểm dữ liệu vừa được hệ thống tổng hợp.

2.3. Nội dung (JSON)

{
  "generated_at": "2025-07-21 12:15:03",
  "title": "CareSoft",
  "monitors": [
    {
      "id": 1,
      "name": "WEB_APP V2",
      "status": 1,
      "last_ping_ms": 29,
      "last_heartbeat": "2025-07-21 05:06:51.208",
      "uptime_24h": 1.0
    }
    /* …các monitor khác (nếu có) … */
  ]
}

Trường	Kiểu	Giải thích
generated_at	string	Thời điểm hệ thống tạo bản ghi này.
title	string	Tên cụm dịch vụ.
monitors	array<Monitor>	Danh sách tất cả dịch  vụ đang public giám sát.
id	int	Định danh dịch vụ.
name	string	Tên thân thiện của dịch vụ.
status	int (1 = UP, 0 = DOWN)	Trạng thái mới nhất.
last_ping_ms	int	Thời gian phản hồi (millisecond) của heartbeat cuối.
last_heartbeat	string	Thời điểm heartbeat cuối (theo múi giờ server).
uptime_24h	float (0 – 1)	Tỉ lệ uptime 24 giờ qua (1 = 100%).

3. Ví dụ sử dụng

3.1. cURL

curl https://status.caresoft.vn/api/v1/heartbeat | jq .

3.2. JavaScript

fetch('https://status.caresoft.vn/api/v1/heartbeat')
  .then(r => r.json())
  .then(({ monitors }) => {
    monitors.forEach(m => {
      console.log(`${m.name}: ${m.status ? 'UP ✅' : 'DOWN ❌'} (${m.last_ping_ms}ms)`);
    });
  });

4. Cập nhật API

Phiên bản	Thay đổi
1.0 (07‑2025)	Phát hành lần đầu.