Este documento tem como objetivo descrever a API de integração com o sistema Situator, a fim de orientar sobre o fluxo de funcionamento dos serviços através dos endpoints de comunicação, e esclarecer dúvidas conceituais básicas que possam surgir durante a sua utilização. Na maioria dos casos, primeiramente é necessário realizar um login de autenticação na própria API, permitindo executar a lista de serviços disponíveis, tais como:

• Listar, inserir, alterar e apagar registros de cadastros variados, como contas, zonas, portas, pessoas, fotos, credenciais, permissões de acesso, veículos, previsões de entradas e saídas, divisões e áreas comuns.

• Gerar evento remoto.

• Fazer o atendimento automático de ocorrências.

• Inscrever-se em webhooks, que são notificações do Situator de eventos ocorridos para outras aplicações.

• Emitir relatórios de acessos e ocorrências.

• Operações em painel de alarme para armar, desarmar e verificar status.

• Listagem de câmeras, imagens ao vivo e gravações.

• Detalhes dos dispositivos utilizados, como fabricantes, modelos, periféricos, eventos, funcionalidades, etc.

Além desta documentação, é possível consultar a estrutura dos modelos de dados dos endpoints acessando a ferramenta Swagger, pela uri /api/help/index no servidor do Situator, ex:

Conceitos

Para melhor compreensão dos serviços e modelos de dados da API Situator, é preciso familiarizar-se com alguns termos e conceitos importantes.
O Situator inicia sua configuração pelo cadastro de Contas, que identificam cada cliente a ser monitorado com seus dados básicos: Código da conta, Nome, Razão Social, CPF/CNPJ, CEP, Endereço, etc.
Dentro de cada conta serão definidas as Zonas, que servem para identificar as áreas onde são alocados os recursos de vídeo, acesso ou automação.
Os dispositivos de câmera, acesso e automação disparam Eventos específicos dos seus funcionamentos, os quais serão captados pelo Situator para gerar as Ocorrências, e permitir seu atendimento pelos operadores.
Para acessar o sistema ou utilizar a API, pode-se cadastrar os Usuários e seus perfis de acesso, sendo que existe o perfil Cliente da API com permissão API de eventos para gerar eventos remotos.
Na conta são cadastradas as Pessoas de tipos funcionário, morador, visitante ou prestador de serviço, que conterá permissões de acesso vinculadas aos dispositivos através das Credencias, que envolve as TAG’s, cartões e controles de portões, além da biometria.

Formato das requisições

As requisições devem ser enviadas no padrão HTTP, usando os verbos padrões “GET”, “POST”, “PUT”, entre outros. Todas as URLs da api, terão como seu prefixo o endereço de IP e porta onde se encontra o servidor do situator, ex: