Conectores de API (Webhooks)

Eventos, Endpoint, Sincronização, Automação, Parâmetros, Gestão de estado

Descrição: Esta ferramenta permite que o sistema envie notificações automáticas em tempo real para aplicações e serviços externos sempre que ocorrer um evento específico dentro do Framework360.

Para que serve? (Exemplos práticos)

Os Conectores API são essenciais para automatizar o fluxo de dados entre o Framework360 e outros softwares empresariais, reduzindo o trabalho manual e garantindo que todos os sistemas estejam sincronizados.

  • Sincronização CRM: Use-o para notificar seu Customer Relationship Management (CRM) sempre que um novo usuário se registrar ou um potencial cliente preencher um formulário.
  • Gestão de Pedidos e Estoque: Envie automaticamente os detalhes de um pedido concluído para seu sistema de gestão de estoque ou software de faturamento.
  • Automação de Marketing: Ative fluxos de trabalho complexos em plataformas externas (ex. envio de SMS, criação de tarefas) assim que um cliente atingir um determinado objetivo.

Funcionalidades principais

A gestão dos Conectores API se divide nas seguintes funções:

  • Lista e Status: Visualização rápida de todos os conectores configurados, incluindo o tipo de evento monitorado, o endereço de destino e o status (Ativo/Inativo).
  • Definição do Evento: Possibilidade de selecionar a partir de uma lista predefinida qual evento interno (ex. 'Novo Usuário', 'Pedido Pago', etc.) deve disparar a notificação.
  • Endereço de Destino (Endpoint): Configuração da URL exata do serviço externo que deve receber os dados.
  • Personalização dos Dados: Capacidade de definir exatamente quais informações adicionais devem ser enviadas (dados POST) e como devem ser enviadas (parâmetros HEADER).
  • Ativação/Desativação: Controle imediato sobre a operação do conector sem precisar excluí-lo.

Como configurar

Para criar ou modificar um Conector API, é necessário preencher os seguintes campos:

CampoDescriçãoNotas
TipologiaSelecione o evento específico dentro do Framework360 que deve ativar a notificação.Exemplo: "Quando um usuário se registra".
URL de DestinoO endereço web (Endpoint) do sistema externo que receberá os dados.Este campo é obrigatório e deve ser uma URL válida.
AtivoMarque esta caixa para tornar o conector operacional.Se não marcado, o conector não enviará notificações.

Parâmetros personalizados

Esta seção permite definir dados e instruções adicionais para a aplicação externa. Estes campos exigem a inserção de dados em formato estruturado (JSON) para garantir que o sistema receptor possa interpretá-los corretamente.

SeçãoObjetivo
Parâmetros POSTDados enviados no corpo da requisição. Usado para transmitir payloads de informações específicas (por exemplo, chaves de autenticação ou dados adicionais não incluídos automaticamente).
Parâmetros HEADERInformações adicionais enviadas no cabeçalho da requisição. Frequentemente usado para autenticação API (token) ou para especificar o formato dos dados.

Importante: Os dados inseridos nessas seções devem respeitar rigorosamente o formato requerido. Caso contrário, o sistema não salvará a configuração e exibirá uma mensagem de erro.

Integrações automáticas

Este módulo é o coração das automações em tempo real.

Quando o evento selecionado na Tipologia ocorre (ex. um cliente finaliza uma compra), o sistema executa automaticamente as seguintes operações:

1. Coleta as informações relativas ao evento.

2. Constrói uma requisição incluindo quaisquer Parâmetros personalizados definidos.

3. Envia essa requisição à URL de Destino especificada, garantindo que a aplicação externa seja informada imediatamente.

Este processo ocorre em segundo plano e não requer nenhuma interação manual por parte do usuário após a configuração inicial.