DocumentaciónAjuda

Testar a conexão

Verifique se a plataforma alcança a API do seu sistema com as credenciais salvas.

Nesta página

Testar consulta a API do seu sistema com o endereço e as credenciais que você salvou, e informa se ela respondeu e em quanto tempo. Use-o depois de criar uma integração ou de trocar as credenciais dela.

Antes de começar

  • Você precisa do papel Editor ou Administrador.

  • A integração deve ter URL base. Se não tiver, o botão aparece desativado e diz Configure a URL base para testar a conexão.

Passos

  1. Acesse Configurações → Integrações.

  2. No cartão da integração, clique em Testar.

  3. Aguarde o resultado: aparece um aviso na parte superior.

É consultada a URL base seguida da Rota de saúde que você definiu; se a rota estiver vazia, apenas a URL base. A consulta é somente de leitura e espera até 10 segundos.

Resultados

Mensagem

O que significa

Conexão bem-sucedida. (com o código HTTP e os milissegundos)

O sistema respondeu bem.

O sistema respondeu … (com um código, por exemplo 401)

Chegou ao sistema, mas ele rejeitou a consulta. Um 401 ou 403 costuma indicar uma credencial incorreta; um 404, uma Rota de saúde que não existe.

Sem resposta em 10 s.

O sistema não respondeu a tempo. Verifique a URL base e se o sistema é acessível pela internet.

Não foi possível conectar (com um código de rede)

Não foi possível abrir a conexão: endereço incorreto, sistema desligado, firewall ou certificado vencido.

As credenciais salvas não podem ser descriptografadas…

Escreva a credencial novamente editando a integração.

A URL base não é válida. ou Somente URLs http ou https são aceitas.

Corrija a URL base editando a integração.

Não foi possível resolver o nome do servidor.

O nome da URL base não existe na internet. Verifique se está escrito corretamente.

A URL aponta para uma rede privada; isso não é permitido a partir da plataforma.

O endereço é interno da sua rede. A plataforma só testa sistemas acessíveis pela internet.

O que acontece depois

  • Se o sistema respondeu (com sucesso ou com um código de erro), o cartão atualiza Última sincronização. Se o teste der certo, o status fica Ativa.

  • Se o sistema respondeu com um código de erro, não respondeu a tempo ou não foi possível conectar, o status passa para Erro e o cartão mostra o motivo abaixo do nome. O status volta para Ativa no próximo teste bem-sucedido ou quando chega um novo evento pelo webhook.

  • Se a URL base não é válida, não existe ou aponta para uma rede privada, você só vê o aviso: o status e as datas do cartão não mudam.

Testar uma integração Pausada muda o status dela: fica Ativa se o teste der certo ou Erro se falhar, e nos dois casos o webhook volta a aceitar eventos. Se quiser que ela continue pausada, pause-a novamente depois de testar. Veja Editar, pausar ou excluir uma integração.

Com OAuth 2.0 (client credentials), por enquanto o teste consulta o seu sistema sem se autenticar. Se o seu sistema exigir autenticação nessa rota, o teste responderá com um código como 401 mesmo que as credenciais estejam corretas.

O teste não afeta o recebimento de eventos: um sistema pode enviar eventos pelo webhook mesmo que a plataforma não consiga alcançar a API dele.

Relacionado

Pesquisar em SofIA Gestão

Digite pelo menos 2 letras para pesquisar em SofIA Gestão.

↑↓ navegar · Enter abrir · Esc fechar