Skip to content

Acesso à API REST e chaves

A página API no painel de administração permite gerir chaves de API para a API REST pública do SmartLobby, para que os seus sistemas possam ler dados de visitas (integrações, relatórios ou controlo de acessos), consoante a subscrição e a permissões.

Disponibilidade

Se a página indicar que a funcionalidade está desativada, o seu plano ou as definições da conta podem não incluir acesso API. Contacte o suporte se precisar.

Chaves

  • Utilize Gerar chave de API para criar credenciais quando tiver permissão para editar a API.
  • O painel mostra a chave API e o segredo API. Trate-os como palavras-passe. Quem os tiver pode chamar a API em nome da sua integração — guarde-os em segurança e rode a chave se houver risco de exposição.

Exemplo: listar visitas

O painel apresenta um curl de exemplo para a sua localização, com cabeçalhos:

  • X-ABB-API-KEY — a sua chave API
  • Authorization: Bearer — o seu segredo API

Os parâmetros incluem normalmente um limite, intervalo from e to e filtros como visitantes ainda no edifício. Os caminhos e o host exatos aparecem na interface de administração do seu ambiente — use esses valores como referência.

Boas práticas

  • Privilegio mínimo: só as integrações que precisam de dados de visitas devem receber chaves.
  • Rode as chaves quando pessoal com acesso sair ou após um incidente.
  • Consulte a documentação da API ou os materiais da sua organização para a lista completa de endpoints e limites.