Pular para o conteúdo principal

Integração Accelero App

A integração Accelero App conecta o ACCELERO ao aplicativo Accelero App, voltado a moradores e usuários de unidades. Pelo app, a pessoa pode se cadastrar, obter seu QR Code de acesso e criar convites de visita — e o ACCELERO mantém esses dados sincronizados nos dois sentidos.

A comunicação é bidirecional: o app consome uma API externa exposta pelo plugin (external/acceleroapp/...) para cadastrar pessoas, gerar QR Codes e criar convites; e o ACCELERO notifica o app sobre o andamento das visitas (check-in, entrada e saída) por meio de chamadas de retorno (callback).

Disponibilidade

Esta integração é disponibilizada como plugin (acceleroapp) e precisa ser instalada e habilitada pela equipe técnica da IONGRADE. Consulte o suporte para verificar a compatibilidade com a sua versão do ACCELERO.

Compatibilidade

Versão atual do plugin: 0.2.1 — compatível com ACCELERO 2.16.6, 2.16.7, 2.16.8 e 2.17.0.


O que a integração faz

Com o plugin ativo, o aplicativo Accelero App passa a se comunicar diretamente com o ACCELERO, que continua sendo a fonte única de verdade dos cadastros e dos acessos.

FuncionalidadeO que acontece no ACCELERO
Cadastro de pessoas pelo appO app envia os dados da pessoa e o ACCELERO cria (ou atualiza) o cadastro, vinculando-a à categoria padrão e à unidade informada
Listagem de pessoas e unidadesO app consulta pessoas habilitadas, unidades (empresas) e tipos de evento disponíveis
Geração de QR CodeO app solicita o QR Code de acesso de uma pessoa, em versão fixa ou dinâmica
Convites de visitaO app cria, cancela e atualiza convites; o ACCELERO gera o evento de visita correspondente
Convites recorrentesO app cria e remove convites de visita recorrentes
Notificação de status da visitaA cada check-in, entrada ou saída do visitante, o ACCELERO informa o app sobre o status da visita
Desabilitar pessoaO app pode desabilitar uma pessoa no ACCELERO pelo documento
Envio manual e em massaOperadores podem enviar pessoas e empresas para o app, individualmente ou em lote
Benefício principal

Dá autonomia ao morador para se cadastrar, obter o próprio acesso e gerenciar visitas pelo celular, sem intervenção manual da portaria, mantendo o ACCELERO como sistema central de controle de acesso.


Configuração

Caminho de acesso: Configurações > Integrações - AcceleroApp

A tela possui duas abas: Geral e Sincronização.

TODO: Adicionar Screenshot

Tela de configuração Configurações > Integrações - AcceleroApp com as abas Geral e Sincronização visíveis.

Aba Geral

Dados da integração:

CampoDescrição
OperadorOperador do ACCELERO usado como responsável pelas operações executadas pela integração (ex.: cadastros criados a partir do app)
Token de autenticação (APP > Accelero)Token que o aplicativo apresenta para autenticar suas chamadas à API externa do ACCELERO
Token de autenticação (Accelero > APP)Token usado pelo ACCELERO para autenticar as chamadas de notificação enviadas ao aplicativo
URL AcceleroAppEndereço (endpoint) do serviço do aplicativo Accelero App que o ACCELERO chama para notificar status

Categoria de pessoas:

CampoDescrição
Categoria padrão para novos moradoresCategoria atribuída automaticamente a toda pessoa cadastrada pelo app
Associação de novos moradoresTipo de associação (vínculo pessoa-empresa) aplicado ao vincular o novo morador à unidade

Visitas:

CampoDescrição
Tipo de evento defaultTipo de evento usado ao criar visitas originadas pelo app

Outros:

CampoDescrição
Sobrescrever dados de pessoas existentesQuando ativado, dados enviados pelo app (nome, documento, e-mail, telefone, foto) sobrescrevem os de uma pessoa já cadastrada. Quando desativado, apenas pessoas novas têm seus dados gravados a partir do app
Sobrescrita de dados

Com Sobrescrever dados de pessoas existentes ligado, qualquer cadastro feito pelo app pode substituir informações já existentes no ACCELERO. Avalie o impacto antes de ativar em ambientes com cadastros previamente revisados.

Aba Sincronização

Define o escopo do envio em massa de dados para o aplicativo.

