Como criar Endpoints no Uappi Ágora 1.6

O que são Endpoints?

Os Endpoints são gatilhos externos que permitem que sistemas ou aplicações se comuniquem com o Uappi Ágora para executar ações diretamente na Plataforma Uappi.

Diferente dos eventos, que são disparados pela própria plataforma, os Endpoints permitem que uma aplicação externa envie informações para o Ágora, iniciando uma automação ou executando uma ação específica.

Quando utilizar um Endpoint?

Os Endpoints são recomendados quando existe a necessidade de iniciar uma ação no Ágora a partir de um sistema externo.

Alguns exemplos de uso são:

• Cadastrar produtos automaticamente a partir de outro sistema;
• Atualizar o status de pedidos;
• Sincronizar informações de clientes;
• Criar automações baseadas em eventos externos.

Como criar um Endpoint

1. Acesse a área de Endpoints

No painel do Uappi Ágora, acesse a seção Endpoints.

2. Crie um novo Endpoint

Selecione a opção para criar um novo Endpoint.

Informe os dados solicitados pela plataforma para configurar o gatilho que será utilizado pela aplicação externa.

3. Configure a integração

Após criar o Endpoint, utilize a URL gerada para realizar a integração com o sistema externo responsável por enviar as requisições.

Essa URL deverá ser utilizada pela aplicação sempre que houver necessidade de executar a ação configurada.

4. Teste o Endpoint

Após concluir a configuração:

• envie uma requisição para o Endpoint;
• verifique se a Função foi executada corretamente;
• valide o comportamento esperado da integração.

Caso ocorram erros durante a execução, consulte os logs do Ágora para identificar a causa do problema.

🎥 Tutorial em vídeo

Como criar endpoints no Ágora

Boas práticas

• Utilize Endpoints apenas quando a automação precisar ser iniciada por um sistema externo.
• Valide todas as informações enviadas nas requisições.
• Utilize HTTPS para garantir uma comunicação segura.
• Realize testes antes de utilizar o Endpoint em ambiente de produção.

Perguntas frequentes

Qual a diferença entre Eventos e Endpoints?

Os Eventos são disparados automaticamente pela Plataforma Uappi quando determinada ação ocorre, como a criação de um pedido.

Os Endpoints são acionados por sistemas externos, permitindo executar ações diretamente na Plataforma Uappi.

Quando devo utilizar um Endpoint?

Utilize um Endpoint quando desejar que um sistema externo inicie uma automação ou execute uma ação dentro da Plataforma Uappi.

Posso utilizar um Endpoint para cadastrar produtos?

Sim. O cadastro automático de produtos é um dos casos de uso previstos para os Endpoints do Uappi Ágora.

Como verificar se o Endpoint está funcionando?

Após configurar a integração, envie uma requisição para o Endpoint e valide a execução da Função correspondente. Em caso de falhas, consulte os logs da plataforma.