Pular para o conteúdo
Flagy Control
Flagy Control · Desenvolvedores

API de controle de acesso
para integrar o seu sistema.

API REST com autenticação JWT para convites, histórico de acessos, abertura de portas e notificações. Integração com leitores faciais e smart locker pelo Flagy Agent. A mesma API que move o nosso aplicativo.

Formas de integração

Três camadas
de integração.

API REST

Aplicativos, portais e sistemas de gestão consultam acessos, criam convites e abrem portas. Respostas em JSON, permissões por perfil de usuário.

Flagy Agent

Ponte segura entre a nuvem e a rede local da portaria. Comunicação só de saída, sem abrir portas no roteador e sem guardar senha dos leitores.

Equipamentos

Leitores faciais Intelbras, Dahua, Hikvision, Control iD e ZKTeco e controladoras de smart locker, por drivers e um protocolo de eventos documentado.

API REST v1

Autenticação
e endpoints.

Base https://control.flagy.com.br/api/v1 (ou o domínio próprio do parceiro). Token de acesso Bearer válido por 1 hora e refresh token rotativo de 30 dias. As permissões seguem o perfil do usuário no painel.

Autenticação

MétodoRotaO que fazAcesso
POST/auth/loginEntra com e-mail e senha (operador) ou CPF/e-mail e senha (pessoa) e devolve os tokenspública
POST/auth/refreshTroca o refresh token por um novo par de tokens (rotativo)pública
POST/auth/identificarEm quais organizações um CPF tem cadastro (com a marca de cada uma)pública
POST/auth/pinEnvia o código de acesso pelo WhatsApppública
POST/auth/pin/verificarConfere o código e devolve os tokenspública
GET/meQuem está autenticado, a organização e as permissõestoken
POST/auth/logoutEncerra a sessão do aparelhotoken

Convites e visitantes

MétodoRotaO que fazAcesso
GET/convitesConvites (pessoa: os seus; operador: todos). Filtro vigentes=1token
POST/convitesCria um convite: tipo, dias, pessoas, áreas e convidados com WhatsApptoken
GET/convites/{id}Um convite com o link e os convidados (situação de cada um)token
POST/convites/{id}/cancelarCancela o convite e tira os convidados dos leitorestoken

Acessos e portas

MétodoRotaO que fazAcesso
GET/acessosHistórico de passagens (liberado, negado e motivo), paginado por antes_detoken
GET/dispositivosLeitores da organização, com situação (online/offline)dispositivos.ver
POST/dispositivos/{id}/abrirAbre a porta remotamente (fica no log de auditoria)dispositivos.abrir

Notificações

MétodoRotaO que fazAcesso
POST/pushRegistra o aparelho para receber notificações (FCM ou Web Push)token
DELETE/pushRemove o aparelhotoken
GET/avisosPreferências de aviso: entradas, negados, convites, encomendas e canaistoken
PUT/avisosSalva as preferências de avisotoken
Flagy Agent e equipamentos

Protocolo entre a nuvem
e a rede da portaria.

O agente se autentica com a organização e um token próprio e conversa só para fora, por HTTPS. A mesma base serve aos leitores faciais e às controladoras de smart locker. Comandos têm validade: um comando que chega atrasado não abre porta.

MétodoRota /api/agente/v1O que faz
GET/requisicoesComandos pendentes para os leitores da rede local (o agente executa e devolve)
POST/respostasResultado dos comandos executados nos leitores
POST/dispositivosLeitor encontrado na rede (modelo, serial, firmware, IP): cadastra ou religa
POST/eventos/{id}Passagem lida pelo leitor, com a foto da leitura
GET/lockers/comandosSmart locker: portas a abrir nas controladoras ligadas ao agente
POST/lockers/{id}/eventosSmart locker: porta aberta, fechada, sensor de volume, porta forçada, sinal
POST/lockers/{id}/midiaSmart locker: foto ou vídeo da abertura
Como começar

Primeiros passos
da integração.

Crie um usuário para a integraçãoNo painel da organização, em Ajustes › Usuários, com o perfil e as permissões que a integração precisa (por exemplo, ver acessos e abrir portas).
AutentiqueChame POST /auth/login com tipo: "usuario" e guarde o refresh token: ele renova o acesso sem pedir a senha de novo.
Consuma os endpointsEnvie Authorization: Bearer em cada chamada. Teste com GET /me e GET /acessos.
Novo equipamento ou webhook para o seu sistema?Drivers de outros leitores, controladoras e o envio de eventos para o seu sistema são alinhados com o nosso time técnico, sob consulta.
Quem está por trás

Seis sistemas no ar,
a mesma casa.

O Flagy Chatbot, o Flagy Varejo, o Flagy Menu, o Flagy Nutri e o Flagy Control são da 3WE Software, que mantém sistemas de gestão em seis mercados diferentes. Clique num deles para ver o que é — ou entre no site e confira você mesmo.

ClinPlus Saúde

Gestão para clínicas e consultórios: agenda, prontuário eletrônico, faturamento de convênio no padrão TISS e assinatura digital com certificado ICP-Brasil.

Conhecer o ClinPlus
Meo Flow Beleza e bem-estar

Agenda, comanda, caixa, comissão e clube de assinatura para barbearia, salão e estética.

Conhecer o Meo Flow
AgriFlex Agro

Gestão de fazenda: rebanho, manejo no curral, lavoura e o custo por animal ou por hectare, com app que funciona no campo sem sinal.

Conhecer o AgriFlex
SafetyFlow Segurança do trabalho

Gestão de segurança do trabalho: entrega de EPI com assinatura, treinamentos, exames ocupacionais e os documentos exigidos na fiscalização.

Conhecer o SafetyFlow

Todos da 3WE Software e Tecnologia LTDA, CNPJ 53.738.505/0001-14.