Integration API — Обзор

Integration API предназначен для интеграции внешних сервисов с платформой видеонаблюдения Faceter.

Базовый URL

https://cloud.faceter.cam/integration-api

Актуальная версия API использует маршруты с префиксом /v1.

Основные возможности

• получение информации о камере
• получение списка доступных камер
• получение информации о доступных интервалах архива
• получение фрагмента архива (синхронный режим)
• экспорт архива (асинхронный режим)
• экспорт аудио (асинхронный режим)
• получение событий камеры
• создание события камеры

Создание интеграции

Перед использованием Integration API необходимо создать интеграцию в интерфейсе Faceter. После этого будет выдан Integration Key.

Использование Integration Key

Integration Key передаётся в заголовке каждого запроса:

X-Integration-Key: YOUR_INTEGRATION_KEY

Пример запроса:

curl -X GET \
  "https://cloud.faceter.cam/integration-api/v1/cameras/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "X-Integration-Key: YOUR_INTEGRATION_KEY"

Формат ошибок

API использует стандарт ProblemDetails (RFC 9457).

{
  "type": "string",
  "title": "Not Found",
  "status": 404,
  "detail": "Camera not found",
  "instance": "string"
}

Типовой сценарий работы

1. Проверить Integration Key

curl -X POST \
  "https://cloud.faceter.cam/integration-api/v1/integration-key/validate" \
  -H "X-Integration-Key: YOUR_INTEGRATION_KEY"

2. Получить список камер

curl -X GET \
  "https://cloud.faceter.cam/integration-api/v1/cameras" \
  -H "X-Integration-Key: YOUR_INTEGRATION_KEY"

3. Запустить экспорт архива

curl -X POST \
  "https://cloud.faceter.cam/integration-api/v1/cameras/{cameraId}/archive/exports" \
  -H "Content-Type: application/json" \
  -H "X-Integration-Key: YOUR_INTEGRATION_KEY" \
  -d '{
    "startDate": "2026-04-10T08:00:00Z",
    "durationSeconds": 120,
    "audioEnabled": true,
    "callbackUrl": "https://example.com/webhook"
  }'

4. Проверить статус экспорта

curl -X GET \
  "https://cloud.faceter.cam/integration-api/v1/cameras/{cameraId}/archive/exports/{exportId}" \
  -H "X-Integration-Key: YOUR_INTEGRATION_KEY"