홈 / 제품 / API / HTTP 출퇴근 API
API

HTTP 출퇴근 API

출퇴근 데이터를 생성하는 모든 클라이언트를 위한 단일 HTTPS 진입점. HTTP 출퇴근 API는 기기 시리얼 번호와 토큰으로 인증한 뒤, 인식된 모든 출퇴근 기록을 모든 기본 Cams 엔진과 동일한 저장 및 고객 푸시 파이프라인으로 전달합니다.

개요

모든 클라이언트의 출퇴근 기록, 하트비트, 구독 확인을 수집하는 기기 독립적인 HTTPS 진입점입니다.

HTTP 출퇴근 API는 /api/attendance/v1/{op} 경로의 기기 독립적인 진입점입니다. 기기 시리얼 번호(sn)와 auth-token 헤더로 각 요청을 인증한 뒤 데이터를 수집합니다. punch(인식된 출퇴근 이벤트 하나), heartbeat(기기 접속 상태), validity(구독 확인), config를 제공합니다. 출퇴근 기록은 공유 파이프라인으로 전달되어 기본 HTTP, TCP, MQTT 전송 방식과 동일한 저장 및 고객 서버 푸시가 이루어지므로, 출퇴근 데이터가 어떤 경로로 들어오든 연동 방식은 일관되게 유지됩니다.

APIRESTHTTPSJSONC++
POST /api/attendance/v1/punch
curl https://api.camsbiometrics.com/api/attendance/v1/punch \
  -H "sn: SN7A2300583" -H "auth-token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "user_id":"1001", "att_time":"2026-06-21 09:30:00",
        "att_state":1, "input_type":50 }'
# -> 200 {"ok":true}

기능

할 수 있는 일

출퇴근 기록 수집

사용자, 타임스탬프, 출근/퇴근 상태, 입력 유형, 선택적 위치 정보와 함께 인식된 출퇴근 이벤트 하나를 POST합니다.

접속 상태 보고

본문 없이 하트비트를 보내 기기를 온라인으로 표시합니다.

유효성 확인

데이터를 보내기 전에 기기의 출퇴근 구독이 활성 상태인지 조회합니다.

통합 파이프라인

모든 출퇴근 기록이 기본 TCP 및 MQTT 수집과 동일한 저장 및 푸시 경로로 전달됩니다.

주요 기능

모두 포함

  • /api/attendance/v1/{op}에서 엣지, 앱, 웹, 하이브리드 클라이언트를 위한 단일 HTTPS 진입점
  • 헤더 기반 인증: 기기 시리얼 번호(sn)와 auth-token, 구독 확인 포함
  • punch 엔드포인트가 인식된 출퇴근 이벤트(사용자, 시간, 출근/퇴근, 입력 유형, 선택적 위치 정보)를 수집
  • heartbeat 엔드포인트가 접속 상태 추적을 위해 기기를 온라인으로 표시
  • validity 엔드포인트가 클라이언트가 데이터를 보내기 전에 실시간 구독 상태를 반환
  • 공유 파이프라인: 기본 엔진과 동일한 저장 및 고객 서버 푸시
  • 시리얼 누락, 알 수 없는 기기, 잘못된 토큰, 비활성 구독에 대한 일관된 JSON 오류 규격
  • 본문 크기 제한과 요청 속도 제한을 갖춘 nginx 프런트

HTTP 출퇴근 API로 개발하기

키를 발급받고, 문서를 읽고, 배포하세요. 첫 연동은 저희 팀이 도와드립니다.

FAQ

자주 묻는 질문

HTTP 출퇴근 API는 무엇을 하나요?

인식된 출퇴근 기록, 하트비트, 구독 확인을 받아 기기 시리얼 번호와 토큰으로 인증하고, 공유 Cams 출퇴근 파이프라인으로 전달하는 기기 독립적인 진입점입니다.

요청은 어떻게 인증하나요?

모든 요청에는 기기 시리얼 번호(sn) 헤더와 auth-token 헤더가 포함되어야 하며, 둘 다 유효해야 합니다. 생체인식 엔드포인트는 추가로 활성 출퇴근 구독이 필요합니다.

HTTP로 들어온 출퇴근 데이터도 기기에서 들어온 것과 동일하게 처리되나요?

네. 출퇴근 기록은 기본 HTTP, TCP, MQTT 엔진이 사용하는 동일한 파이프라인으로 전달되므로, 전송 방식과 관계없이 저장과 다운스트림 푸시가 동일합니다.

관련 항목

플랫폼 더 둘러보기