Skip to content

Kiểm Tra Trạng Thái Hệ Thống: GET /v1/health

Endpoint công khai giúp giám sát tình trạng hoạt động (Health Check) của Gateway và kiểm tra kết nối tới các dịch vụ Shopee & TikTok.


Thông Tin Endpoint

  • Phương thức: GET
  • Đường dẫn: /v1/health
  • Xác thực: Không yêu cầu (Public)
  • Chi phí: 0 quota

1. Ví Dụ Request

bash
curl -X GET "https://api.yourdomain.com/v1/health"

2. Cấu Trúc Response Trả Về

Trạng thái bình thường (200 OK):

json
{
  "ok": true,
  "upstreams": {
    "shopee": true,
    "tiktok": true
  }
}
  • ok: true khi cả Gateway và các dịch vụ sàn đều sẵn sàng xử lý yêu cầu.
  • upstreams.shopee: Kết nối tới sàn Shopee (true/false).
  • upstreams.tiktok: Kết nối tới sàn TikTok (true/false).

Ứng dụng thực tế:

  • Cấu hình làm endpoint kiểm tra trạng thái trong Docker / Kubernetes Healthcheck probe.
  • Tích hợp vào các công cụ giám sát Uptime (UptimeRobot, BetterUptime, Datadog).

ImageCoreAPI — Cổng API tìm kiếm hình ảnh Shopee & TikTok Shop