Integration API — Overview

Integration API is designed for integrating external services with the Faceter video surveillance platform.

Base URL

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

The current API version uses routes with the /v1 prefix.

Main Capabilities

• get camera information
• get a list of available cameras
• get available archive interval information
• get an archive clip (synchronous mode)
• export archive (asynchronous mode)
• export audio (asynchronous mode)
• get camera events
• create a camera event

Creating an Integration

Before using Integration API, you must create an integration in the Faceter interface. You will then receive an Integration Key.

Using the Integration Key

The Integration Key is passed in the header of every request:

X-Integration-Key: YOUR_INTEGRATION_KEY

Example request:

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

Error Format

The API uses the ProblemDetails standard (RFC 9457).

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

Typical Usage Scenario

1. Validate the Integration Key

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

2. Get the camera list

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

3. Start an archive export

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. Check export status

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