CampoDescrição
Tipos de eventoMulti-seleção dos tipos de evento considerados na sincronização
Categorias de pessoasMulti-seleção das categorias de pessoas consideradas na sincronização

Envio em massa:

O botão Sincronizar dados dispara a sincronização. O processo é executado em segundo plano, em lotes de 100 registros, e o operador recebe uma notificação ao concluir.

TODO: Adicionar Screenshot

Aba Sincronização mostrando os campos Tipos de evento, Categorias de pessoas e o botão Sincronizar dados.

Pré-requisitos do envio em massa

A sincronização só é iniciada se houver ao menos um tipo de evento e ao menos uma categoria de pessoas selecionados. Não é possível iniciar uma nova sincronização enquanto outra estiver em andamento.

Botões da tela

BotãoFunção
VoltarRetorna sem salvar
SalvarPersiste a configuração
Sincronizar dadosInicia o envio em massa de pessoas e empresas para o app (aba Sincronização)

Envio manual de pessoas e empresas

Além do envio em massa, é possível enviar uma pessoa ou uma empresa específica para o app diretamente da tela de edição da entidade.

Pessoa

No cadastro de pessoa, o plugin adiciona a seção Accelero APP, com o botão Enviar dados para o APP. Ao acionar, o ACCELERO envia o cadastro da pessoa ao app e armazena o identificador remoto retornado.

TODO: Adicionar Screenshot

Cadastro de pessoa (Pessoas > Editar) com a seção Accelero APP expandida e o botão Enviar dados para o APP.

Empresa

No cadastro de empresa, o plugin adiciona a seção Accelero APP, também com o botão Enviar dados para o APP, que envia a unidade (empresa) ao aplicativo.

TODO: Adicionar Screenshot

Cadastro de empresa (Empresas > Editar) com a seção Accelero APP expandida e o botão Enviar dados para o APP.

Envio individual x em massa

Use o botão Enviar dados para o APP para casos pontuais (uma nova pessoa ou unidade). Para uma carga inicial completa, prefira o Envio em massa na aba Sincronização.


API externa consumida pelo aplicativo

O plugin expõe um conjunto de endpoints sob external/acceleroapp/..., autenticados pelo Token de autenticação (APP > Accelero). São consumidos pelo próprio aplicativo Accelero App — não são telas de operação no ACCELERO.

OperaçãoO que faz
Listar tipos de eventoRetorna os tipos de evento disponíveis
Listar unidadesRetorna as empresas (unidades) cadastradas
Listar pessoasRetorna as pessoas habilitadas e suas unidades
Listar pessoas de uma unidadeRetorna as pessoas vinculadas a uma unidade específica
Cadastrar pessoaCria ou atualiza a pessoa, define a categoria padrão e a vincula à unidade
Desabilitar pessoaDesabilita a pessoa pelo documento informado
Gerar QR CodeRetorna o QR Code de acesso da pessoa (fixo ou dinâmico)
Criar / cancelar conviteCria ou cancela um convite de visita
Criar / remover convite recorrenteCria ou remove um convite de visita recorrente
Atualizar status do conviteAtualiza o status do convite (LinkEventoPessoa)
Identificação cruzada

Cada pessoa, empresa e visita sincronizada guarda o identificador correspondente no app em seus metadados (acceleroapp), o que permite ao ACCELERO localizar o registro certo nas operações subsequentes (cancelamento, atualização de status, etc.).


Convites e visitas

Quando o app cria um convite, o ACCELERO gera um evento de visita usando o Tipo de evento default configurado, registra o visitante (criando ou atualizando o cadastro, conforme a opção de sobrescrita) e o associa ao morador anfitrião e à unidade.

Para visitas geradas pelo app, o ACCELERO também produz um cartão virtual do tipo QR Code com validade igual ao período do evento, habilitado enquanto a visita e o vínculo do visitante estiverem ativos.

TODO: Adicionar Screenshot

Evento de visita criado a partir de um convite do app, em Visitas / Agendamentos, mostrando o visitante, o anfitrião e a unidade.

Notificação de status ao app

O ACCELERO notifica o aplicativo sobre o andamento da visita nos seguintes momentos:

EventoStatus enviado ao app
Check-in do visitantecheckin
Passagem de entradaentry
Passagem de saídaexit

