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 10/10/2024

Authentification

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

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.

Format des requêtes

TIP

Les requêtes ont toutes pour url de base https://api.adscore.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.adscore.immo/v1/client-a' \
    --header 'Accept: application/json' \
    --header 'X-API-Key: VOTRE_CLE_API'

Body de réponse

{
    "success": true,
    "message": null,
    "data": {
        "name": "Nom de la clé",
        "tenant": {
            "key": "client-a",
            "name": "Client A"
        }
    }
}