Bienvenue sur l'API Ouverte U.R.B.S
Vous pouvez dès à présent intégrer les données IMOPE directement dans vos applications, notre service d'API permet d'obtenir de l'information au niveau adresse à partir de quatre points d'entrée :
- Une recherche sémantique "15 rue paix 42000"
- Un identifiant BAN
- Un identifiant cadastral
- Une géolocalisation
POUR ALLER PLUS LOIN
Accédez aux données enrichies, aux prédictions des données manquantes et à un nombre de requêtes plus importants avec notre API+
Pour y accéder : contactez-nous
Comment y accéder ?
Pour interroger notre API, vous aurez besoin d'une clé, cette dernière peut-être générée directement depuis votre compte ONB dans l'onglet "Mon compte" puis "Clé d'API", vous n'avez plus qu'à utiliser l'identifiant généré pour vous identifier.
Vous y trouverez également l'historique des 30 derniers jours d'utilisation des clés liées à votre compte.
À tout moment, vous pouvez régénérer cet identifiant, il remplacera le précédent qui ne pourra plus interroger nos services.
La clé obtenue doit être placée dans les headers Authorization de vos requêtes :
Authorization: Bearer <clé>
Nota : Si vous n'avez pas de compte sur l'ONB, vous pouvez en créer un en cliquant sur ce LIEN
Comment l'interroger ?
L'interrogation de l'API se fait en deux temps :
Tout d'abord, vous devez trouver les identifiants adresses IMOPE qui vous intéressent,
cela se fait au travers d'un des enpoints /addressList qui renvoient une liste d'identifiants adresse correspondants à la demande.
Puis pour obtenir les données de l'adresse, vous interrogez le endpoint /address en spécifiant les identifiants adresse et attributs souhaités.
Le catalogue des attributs disponibles est accessible via le endpoint /catalog.
Le swagger décrivant l'API se trouve ici : Swagger API ouverte
Confidentialité
Les endpoints permettant d'interroger de la donnée sont proposés en deux versions :
- Normale (méthode GET)
- no/low Log (méthode POST)
Les paramètres des appels effectués par la méthode GET sont susceptibles d'être enregistrés dans les logs de différents équipements, si la confidentialité des données que vous interrogez est importante à vos yeux, nous vous recommandons d'utiliser leur version POST.
Chez U.R.B.S, nous conservons évidemment des journaux d'accès afin de suivre les consommations de chacun,nous avons cependant fait le choix d'anonymiser les identifiants adresses appelés, et-ce quel que soit le mode d'appel choisi (GET ou POST).
Quelles limites ?
L'API ouverte est soumises aux restrictions suivantes :
- 15000 interrogations par mois
- 150 appels par minute par IP
- 10 identifiants adresse par appel
Par "interrogation", nous entendons : identifiant adresse appelé sur le endpoint /address et ayant retourné un résultat.
Par exemple : vous appelez 10 identifiants adresse dans une requête, 8 d'entre eux retournent un résultat, nous décomptons 8 appels.
Les endpoints /catalog et /addressList ne sont pas décomptés.