API e integrações

API REST e webhooks para integrar o controle de acesso

Seu sistema cadastra pessoas e recebe a frequência sem digitação dupla. Documentação aberta em OpenAPI 3.

Pedir demonstração Ver todos os recursos

O que a API faz

Criar ou atualizar pessoas pelo CPF ou pelo código externo, desativar, enviar a foto facial, ler horários e leitores e listar registros por período, pessoa ou leitor, com cursor para buscar só o que é novo.

Os webhooks enviam cada nova marcação e as mudanças de cadastro para a URL do seu sistema, com assinatura HMAC-SHA256, novas tentativas e log de entregas.

Chave por integração com permissões (escopos) e limite de requisições.
Respostas em JSON com paginação e erros padronizados.
Especificação OpenAPI 3 em /api/openapi.json.

No sistema

O que você encontra no Facial BR

Chaves de API

Uma por sistema, com escopos.

Pessoas

Criar, atualizar e desativar.

Frequências

Filtros e cursor incremental.

Webhooks

Eventos assinados com HMAC.

Perguntas frequentes

Dúvidas comuns

Onde está a documentação?

A especificação OpenAPI 3 fica em https://facialbr.com.br/api/openapi.json e pode ser aberta em qualquer visualizador OpenAPI.

Como sei que o webhook veio do Facial BR?

Cada envio traz o header X-FacialBR-Assinatura com o HMAC-SHA256 do corpo e do horário, calculado com o segredo que só você e o sistema conhecem.

Continue navegando

Veja também

Quer ver o Facial BR com o seu leitor Hikvision?

Peça uma demonstração. Conferimos o modelo do seu leitor e mostramos o cadastro, a sincronização e os relatórios funcionando.

Pedir demonstração