Como ativar e desativar a API dentro do Sistema Superlógica

Visão geral

O Sistema Superlógica permite controlar os aplicativos autorizados a utilizar a API para integração com outras plataformas.

A ativação é realizada pelo cadastro e liberação de um aplicativo, enquanto a desativação remove o aplicativo da lista de integrações autorizadas. Essas configurações ficam disponíveis diretamente no sistema.

Quando usar este artigo

Utilize este artigo quando houver necessidade de:

Liberar um aplicativo para utilização da API.
Cadastrar uma nova integração com outro sistema.
Desativar uma integração que não deve mais ter acesso à API.
Consultar quais aplicativos estão liberados para integração.

Sintoma ou cenário

O usuário precisa liberar uma nova plataforma para integração com o ERP Superlógica ou remover o acesso de uma plataforma que já está autorizada.

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

Permite controlar quais aplicativos possuem acesso à API.
Facilita a ativação de novas integrações.
Permite remover integrações que não devem mais estar autorizadas.
Centraliza o gerenciamento dos aplicativos liberados no próprio sistema.

Onde acessar / contexto de uso

O gerenciamento da API está disponível na área de usuários do Sistema Superlógica:

Usuário/e-mail de acesso > Todos os usuários > API (Integrações com outros sistemas) > Aplicativos liberados

Pré-requisitos (Antes de começar)

Ter acesso ao ERP Superlógica.
Para liberar uma integração, ter em mãos o Token da plataforma que será integrada à API.
Identificar o aplicativo que será ativado ou desativado.

Causas prováveis

A configuração pode ser necessária quando:

Uma nova plataforma precisa ser integrada ao ERP Superlógica.
Um aplicativo precisa ser autorizado para utilizar a API.
Uma integração existente não deve mais ter acesso ao sistema.

Como fazer ou corrigir

Como ativar o acesso à API

No canto superior direito, clique no seu e-mail de acesso.
Selecione Todos os usuários.
Localize a seção API (Integrações com outros sistemas).
Clique em Aplicativos liberados.
Clique em Liberar aplicativo.
Selecione uma das opções:
- Meu aplicativo;
- Outro aplicativo.
Informe o Token da plataforma que será integrada.
Confirme a ação quando solicitado.

Após a confirmação, o aplicativo será incluído entre os aplicativos liberados.

Como desativar o acesso de um aplicativo

No canto superior direito, clique no seu e-mail de acesso.
Selecione Todos os usuários.
Localize a seção API (Integrações com outros sistemas).
Clique em Aplicativos liberados.
Localize a plataforma que deseja desabilitar.
Clique no ícone da lixeira, localizado no canto esquerdo.

Após a remoção, o aplicativo não fará mais parte das integrações autorizadas da conta.

Atenção

A desativação da API interrompe as integrações ativas vinculadas àquela conta. Antes de remover um aplicativo, confirme se existem parceiros ou equipes que dependem dessa integração e comunique-os sobre a alteração.

Resultado esperado

Ao ativar, o aplicativo é incluído na lista de Aplicativos liberados e pode utilizar a API conforme a integração configurada.

Ao desativar, o aplicativo é removido da lista e deixa de fazer parte das integrações autorizadas da conta.

Quando escalar

Escalone quando:

O aplicativo não puder ser liberado mesmo após seguir o procedimento.
A opção Liberar aplicativo não estiver disponível.
Não for possível remover um aplicativo da lista.
Uma integração continuar funcionando após a remoção do aplicativo.
O sistema apresentar uma mensagem de erro durante a ativação ou desativação.

Informações para escalonamento

Nome da plataforma ou aplicativo afetado.
Print da tela em que o comportamento ocorre.
Mensagem de erro apresentada, quando houver.
Etapa do procedimento em que o problema ocorreu.
Data e hora da ocorrência.

Regras importantes / Observações

O acesso à API é controlado por meio da lista de Aplicativos liberados.
Para liberar uma integração, é necessário possuir o Token da plataforma que será integrada.
A desativação de um aplicativo interrompe as integrações ativas vinculadas àquela conta.
Antes de desativar uma integração, confirme quais parceiros ou equipes podem ser impactados.

Problemas comuns e como resolver

Problema: O aplicativo não aparece na lista de aplicativos liberados.

Causa provável: O aplicativo ainda não foi cadastrado ou liberado para a conta.

Ação recomendada: Acesse API (Integrações com outros sistemas) > Aplicativos liberados, clique em Liberar aplicativo e realize o cadastro utilizando o Token da plataforma.

Problema: Uma integração deixou de funcionar após a desativação de um aplicativo.

Causa provável: O aplicativo responsável pela integração foi removido da lista de aplicativos liberados.

Ação recomendada: Confirme se o aplicativo deveria permanecer autorizado. Caso seja necessário restabelecer a integração, realize novamente o processo de liberação do aplicativo.

Problema: O usuário não possui o Token da plataforma que deseja integrar.

Causa provável: O Token deve ser obtido junto à plataforma que será integrada.

Ação recomendada: Solicite o Token à plataforma responsável pela integração antes de realizar a liberação no Sistema Superlógica.

Dúvidas relacionadas (FAQ)

P: Quem pode realizar a ativação ou desativação de um aplicativo?

R: O conteúdo de origem informa que o controle pode ser realizado por qualquer usuário com acesso ao ERP Superlógica.

P: Onde encontro os aplicativos que possuem acesso à API?

R: Acesse Todos os usuários > API (Integrações com outros sistemas) > Aplicativos liberados.

P: O que acontece ao desativar um aplicativo?

R: O aplicativo é removido da lista de integrações autorizadas e as integrações ativas vinculadas àquela conta são interrompidas.

P: O que preciso para liberar uma nova integração?

R: É necessário ter o Token da plataforma que será integrada e realizar o cadastro em Aplicativos liberados.

Palavras-chave de busca

API, integração, aplicativos liberados, liberar aplicativo, desativar aplicativo, token, integrações com outros sistemas, Sistema Superlógica, acesso à API, Suporte ERP Imobiliárias

Relativo a