모든 기기를 위한 하나의 규격. 다섯 가지 기능 그룹에 걸친 38개 작업을 동기식 REST 호출과 실시간 Callback webhook으로 사용할 수 있습니다.
모든 REST 호출은 버전이 지정된 단일 호스트로 전송됩니다.
https://api.camsbiometrics.com/v3/
모든 요청에는 계정과 기기 범위로 제한된 AuthToken가 포함됩니다. 키는 개발자 포털에서 발급됩니다.
Form 인코딩 또는 JSON 요청을 지원합니다. 응답은 예측 가능한 필드와 오류 코드를 갖춘 JSON입니다.
두 가지 연동 방식
게이트웨이를 호출하면 즉시 응답을 받습니다. 출퇴근 기록 조회, 사용자 목록 확인, 사용자 등록, 필요 시 문 열기에 적합합니다.
URL을 등록하면 기기가 이벤트를 보고하는 즉시 게이트웨이가 푸시합니다. 폴링이 필요 없으며, 실패 시 자동으로 재시도합니다.
작업
기능별로 분류되어 있습니다. 이름은 게이트웨이 엔드포인트와 1:1로 대응됩니다.
계정 전체에서 지정한 기간 내의 모든 출퇴근 기록.
특정 기간 동안 한 사원 코드의 로그.
하나의 기기 시리얼 번호에서 캡처된 출퇴근 기록.
일별, 사원별 요약(출근/퇴근, 근무 시간).
사원별 일일 최초 출근/최종 퇴근 쌍.
오늘의 출퇴근 기록 실시간 스냅샷.
지원되는 경우 출퇴근 기록에 첨부된 캡처 사진.
급여 및 대조를 위한 대량 내보내기.
하나 이상의 기기에 사용자를 생성합니다.
이름, 역할, 유효 기간 또는 권한을 수정합니다.
기기에서 사용자를 삭제합니다.
코드로 사용자를 조회하며, 자격 증명도 선택적으로 포함할 수 있습니다.
기기에 등록된 모든 사용자를 나열합니다.
사용자가 등록된 기기를 확인합니다.
지문 템플릿을 기기로 푸시합니다.
지원되는 경우 얼굴 템플릿을 등록합니다.
사용자에게 RFID / 근접 카드를 할당합니다.
기기 PIN / 비밀번호를 설정하거나 변경합니다.
기기 간에 사용자와 템플릿을 복제합니다.
사용자 데이터를 기기 대기열로 다시 전달합니다.
문 릴레이, 회전식 게이트, 플랩, 스윙, 차단기를 실시간으로 작동시킵니다.
제어 하에 문을 잠그거나 유지합니다.
현재 열림 / 닫힘 상태를 확인합니다.
시간대별 출입 허용 구간을 정의합니다.
입장 / 퇴장 및 출입문 이벤트 로그.
연결된 모든 기기의 목록.
모델, 펌웨어, 용량, 카운터.
온라인 상태, 마지막 접속 시각, 대기열 깊이.
기기의 연결 가능 여부를 즉시 확인합니다.
기기 시계를 서버와 맞춥니다.
기기를 원격으로 재시작합니다.
대기열에 멈춰 있는 명령을 삭제합니다.
대기열에 있는 명령의 상태를 추적합니다.
실시간 이벤트를 받을 webhook URL을 구독합니다.
모든 출퇴근 기록마다 실시간으로 발생합니다.
온라인 / 오프라인 및 상태 전환.
템플릿이 기기에 반영되었을 때의 확인 알림.
대량 기기 / 데이터 마이그레이션 진행 상황을 추적합니다.
예측 가능한 응답
| 코드 | 의미 | 대응 방법 |
|---|---|---|
200 | 성공 | JSON 페이로드를 처리하세요. |
401 | AuthToken이 잘못되었거나 누락됨 | API 키와 기기 페어링을 확인하세요. |
404 | 기기 또는 사용자를 찾을 수 없음 | 시리얼 번호 / 사원 코드를 확인하세요. |
409 | 기기 오프라인 / 대기열 등록됨 | 명령이 대기열에 등록되었습니다. GetCommandStatus를 폴링하세요. |
429 | 요청 한도 초과 | 대기 후 지터(jitter)를 적용해 재시도하세요. |
트래픽을 측정하고 BiometricAPI.com을 개선하기 위해 쿠키를 사용합니다. 동의하기 전까지 분석은 꺼져 있습니다. 자세히 알아보기.