Adlead - Documentation

# Dénonciations

# Dénoncer un lead

Permet de dénoncer un lead sur un programme.

ATTENTION

Un fois un lead dénoncé, il est analysé par Aldead. Selon les règles en place sur le programme, le lead pourra être accepté/refusé immédiatement ou nécessiter un arbitrage humain à réaliser depuis l'interface Adlead.

En cas de traitement automatiquement, le rapport d'analyse ainsi que l'acceptation ou non de la dénonciation sera disponible en moins d'une minute.

# Requête HTTP

POST https://api.adlead.immo/v1/{tenantKey}/programs/{programId}/registrations

# Paramètres d'URL

Nom de la clé Description
{tenantKey} Clé de l'espace client - Détails
{programId} ID du programme

# curl

curl --location --request POST 'https://api.adlead.immo/v1/{tenantKey}/programs/{programId}/registrations' \
    --header 'Accept: application/json' \
    --header 'Content-Type: application/json' \
    --header 'Content-Length: ###' \
    --header 'X-API-Key: VOTRE_CLE_API' \

# Paramètres de Body

IMPORTANT

Il est obligatoire de préciser les nom et prénom du lead ainsi qu'une adresse e-mail et un numéro de téléphone.

Si votre clé API n'est pas associée à un utilisateur, il est nécessaire de préciser le propriétaire du lead dénoncé (owner_id).

# Schéma

Champ Type Description Requis Exemple Format des données
owner_id int ID du prescripteur propriétaire Parfois1 10
title string Civilité mr ms mr = Monsieur / ms = Madame
name string Nom Oui Dupont
firstname string Prénom Oui Jean
email1 string Adresse e-mail Oui jean.dupont@gmail.com
email2 string Adresse e-mail secondaire jean.dupont@gmail.com
phone1 string Téléphone Oui 33600000000 0600000000 Format international ou français
phone2 string Téléphone secondaire 33600000000 0600000000 Format international ou français
city string Ville Paris
zipcode string Code postal 75001
country string Code pays FR Accéder au tableau
address1 string Adresse 12 rue du Louvre
address2 string Adresse 2
comment string Commentaire associée à la dénonciation

(1) Requis uniquement si votre accès API n'est pas associé à un utilisateur

# Exemple

{
  "owner_id": 10,
  "name": "Gilbert",
  "firstname": "André",
  "email1": "test@test.fr",
  "email2": null,
  "phone1": "+33613131312",
  "phone2": null,
  "comment": "Lead dénoncé pour le compte de M. Hervé Dupont"
}

# Body de réponse

DETAILS 
{
    "success": true,
    "message": "Dénonciation créée",
    "body": "La dénonciation de André Gilbert a été créée.",
    "data": {
        "id": 2597,
        "lead_id": null,
        "title": null,
        "name": "Gilbert",
        "firstname": "André",
        "fullname": "André Gilbert",
        "email1": test@test.fr",
        "email2": null,
        "phone1": "+33613131312",
        "phone2": null,
        "city": null,
        "zipcode": null,
        "country": null,
        "address1": null,
        "address2": null,
        "comment": "Lead dénoncé pour le compte de M. Hervé Dupont",
        "status": null,
        "rejection_reason": null,
        "rejection_comment": null,
        "processing_report": null,
        "ruling_required": null,
        "created_by": {
            "id": null,
            "fullname": "Adlead",
            "shortname": "Adlead"
        },
        "updated_by": {
            "id": null,
            "fullname": "Adlead",
            "shortname": "Adlead"
        },
        "owner": {
            "id": 10,
            "fullname": "Prescripteur API",
            "shortname": "API P."
        },
        "processed_by": null,
        "processed_at": null,
        "expires_at": null,
        "created_at": "2022-07-22T12:14:24.000000Z",
        "updated_at": "2022-07-22T12:14:24.000000Z"
    }
}

# Lister les dénonciations

Permet de récupérer la liste des dénonciations d'un programme.

UTILE

Pour obtenir la fiche détaillée d'une dénonciation il est nécessaire de consulter directement sa fiche.

Il n'est possible d'afficher que 50 dénonciations par requête, un système de pagination est en place.

# Requête HTTP

GET https://api.adlead.immo/v1/{tenantKey}/programs/{programId}/registrations

# Paramètres d'URL

Nom de la clé Description
{tenantKey} Clé de l'espace client - Détails
{programId} ID du programme

# Paramètres de requête

Nom du paramètre Description Exemple Format des données Valeur par défaut
page Numéro de la page à afficher 1 1
per_page Nombre d'enregistrements par page 20 50 Entre 1 et 100 50

Détails sur la pagination

# curl

curl --location --request GET 'https://api.adlead.immo/v1/{tenantKey}/programs/{programId}/registrations?page=1&per_page=50' \
    --header 'Accept: application/json' \
    --header 'X-API-Key: VOTRE_CLE_API'

# Body de réponse

