Leads em formato JSONLead: especificação

Especificação JSONLead de leads: campos e métodos de entrega por email, webhook ou SFTP.

Automatizar o fluxo de vendas e ligá-lo ao teu sistema de gestão ou ERP nunca foi tão fácil. Com o nosso sistema, cada lead gerado no portal é enviado de forma estruturada para que o possas processar automaticamente sem complicações. Aqui explicamos-te como funciona e como podes implementar esta integração.

Formato de envio: JSONLead como standard de mercado

Para garantir compatibilidade e facilidade de integração, utilizamos o formato JSONLead. Este formato é amplamente reconhecido no mercado e facilita o processamento automático das vendas em sistemas de terceiros.

Métodos de envio disponíveis

Tens três opções para receber os leads. Em qualquer caso, o conteúdo do lead em formato json será o mesmo.

Webhook: A opção mais rápida e direta. Os leads são enviados imediatamente para o URL do teu sistema configurado para os receber (pedido POST). Se por questões de segurança precisares de qualquer tipo de cabeçalho personalizado, podemos adicioná-lo sem problema.
SFTP/FTP: Podes utilizar o nosso servidor SFTP ou um próprio (SFTP/FTP) para receber os dados. Será criado um ficheiro json por cada lead.
Email: Se preferires, podemos enviar-te os leads em formato JSONLead como corpo em correios eletrónicos.

Exemplo de JSONLead enviado

{
  "client": {
      "foreign_id": "1df807f0ba96f8be5529308f6667a144",
      "first_name": "John",
      "postal_code": "76119",
      "phone": "600000000",
      "email": "user@mail.com"
  },
  "sales_lead": {
      "origin": {
          "source": "portal_hero",
          "medium": "Ebay"
      },
      "related_urls": [
          "https://portal.com/item/1234"
      ],
      "custom": {
          "account": "some_email@mail.com",
          "external_id": "1243948",
          "title": "Some pretty product",
          "created_at": "2025-01-17 10:25:22.145432"
      },
      "foreign_id": "17-12583-30383",
      "inquiry": "[{\"created_at\": \"2022-10-31T20:03:21.360000\",\"text\": \"Te dejo mi numero de telefono 6XXXXXXXXX\"}, {\"created_at\":\"2022-10-31T19:50:55.194000\", \"text\": \"Hola!\"}]"
  },
  "version": "1.0.0"
}

Detalhes dos campos do JSONLead

Nome	Tipo	Obrigatório	Descrição
`client.foreign_id`	string	Sim	Identificador único do cliente.
`client.first_name`	string	Sim	Nome do cliente. Consoante o portal pode ser um nome de utilizador.
`client.postal_code`	string	Não	Código postal da morada do cliente.
`client.phone`	string	Não	Número de telefone do cliente.
`client.email`	string	Não	Email do cliente.
`sales_lead.origin.source`	string	Sim	Origem da venda. Será sempre "portal_hero".
`sales_lead.origin.medium`	string	Não	Nome do portal de onde provém a venda.
`sales_lead.related_urls`	array	Não	Url/s relevantes. Normalmente o url do artigo no portal.
`sales_lead.custom.account`	string	Não	Email ou identificador da conta no portal. Útil quando se gerem múltiplas contas no mesmo portal para poder identificar a conta de origem da venda.
`sales_lead.custom.external_id`	string/arraystring*	Sim	Identificador único do artigo. O mesmo que nos enviam no envio de artigos.
`sales_lead.custom.title`	string/arraystring*	Sim	Título do produto vendido.
`sales_lead.custom.created_at`	datetime	Sim	Data e hora da criação da venda.
`sales_lead.foreign_id`	string	Sim	Identificador único da venda.
`sales_lead.inquiry`	array	Não	Conversa mantida com o utilizador no portal.
`version`	string	Sim	Versão do schema de jsonLead. Versão 1.0.0 por agora.

Benefícios desta integração

Automatização Completa: Processa automaticamente os leads no teu sistema de gestão.
Padronização: O formato JSONLead assegura compatibilidade com a maioria dos sistemas do mercado.
Flexibilidade: Escolhe entre webhook, SFTP ou email consoante o que melhor se adapte às tuas necessidades.

Integra esta solução no teu fluxo de trabalho e otimiza a gestão dos teus leads com rapidez, precisão e facilidade. Se precisares de mais detalhes ou suporte técnico, contacta-nos! 🚀