Ressources · API et commandes

Leads au format JSONLead : spécification

Spécification JSONLead des leads : champs et méthodes de livraison par email, webhook ou SFTP.

Automatiser le flux de ventes et le connecter à votre système de gestion ou ERP n'a jamais été aussi facile. Avec notre système, chaque lead généré sur le portail est envoyé de manière structurée pour que vous puissiez le traiter automatiquement sans complications. Nous vous expliquons ici comment cela fonctionne et comment vous pouvez mettre en œuvre cette intégration.

Format d'envoi : JSONLead comme standard du marché

Pour garantir la compatibilité et la facilité d'intégration, nous utilisons le format JSONLead. Ce format est largement reconnu sur le marché et facilite le traitement automatique des ventes dans les systèmes tiers.

Méthodes d'envoi disponibles

Vous avez trois options pour recevoir les leads. Dans tous les cas, le contenu du lead au format json sera le même.

  • Webhook : L'option la plus rapide et la plus directe. Les leads sont envoyés immédiatement à l'URL de votre système configurée pour les recevoir (requête POST). Si, pour des raisons de sécurité, vous avez besoin de n'importe quel type d'en-tête personnalisé, nous pouvons l'ajouter sans problème.
  • SFTP/FTP : Vous pouvez utiliser notre serveur SFTP ou le vôtre (SFTP/FTP) pour recevoir les données. Un fichier json sera créé pour chaque lead.
  • Email : Si vous préférez, nous pouvons vous envoyer les leads au format JSONLead comme corps d'e-mails.

Exemple de JSONLead envoyé

{
  "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"
}

Détails des champs du JSONLead

NomTypeObligatoireDescription
client.foreign_idstringOuiIdentifiant unique du client.
client.first_namestringOuiNom du client. Selon le portail, il peut s'agir d'un nom d'utilisateur.
client.postal_codestringNonCode postal de l'adresse du client.
client.phonestringNonNuméro de téléphone du client.
client.emailstringNonEmail du client.
sales_lead.origin.sourcestringOuiOrigine de la vente. Ce sera toujours "portal_hero".
sales_lead.origin.mediumstringNonNom du portail d'où provient la vente.
sales_lead.related_urlsarrayNonURL(s) pertinente(s). Normalement l'URL de l'article sur le portail.
sales_lead.custom.accountstringNonEmail ou identifiant du compte sur le portail. Utile lorsque plusieurs comptes sont gérés sur le même portail pour pouvoir identifier le compte d'origine de la vente.
sales_lead.custom.external_idstring/arraystring*OuiIdentifiant unique de l'article. Le même que celui que vous nous envoyez lors de l'envoi des articles.
sales_lead.custom.titlestring/arraystring*OuiTitre du produit vendu.
sales_lead.custom.created_atdatetimeOuiDate et heure de la création de la vente.
sales_lead.foreign_idstringOuiIdentifiant unique de la vente.
sales_lead.inquiryarrayNonConversation tenue avec l'utilisateur sur le portail.
versionstringOuiVersion du schéma de jsonLead. Version 1.0.0 pour le moment.

Avantages de cette intégration

  • Automatisation complète : Traitez automatiquement les leads dans votre système de gestion.
  • Standardisation : Le format JSONLead assure la compatibilité avec la plupart des systèmes du marché.
  • Flexibilité : Choisissez entre webhook, SFTP ou email selon ce qui correspond le mieux à vos besoins.

Intégrez cette solution dans votre flux de travail et optimisez la gestion de vos leads avec rapidité, précision et facilité. Si vous avez besoin de plus de détails ou d'un support technique, contactez-nous ! 🚀