DETAILS 
{
    "success": true,
    "message": null,
    "data": [
        {
            "id": 259,
            "lead_id": null,
            "fullname": "Jean Dupont",
            "email1": null,
            "email2": null,
            "phone1": "+336123456789",
            "phone2": null,
            "status": "rejected",
            "ruling_required": 1,
            "owner": {
                "id": 3,
                "fullname": "A Prescripteur",
                "shortname": "Prescripteur A."
            },
            "expires_at": null,
            "created_at": "2021-12-06T10:40:32.000000Z",
            "updated_at": "2021-12-06T10:41:40.000000Z"
        },
        {
            "id": 268,
            "lead_id": null,
            "fullname": "André Gilbert",
            "email1": null,
            "email2": null,
            "phone1": "+33613131313",
            "phone2": null,
            "status": "pending",
            "ruling_required": 1,
            "owner": {
                "id": 3,
                "fullname": "A Prescripteur",
                "shortname": "Prescripteur A."
            },
            "expires_at": null,
            "created_at": "2022-07-22T12:13:31.000000Z",
            "updated_at": "2022-07-22T12:13:34.000000Z"
        }
    ],
    "links": {
        "first": "https://api.adlead.immo/v1/client-a/programs/1/registrations?page=1",
        "last": "https://api.adlead.immo/v1/client-a/programs/1/registrations?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "https://api.adlead.immo/v1/client-a/programs/1/registrations?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "https://api.adlead.immo/v1/client-a/programs/1/registrations",
        "per_page": 50,
        "to": 3,
        "total": 3
    }
}

# Consulter la fiche d'une dénonciation

Permet de récupérer la fiche détaillée d'une dénonciation

# Requête HTTP

GET https://api.adlead.immo/v1/{tenantKey}/programs/{programId}/registrations/{registrationId}

# Paramètres d'URL

Nom de la clé Description
{tenantKey} Clé de l'espace client - Détails
{programId} ID du programme
{registrationId} ID de la dénoncitation

# curl

curl --location --request GET 'https://api.adlead.immo/v1/{tenantKey}/programs/{programId}/registrations/{registrationId}' \
    --header 'Accept: application/json' \
    --header 'X-API-Key: VOTRE_CLE_API'

# Body de réponse

DETAILS 
{
    "success": true,
    "message": null,
    "data": {
        "id": 2267,
        "lead_id": 14409,
        "title": null,
        "name": "Gilbert",
        "firstname": "André",
        "fullname": "André Gilbert",
        "email1": null,
        "email2": null,
        "phone1": "+33613131312",
        "phone2": null,
        "city": null,
        "zipcode": null,
        "country": null,
        "address1": null,
        "address2": null,
        "comment": "Lead dénoncé pour le compte de XXX",
        "status": "approved",
        "rejection_reason": null,
        "rejection_comment": null,
        "processing_report": {
            "message": "Aucun contact avec ces coordonnées n'a été trouvé, vous pouvez accepter la dénonciation."
        },
        "ruling_required": 1,
        "owner": {
            "id": 10,
            "fullname": "Prescripteur API",
            "shortname": "API P."
        },
        "processed_at": "2022-07-22T12:16:20.000000Z",
        "expires_at": "2022-10-20T12:00:00.000000Z",
        "created_at": "2022-07-22T12:14:24.000000Z",
        "updated_at": "2022-07-22T12:16:21.000000Z"
    }
}

# Modèle

Champ Type Description Exemple Format des données
id int ID de la dénonciation 1
lead_id int ID du lead associé, s'il existe 19
title string Civilité mr ms mr = Monsieur / ms = Madame
name string Nom Dupont
firstname string Prénom Jean
fullname string Prénom Nom Jean Dupont
email1 string Adresse e-mail jean.dupont@gmail.com
email2 string Adresse e-mail secondaire jean.dupont@gmail.com
phone1 string Téléphone +33600000000 Format international
phone2 string Téléphone secondaire +33600000000 Format international
city string Ville Paris
zipcode string Code postal 75001
country string Code pays FR Accéder au tableau
address1 string Adresse 12 rue du Louvre
address2 string Adresse 2
comment string Commentaire associée à la dénonciation
status string Statut de la dénonciation pending approved rejected expired Accéder au tableau
rejection_reason string Type de refus already-registered already-known other Accéder au tableau
rejection_comment string Motif du refus Coordonnées incomplètes
processing_report object Rapport d'analyse
ruling_required boolean Arbitrage humain nécessaire
owner object Prescripteur propriétaire
processed_at string Date de traitement 2020-09-04T10:20:04.000000Z ISO 8601
expires_at string Date d'expiration de la dénonciation 2020-09-04T10:20:04.000000Z ISO 8601
created_at string Date de création 2020-09-04T10:20:04.000000Z ISO 8601
updated_at string Dernière mise à jour 2020-09-04T10:20:04.000000Z ISO 8601

# Annexes

# Statuts

Liste des statuts

DETAILS 
[
  {
    "key": "pending",
    "name": "En attente de traitement",
    "description": "En attente de traitement"
  },
  {
    "key": "approved",
    "name": "Acceptée",
    "description": "La dénonciation a été acceptée"
  },
  {
    "key": "rejected",
    "name": "Refusée",
    "description": "La dénonciation a été refusée"
  },
  {
    "key": "expired",
    "name": "Expirée",
    "description": "La dénonciation a expiré"
  }
]

# Types de refus

Liste des types de refus

DETAILS 
[
  {
    "key": "already-registered",
    "name": "Déjà dénoncé",
    "description": "Ce contact a déjà été dénoncé sur ce programme."
  },
  {
    "key": "already-known",
    "name": "Déjà connu",
    "description": "Ce contact est déjà connu sur ce programme."
  },
  {
    "key": "other",
    "name": "Autre",
    "description": ""
  }
]

← Lots →