Como cadastrar os aplicativos e gerar App Token e Access Token para Integração com a API da Superlógica

Visão geral

Este conteúdo detalha como gerar as credenciais de segurança (Tokens) do sistema. Em termos simples, um Token funciona como uma "chave de acesso digital". Ele permite que um software externo converse com o banco de dados da Superlógica de forma segura, sem que você precise entregar a sua senha pessoal para o programador.

Quando usar este artigo

Utilize este guia sempre que a sua administradora contratar um sistema parceiro ou uma agência de desenvolvimento de software e o programador solicitar as credenciais de integração (App Token e Access Token) para conectar as ferramentas.

Sintoma ou cenário

Você contratou uma empresa para montar painéis de gráficos financeiros avançados (Power BI). O analista de dados manda um e-mail dizendo: "Preciso do seu App Token e do Access Token para puxar as despesas do sistema via API". Você precisa gerar essas chaves exclusivas para enviar a ele com segurança.

Benefício para o usuário ou operação

Segurança Profissional: Integração de sistemas sem compartilhamento de senhas humanas.
Rastreabilidade: Todas as ações feitas pelo sistema externo ficam registradas na auditoria como tendo sido feitas via API daquele aplicativo específico.
Controle Total: Se você cancelar o contrato com a empresa de software, basta apagar o token e eles perdem o acesso aos dados instantaneamente.

Onde acessar / contexto de uso

O painel de geração de chaves para desenvolvedores fica oculto no fundo da tela de gestão de equipe. Acesse pelo Menu do usuário > Todos os usuários.

Pré-requisitos (Antes de começar)

Perfil Exato: É necessário possuir permissão máxima de Acesso Administrativo (Nível 1000).

Causas prováveis

Implantação de soluções parceiras, automação de processos ou desenvolvimento de painéis customizados pela administradora.

Como fazer ou corrigir

Para cadastrar o token e liberar o acesso a API, execute os passos abaixo:

Acessando o menu de aplicativos

Acesse: Menu do usuário > Todos os usuários;
Role até o final da página para encontrar as abas: - Aplicativos liberados; - Aplicativos (e-mail do usuário conectado).
Em ‘Aplicativos (e-mail do usuário conectado)’, clique em ‘Novo app token’;
Insira o nome do aplicativo e uma descrição para identificá-lo;
Clique em ‘Salvar’;
Ao finalizar o cadastro, os tokens necessários para integração (App Token e Access Token) serão exibidos na tela. Guarde essas informações com segurança:

Consultando o App token e Access Token de um aplicativo já cadastrado:

Acesse a aba ‘Aplicativos liberados’;
Localize o aplicativo desejado e passe o mouse sobre ele;
Clique em ‘Ver access token’ para visualizar os detalhes:
Vá para a aba “Aplicativos (e-mail do usuário conectado)”.
Na coluna “Token”, clique em “Ver Token” para consultar o App Token:

Atenção: Apenas o usuário que cadastrou o aplicativo pode consultar o App Token.

Resultado esperado

Você terá em mãos duas longas sequências de letras e números (os tokens). O programador utilizará essas chaves no código dele para autorizar as requisições, e o fluxo de dados entre os sistemas começará a rodar com total transparência e segurança.

Quando escalar

Acione o suporte técnico caso você gere os tokens corretamente, envie ao desenvolvedor, e ele reporte que a API da Superlógica está retornando o erro “401 - Unauthorized” ou "Token Inválido", mesmo copiando e colando a chave exata.

Informações que devem ser reunidas antes do escalonamento

Os primeiros 4 dígitos numéricos do Token gerado.
Qual é a rota/URL da API que o desenvolvedor está tentando acessar.
Print do erro no software do desenvolvedor.

Regras importantes / Observações

A Regra do Criador do App: Por razões rígidas de segurança da informação, apenas o usuário que criou/cadastrou o aplicativo consegue consultar e visualizar o App Token no futuro. Se o João gerou a chave, a Maria (mesmo sendo administradora) não conseguirá ver o App Token que o João criou se ela acessar pelo login dela.

Problemas comuns e como resolver

Problema: Copiei a chave e mandei no WhatsApp do programador, mas ele disse que está dando erro de digitação.
Causa provável: Ao copiar e colar em aplicativos de mensagem, espaços em branco ocultos costumam ser adicionados no final do token acidentalmente.
Ação recomendada: Cole o token em um Bloco de Notas, certifique-se de que não há espaços sobrando no começo ou no fim, e envie o arquivo .txt ou por e-mail para evitar quebra de formatação.

Dúvidas relacionadas

P: Tem algum custo para gerar essas chaves de integração?
R: Não. A geração de tokens é livre e nativa da sua licença.

P: A empresa de sistema parceiro faliu. Como bloqueio o acesso deles aos meus condomínios?
R: Basta ir na aba de aplicativos, localizar o token que você criou para eles e excluí-lo. A comunicação será cortada na mesma hora.

Palavras-chave de busca

Gerar token API, app token, access token, integração de sistemas, desenvolvedor, documentação API, webhook, chave de acesso, integrar software, Superlógica Condomínios