Comment souscrire à une API

Ce guide indique les étapes à suivre pour souscrire aux offres API Open+ et APi expert.

L’API Open est en accès libre et ne requiert pas de création de compte ni de souscription. En contrepartie, l’usage de l’API Open est plus restreint (quota, rate limit) et ne permet pas d’avoir accès aux fonctionnalités avancées :

  • Données expertes
  • sélections géospatiales
  • API d’autocompletion (nom de propriétaire, référentiels administratifs…)
  • Calcul de statistiques dynamiques
  • Quotas, rate limit et nombre d’objets retournés par appel bien plus important
  • …

1 Créez un compte utilisateur

Sur le portail

2 Créez une demande de souscription

Pour souscrire à une API, il vous faut créer une application.

  • Connectez-vous à votre compte sur le portail
  • Allez dans l’onglet Applications
  • Cliquez sur Créer une app
  • Complétez le formulaire :
    • à l’étape souscription, chercher l’API BDNB
    • sélectionnez le type de souscription souhaité
    • lisez et validez les conditions générales de vente (il n’est pas nécessaire de laisser un commentaire)
    • Cliquez sur Créer l'application

Votre application a été créé et votre demande de souscription nous a été envoyé. Notre équipe commerciale prendra contact avec vous dans les plus brefs délais.

Pour vérifier que tout s’est bien passé : - Allez dans l’onglet Applications - Sélectionnez l’application que vous venez de créer - Aller dans l’onglet souscription

Vous verrez alors votre demande avec les informations suivantes : - Nom de l’API - Nom du plan (le type de souscription, open plus, ou expert) - Le type d’authentification (api key pour les clés d’API) - la date de souscription - le statut de la demande. A ce stade, elle devrait être En attente

3 Récupérer votre clé d’API

Quand votre demande de souscription est validée : - Allez dans l’onglet Applications - Sélectionnez l’application concernée - Aller dans l’onglet souscription - Cliquez sur votre souscription.

Votre clé apparait dans un volet à droite.

Prenez soin de sécuriser votre clef. En cas de fuite, l’utilisation de celle-ci par d’autre personne sera décompté sur votre quota d’utilisation. En cas de doute, faite nous une demande de réinitialisation de votre clé.

4 Utilisez votre clé d’API

Passez la clé dans le header de vos appels :

import requests
r = requests.get(f'https://api.bdnb.io/v1/bdnb/donnees/batiment_groupe_complet',
                     params={'limit': '5'},
#                     headers= {'X-Gravitee-Api-Key' : <ma-clé-api-expert>}
)
print(len(r.json()[0]))
# >> 172
138

Sans clé d’API :

import requests
r = requests.get(f'https://api.bdnb.io/v1/bdnb/donnees/batiment_groupe_complet',
                     params={'limit': '5'})
print(len(r.json()[0]))
# >> 111
138

5 Suivre votre consommation et vos logs d’appel

  • Allez dans l’onglet Applications

  • Sélectionnez l’application concernée

  • Cliquez sur l’onglet Analytics pour suivre votre consommation

  • Cliquez sur l’onglet Logs pour accéder aux logs de vos appels