Documentation API

Bienvenue sur la documentation dédiée à notre API, vous retrouverez ici toute l'aide nécessaire à l'intégration de nos données immobilières.

Introduction

Voici quelques ressources qui vous aideront à explorer notre API.

Nos services webs utilisent le protocole HTTPS sur le port 443, tout accès en HTTP sur le port 80 est bloqué par notre pare-feu. Les échanges de données sont réalisées en JSON.

Méthodes d'authentification

Avant de commencer, vous devez nous contacter

afin d'obtenir un JSON Web Token (JWT)
qui vous permettra de vous identifier à chaque requête

Header (production)

La méthode privilégiée pour s’authentifier est de passer à chaque requête le token dans le header Authorization: Bearer {{ JWT }} en remplaçant {{ JWT }} par votre token.

Query Param (développement)

Il est aussi possible de passer le token directement en query param de la requête https://api.yanport.com/?token={{ JWT }}.

Pour démarrer

Lorsque vous disposez de votre token d’authentification, vous pouvez commencer à explorer notre API grâce au bouton Try it out sur chacun de nos webs services.
Mais au préalable, vous devez vous authentifier en cliquant sur le bouton Authorize, en remplissant l’input Value avec Bearer {{ JWT }}.

Exemple: Bearer eyUEkiLCJh...CHCUiBfD63oxoo=

Limitation

Toutes les requêtes à notre API sont loggées, c’est pourquoi vous devez respecter nos conditions d'utilisation

afin d’éviter tout usage abusif de notre API.