Introduction

Avant de commencer

Cette API est de type REST/JSON.

L'ensemble de nos endpoints (url d'accès) doit être utilisé avec la méthode HTTP adéquate (GET, POST, PUT, PATCH et DELETE).

Note de version

Version de l'API : 1.0

Dernière mise à jour le 16/10/2025

Authentification

Pour utiliser l'API il est nécessaire d'utiliser une clé API secrète.

Cette clé API doit être générée par le propriétaire de l'espace client, chaque clé API est spécifique à un espace client (tenantKey) et ne pourra pas être utilisée sur d'autres espaces client.

Les clés API disposent de deux niveaux de permissions :

• Un accès à un ou plusieurs programmes
• Une liste de permissions donnant accès à certaines opérations seulement

IMPORTANT

Une clé API est une clé secrète utilisée par Adlead pour vous authentifier auprès de nos serveurs.
Afin d'assurer une sécurité maximale pour votre compte vous ne devez jamais diffuser ou rendre public cette clé, veillez à sauvegarder la clé secrète dans un endroit sûr.
Les clés API secrètes ne doivent jamais être visibles dans du code visible côté client.

Liste des permissions globales

Permission	Description
global.lead.view	Accéder à la fiche d'un lead/contact et rechercher un contact
global.lead.create	Ajouter un lead sans programme spécifique

Liste des permissions programme

Permission	Description
information.view	Accéder à la fiche du programme et aux lots allotés
lot-alloted.view	Accéder aux lots allotés à la clé
lot.view	Accéder à l'ensemble des lots
lot.create	Créer des lots
lot.update	Modifier des lots
lot.delete	Supprimer un lot
lead.create	Ajouter un lead sur un programme
lead.view	Accéder à la fiche d'un lead/contact et rechercher un contact
lead.update	Modifier un lead / Créer une action commerciale
registration.view	Accéder aux dénonciations
registration.create	Créer une dénonciation
registration.delete	Supprimer une dénonciation
option.view	Accéder à ses options
option.create	Créer des options
option.update	Modifier des options
option.delete	Annuler ses options
option-extended.view	Accéder à toutes les options
option-extended.delete	Annuler n'importe quelle option
purchase.view	Accéder à ses réservations et ventes
purchase-extended.view	Accéder à toutes les réservations et ventes

Format des requêtes

UTILE

Les requêtes ont toutes pour url de base https://api.adlead.immo/v1/{tenantKey}

Chaque clé est restreinte à un seul espace client qui est identifié par sa clé {tenantKey} (par exemple client-a).

Headers

Tous les appels à l'API doivent se faire avec les headers HTTP suivants :

Nom du header	Valeur
X-API-Key	La clé API fournie
Accept	application/json

Les requêtes de modifications (POST, PUT, PATCH) nécessitent de fournir le header suivant :

Nom du header	Valeur
Content-Type	application/json

Exemple

Requête HTTP

curl --location --request GET 'https://api.adlead.immo/v1/client-a' \
    --header 'Accept: application/json' \
    --header 'X-API-Key: VOTRE_CLE_API'

Body de réponse

{
    "success": true,
    "message": null,
    "data": {
        "tenant": {
            "key": "client-a",
            "name": "Nom du client"
        },        
        "global_permissions": [
            "global.lead.create"
        ],
        "permissions": [
            "information.view",
            "lead.create"
        ],
        "user": {
            "id": 126,
            "fullname": "Jean Dupont",
            "shortname": "J. Dupont"
        },
        "programs": [
            {
                "id": 1,
                "primpromo_id": "00000",
                "name": "Carré Jardin",
                "city": "Nogent-sur-Marne",
                "developer": {
                    "id": 1,
                    "name": "Promoteur A",
                    "city": null,
                    "zipcode": null,
                    "country": null,
                    "address1": null,
                    "address2": null,
                    "files": [
                        {
                            "category": "logo",
                            "category_display": "Logo",
                            "name": "logo.png",
                            "type": "image",
                            "file_url": "http://.../logo.png",
                            "thumbnail_url": "http://.../logo.png"
                        }
                    ],
                    "updated_at": "2020-07-09T18:08:25.000000Z"
                },
                "progress_status": "launch",
                "progress_status_display": "Lancement",
                "status": "activated"
            }
        ]
    }
}