O Serviço Camlytics fornece uma maneira conveniente de acessar eventos analíticos, relatórios, dados de localizações e canais programaticamente.

Você também pode estar interessado em webhooks para métricas em tempo real como ocupação atual ocupação e atual fila. Se você planeja receber eventos analíticos em tempo real, recomendamos usar webhooks.
Se você estiver interessado em receber programaticamente os Relatórios, você pode optar por feeds de relatórios.

A autenticação na API REST do Serviço requer uma Chave de API válida.

As chaves de API pública e secreta podem ser encontradas na seção de chave de API em Configurações.

Siga os seguintes passos para assinar sua solicitação de API:

• Crie um HMAC SHA512 usando sua chave secreta da API e o valor do URI da solicitação.
• Inclua o hash resultante em sua solicitação no cabeçalho de solicitação X-Sign.

Exemplo:

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)

O limite atual de solicitações é de 1 solicitação por segundo. Se você fizer mais solicitações, receberá o código de erro 503 ou 429.

Parâmetros de cabeçalho necessários

X-key - chave de API pública

X-Sign - HMAC SHA512 usando sua chave secreta da API e o valor do URI da solicitação

Parâmetro de string de consulta necessário

Nonce - um valor gerado pelo usuário que aumenta monotonicamente (recomendamos um timestamp no estilo UNIX no formato de segundo do epoch). Nonce deve ser maior que o anterior.

Webhooks são a maneira preferida de receber eventos em tempo real sem fazer solicitações excessivas. Para fazer isso, você precisaria de um ponto de extremidade para receber webhooks.

Para fins de teste, você pode usar o serviço requestbin.com.

Para acessar as configurações de webhooks, no portal de nuvem, vá para Configurações > Webhooks. Lá, você configuraria o ponto de extremidade para cada um dos canais adicionados ou para toda a localização. Se você definir o webhook para toda a localização, você receberá todos os eventos de qualquer um dos canais de localização.

A estrutura JSON do evento de webhook é muito semelhante à estrutura da API. O tempo do evento está no fuso horário 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"
  } ]