Lead.php

L'API Lead.php vous permet de transmettre vos prospects à la plateforme afin que ces derniers soit traités directement et de façon totalement automatique

Token

Création d'un token nécessaire à l'identification dans l'API

Afin de créer un token pour l'API veuillez vous rendre dans votre espace dans la rubrique "Source des prospects" et cliquer sur "Ajouter une source"
Nommez cette nouvelle source, par exemple "monsite.com" ou encore "Plateforme Lead" et cliquez sur générer un token.
Copier le token et conservez le précieusement, il vous sera demandé à chaque communication avec l'API (pour des raisons de sécurité ce token ne sera plus affiché par la suite, c'est pourquoi il est important de le copier et de la garder).

Envoi de prospect

Lead.php

/Api/lead.php

Paramètres

Champ Type Description
token obligatoire Texte

Token d'identification, voir ci-dessus pour la création de ce dernier

nom obligatoire Texte

Nom du contact

prénom obligatoire Texte

Prénom du contact

date obligatoire Texte

Date de la demande au format YYYY-MM-DD H:I:S

email obligatoire Texte

Email du contact

telephone obligatoire Texte

Téléphone du contact

id obligatoire Texte

Identification du contact lors des callback

cp obligatoire Numérique

Code postal du contact

ville obligatoire Texte

Ville du contact

adresse obligatoire Texte

Adresse du contact, nécessaire pour calculer les temps de déplacement

type obligatoire Texte

Type de demande (maçonnerie, chauffage, construction, rénovation, etc.)

surface Entier

Surface des travaux

budget Entier

Budget des travaux

terrain Entier

Est-ce que le contact possède un terrain pour une construction de maison : 0 indéterminé, 1 oui, 2 non

callback Texte

URL à appeler pour transmettre les informations de traitement du contact

debug Entier

Passer ce paramètre à 1 permet d'effectuer des appels à l'API sans que les informations ne soient réellement traitées

Retour

Field Description
status

Status du traitement

message

Description du status

    HTTP/1.1 200 OK
    {
      "status": "ok",
      "message": "Inséré avec succès"
    }
    HTTP/1.1 200 OK
    {
      "status": "error",
      "message": "Doublon"
    }

Callback

Callback lorsqu'un lead change de status

Si vous définissez le paramètre callback à l'envoi du contact, nous appellerons la page en y passant les paramètres GET ci-dessous

Paramètres

Champ Type Description
id Texte

Identifiant du contact que vous donné à l'envoi

valide Entier

1 : Traité avec succès, 2 : Traité mais disqualifié, 6 : mauvais numéro

Dernière MAJ - 1.0.1 - 25-04-2019 09:27:30