El Servicio de Camlytics proporciona una forma conveniente de acceder a eventos analíticos, informes, datos de ubicaciones y canales de forma programática.

También puede estar interesado en webhooks para métricas en tiempo real como la ocupación actual y la cola actual. Si planea recibir eventos analíticos en tiempo real, recomendamos usar webhooks.
Si está interesado en recibir de forma programática los Informes, puede optar por feeds de informes.

La autenticación para la API REST del Servicio requiere una Clave de API válida.

Las claves de API públicas y secretas se pueden encontrar en la sección de clave de API en la Configuración.

Siga los siguientes pasos para firmar su solicitud de API:

• Cree un HMAC SHA512 utilizando la clave secreta de su API y el valor de la URI de la solicitud.
• Incluya el hash resultante en su solicitud en el encabezado de solicitud X-Sign.

Ejemplo:

Javascript

const Crypto = require('crypto');
// if you use the since or/and until parameter. You should process it with encodeURIComponent function
const since = encodeURIComponent('2020-10-13T06:12:00.000+01:00'); // 2020-10-13T06%3A12%3A00.000%2B01%3A00
const requestUri = '/service/api/v1/events?location_id=32&nonce=154&since=' + since;
const secret = 'ehsd7485746548574';
const signature = Crypto.createHmac('sha512', secret)
                  .update(requestUri)
                  .digest('hex');

PHP

<?php
// if you use the since or/and until parameter. You should process it with urlencode function
$since = urlencode('2020-10-12T14:00:00Z'); // 2020-10-12T14%3A00%3A00Z
$requestUri = '/service/api/v1/events?location_id=32&nonce=154&since=' . $since;
$secret = 'ehsd7485746548574';
$sign = hash_hmac("sha512", $requestUri, $secret)

El límite actual de solicitudes es de 1 solicitud por segundo. Si realiza más solicitudes, recibirá un código de error 503 o 429 en la respuesta.

Parámetros de encabezado requeridos

X-key - clave de API pública

X-Sign - HMAC SHA512 utilizando la clave secreta de su API y el valor de la URI de la solicitud

Parámetro de cadena de consulta requerido

Nonce - un valor generado por el usuario que aumenta monótonamente (recomendamos una marca de tiempo de estilo UNIX en formato de segundo de época). Nonce debe ser mayor que el anterior.

Los webhooks son la forma preferida de recibir eventos en tiempo real sin realizar solicitudes excesivas. Para hacerlo, necesitaría un punto de recepción de webhook.

Para fines de prueba, puede usar el servicio requestbin.com.

Para acceder a la configuración de webhooks, en el portal de la nube, vaya a Configuración > Webhooks. Allí, configuraría el punto final para cada uno de los canales agregados o para toda la ubicación. Si configura el webhook para toda la ubicación, recibiría todos los eventos de cualquiera de los canales de la ubicación.

La estructura JSON del evento de webhook es muy similar a la estructura de la API. El tiempo del evento está en la zona horaria UTC.

[ {
    "record_id" : 1635343534,
    "event_type" : "RegionJoin",
    "snapshot_id" : -235343534,
    "trigger_id" : "47576ahb-56656-45786-acb45_000015E2",
    "origin" : "Pedestrian",
    "suborigin" : "Unknown",
    "age_range" : "",
    "gender" : "",
    "id" : null,
    "channel_id" : "35576ahb-56656-45781-acb45_000015E2",
    "object_id" : 6,
    "location_id" : 123,
    "event_time" : "2000-01-23 04:56:07.000"
  }, {
    "record_id" : 1635343534,
    "event_type" : "RegionJoin",
    "snapshot_id" : -235343534,
    "trigger_id" : "47576ahb-56656-45786-acb45_000015E2",
    "origin" : "Vehicle",
    "suborigin" : "Car",
    "age_range" : "",
    "gender" : "",
    "id" : null,
    "channel_id" : "35576ahb-56656-45781-acb45_000015E2",
    "object_id" : 6,
    "location_id" : 123,
    "event_time" : "2000-01-23 04:56:07.000"
  }, {
    "record_id" : 1635343534,
    "event_type" : "RegionJoin",
    "snapshot_id" : -235343534,
    "trigger_id" : "47576ahb-56656-45786-acb45_000015E2",
    "origin" : "Face",
    "suborigin" : "",
    "age_range" : "26 - 35",
    "gender" : "Male",
    "id" : null,
    "channel_id" : "35576ahb-56656-45781-acb45_000015E2",
    "object_id" : 6,
    "location_id" : 123,
    "event_time" : "2000-01-23 04:56:07.000"
  } ]