A distinção entre entrada e saída usa a configuração do canal do controlador (canais de baixa de visita são tratados como saída). Canais marcados como Check-in não geram notificação de entrada/saída.

Origem do check-in

O check-in pelo app é registrado como um tipo de notificação de anfitrião dedicado (AcceleroAPP), o que permite ao ACCELERO disparar a notificação de status correspondente para o aplicativo.


Casos de uso

Cadastro de morador pelo aplicativo

  1. O morador instala o app e informa seus dados e a unidade
  2. O app envia o cadastro ao ACCELERO, que cria a pessoa, atribui a Categoria padrão para novos moradores e a vincula à unidade com a Associação de novos moradores configurada
  3. O morador solicita seu QR Code de acesso pelo app
  4. Na portaria, o QR Code é apresentado nos pontos de acesso normalmente

Convite de visita

  1. O morador cria um convite no app, informando visitante, datas e tipo de visita
  2. O ACCELERO gera o evento de visita com o Tipo de evento default e associa visitante e anfitrião
  3. O visitante recebe um QR Code de acesso válido para o período da visita
  4. A cada check-in, entrada e saída, o ACCELERO atualiza o status da visita no app

Carga inicial de dados para o app

  1. Em Configurações > Integrações - AcceleroApp, aba Sincronização, selecione os Tipos de evento e as Categorias de pessoas desejados
  2. Clique em Sincronizar dados
  3. Acompanhe a notificação de conclusão do processamento em segundo plano

Boas práticas

  • Categoria padrão dedicada: use uma categoria específica para os moradores cadastrados pelo app, facilitando a aplicação de regras de acesso e relatórios.
  • Operador de integração dedicado: configure um operador próprio (ex.: "Integração Accelero App") como responsável pelas operações do plugin, em vez de uma conta nominal.
  • Avalie a sobrescrita de dados: mantenha Sobrescrever dados de pessoas existentes desligado quando os cadastros já passaram por curadoria, para evitar alterações indesejadas vindas do app.
  • Tokens distintos: mantenha tokens diferentes para cada sentido de comunicação (APP → Accelero e Accelero → APP) e trate-os como credenciais sensíveis.

Troubleshooting

Pessoas não são cadastradas pelo app

Possíveis causas:

  • Unidade informada pelo app não corresponde a nenhuma empresa (por código ou descrição)
  • Categoria padrão para novos moradores ou Associação de novos moradores não configuradas
  • Token de autenticação (APP > Accelero) incorreto

Solução:

  1. Confirme que a unidade enviada existe como empresa no ACCELERO
  2. Verifique as configurações da aba Geral
  3. Confirme o token configurado no app e no ACCELERO

Envio em massa não inicia

Possíveis causas:

  • Nenhum tipo de evento ou categoria de pessoas selecionado na aba Sincronização
  • Já existe uma sincronização em andamento

Solução:

  1. Selecione ao menos um tipo de evento e uma categoria de pessoas
  2. Aguarde a conclusão da sincronização anterior antes de iniciar outra

App não recebe atualização de status das visitas

Possíveis causas:

  • URL AcceleroApp ou Token de autenticação (Accelero > APP) incorretos
  • Canal de acesso configurado como Check-in (não gera notificação de entrada/saída)
  • Visita ou vínculo do visitante cancelado

Solução:

  1. Verifique a URL e o token de notificação na aba Geral
  2. Confirme a configuração dos canais usados na passagem do visitante
  3. Verifique o status do evento e do vínculo do visitante

Integração com outros módulos

Pessoas e Categorias

A integração cria e atualiza Pessoas e usa a Categoria padrão configurada para os novos moradores.

Empresas e Tipos de associação

As unidades correspondem a Empresas, e o vínculo do morador usa um Tipo de associação configurado.

Eventos (Visitas)

Os convites geram Eventos de visita com o tipo de evento padrão configurado.

Logs e Monitoramento

As passagens dos visitantes registradas nos Logs e Monitoramento disparam as notificações de status para o app.


Próximos Passos

  • Pessoas — Entenda o cadastro criado/atualizado pelo app
  • Empresas — Configure as unidades sincronizadas
  • Categorias — Defina a categoria padrão dos novos moradores
  • Tipos de associação — Configure o vínculo de novos moradores
  • Eventos — Entenda as visitas geradas por convites
  • Plugins — Saiba mais sobre o sistema de plugins do ACCELERO