Главная / Продукты / API / HTTP Attendance API
API

HTTP Attendance API

Единый HTTPS-вход для любого клиента, формирующего данные посещаемости. HTTP Attendance API аутентифицирует по серийному номеру устройства и токену, а затем направляет каждую распознанную отметку в тот же конвейер хранения и отправки клиенту, что и каждый собственный движок Cams.

Обзор

Независимая от устройств HTTPS-точка входа для приёма отметок посещаемости, heartbeat-сигналов и проверок подписки от любого клиента.

HTTP Attendance 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 с одним распознанным событием посещаемости: пользователь, время, состояние IN/OUT, тип ввода и необязательное местоположение.

Сообщение о присутствии

Отправьте heartbeat, чтобы пометить устройство как онлайн, без тела запроса.

Проверка действительности

Узнайте, активна ли подписка на учёт посещаемости устройства, прежде чем отправлять данные.

Единый конвейер

Каждая отметка попадает в тот же путь хранения и отправки, что и собственный приём по TCP и MQTT.

Функции

Всё включено

  • Единый вход HTTPS для edge-, мобильных, веб- и гибридных клиентов по пути /api/attendance/v1/{op}
  • Аутентификация по заголовкам: серийный номер устройства (sn) плюс auth-token, с проверкой подписки
  • endpoint punch принимает распознанное событие посещаемости (пользователь, время, IN/OUT, тип ввода, необязательная геолокация)
  • endpoint heartbeat помечает устройство как онлайн для отслеживания присутствия
  • endpoint validity возвращает актуальный статус подписки до отправки данных клиентом
  • Общий конвейер: то же хранение и отправка на сервер клиента, что и у собственных движков
  • Единый контракт ошибок JSON для отсутствующего серийного номера, неизвестного устройства, неверного токена или неактивной подписки
  • Работает за nginx с ограничением размера тела запроса и лимитами частоты запросов

Создавайте с HTTP Attendance API

Получите ключ, изучите документацию и запускайте. Наша команда поможет с первой интеграцией.

FAQ

Частые вопросы

Что делает HTTP Attendance API?

Это независимая от устройств точка входа, которая принимает распознанные отметки посещаемости, heartbeat-сигналы и проверки подписки, аутентифицирует их по серийному номеру устройства и токену и передаёт в общий конвейер посещаемости Cams.

Как аутентифицируются запросы?

Каждый запрос содержит заголовок серийного номера устройства (sn) и заголовок auth-token; оба должны быть действительными. Для биометрических endpoint дополнительно требуется активная подписка на учёт посещаемости.

Обрабатывается ли посещаемость по HTTP так же, как с устройств?

Да. Отметки попадают в тот же конвейер, что используют собственные движки HTTP, TCP и MQTT, поэтому хранение и последующая отправка одинаковы независимо от транспорта.

Связанное

Узнайте больше о платформе