Health Check
Vendor API 서버의 상태를 확인합니다. 연동 시스템의 정상 동작 여부를 모니터링하는 데 사용합니다.
Endpoint
GET /vendor-api/health요청 파라미터
파라미터 없음. 인증 헤더(X-Vendor-Api-Key, X-Vendor-Id)는 필수입니다.
요청 예시
curl -X GET "https://brightmall-backend.certi.life/vendor-api/health" \
-H "X-Vendor-Api-Key: bm_xOpGAqgHbJQBXxBBbUIZ_bAGZk4wK2FdLgF50277PU8" \
-H "X-Vendor-Id: 01KC51ST1WSTAET481SHPH3PSY"응답 예시
{
"status": "ok",
"timestamp": "2026-01-22T06:50:00.000Z"
}응답 필드 설명
| 필드 | 타입 | 설명 |
|---|---|---|
status | string | 서버 상태 (ok) |
timestamp | string | 응답 시간 (ISO 8601) |
활용 방법
- 연동 초기 설정 후 API Key와 Vendor ID가 올바르게 설정되었는지 확인하는 데 사용합니다.
- 주기적으로 호출하여 Vendor API 서버의 가용성을 모니터링할 수 있습니다.
- 인증 실패 시
401응답이 반환되므로, 인증 정보 검증용으로도 사용할 수 있습니다.
Last updated on