Prise en main

Qu’est-ce qu’une API ?

Une API est une interface, un contrat passé entre deux systèmes informatiques pour leur permettre de communiquer. Cette solution informatique permet d’automatiser des tâches depuis votre ordinateur ou vos serveurs.

A partir de l’API de data.gouv.fr, vous pouvez réaliser les mêmes actions que sur la plateforme :

• Créer un jeu de données au nom de votre compte utilisateur ou au nom de votre organisation ;

• Décrire votre jeu de données et les ressources associées ;

• Ajouter ou supprimer une ressource ou un jeu de données.

L’API de data.gouv.fr propose également des fonctionnalité complémentaires à la publication de jeux de données comme la possibilité de récupérer les métadonnées des jeux de données ou de fichiers ou encore d'accéder au contenu des fichiers d’un jeu de données.

Quand utiliser l’API de data.gouv.fr ?

À la différence du mode de mise à disposition directe des données sur data.gouv.fr, l’utilisation de l’API permet de réaliser des actions de manière automatisée depuis votre ordinateur ou vos serveurs. Il est par conséquent conseillé d’utiliser une API lorsque la fréquence de publication d’un jeu de données est régulière. Voir la différence entre API et moissonnage.

L’utilisation de l’API de data.gouv.fr se fait par le point d’entrée racine de l’API. Afin de pouvoir exécuter des opérations d’écriture, il est nécessaire d’obtenir une clé API. Cette clé est accessible depuis les paramètres de votre profil administrateur.

Les appels à l’API sont soumis aux mêmes permissions que l’interface web. Par exemple, si vous souhaitez publier ou modifier un jeu de données au nom d’une organisation, vous devez appartenir à cette organisation.

Racine

Le point d’entrée racine de l’API est https://www.data.gouv.fr/api/1/.

Si vous souhaitez faire des tests sur la plateforme demo.data.gouv.fr, le point d’entrée racine de l’API est https://demo.data.gouv.fr/api/1/.

Dans la suite de cette documentation, il y sera fait référence par $API.

Authentification

De façon à pouvoir exécuter des opérations d’écriture, vous devez commencer par obtenir une clé d’API dans les paramètres de votre profil.

Cette clé doit être fournie dans l’entête HTTP X-API-KEY à chaque appel en écriture (POST,PUT, PATCH et DELETE).

Autorisations

Les appels d’API sont soumis aux même permissions que l’interface web.

Par exemple, vous devez être membre d’une organisation pour modifier l’un de ses jeux de données.

Par défaut, un jeu de données créé via l’API est public. Afin de créer et maintenir un jeu de données en brouillon, il faut mettre l’attribut private: true dans chaque appel à l’API. Sinon, chaque modification d’un jeu de données par l’API va le passer en public.

Formats de données

Content-type

Les différents points d’entrée de l’API attendent du JSON (application/json) en entrée et renvoient du JSON en sortie. Les seules exceptions sont les points d’entrée qui gèrent l’upload de fichiers : ils acceptent du multipart/form-data et renvoient du JSON.

Identifiants d’URL

À chaque fois que vous pouvez utiliser un identifiant d’objet dans une URL de l’API, vous avez les choix suivants :

• l’identifiant technique permanent (ex: 5bbb6d6cff66bd4dc17bfd5a)

• le slug (ex: mon-dataset)

Par exemple, un dataset 5bbb6d6cff66bd4dc17bfd5a dont le slug est mon-dataset, vous pouvez accéder à l’URL $API/datasets/<dataset>, par:

• $API/datasets/5bbb6d6cff66bd4dc17bfd5a

• $API/datasets/mon-dataset

Le slug d’un objet peut-être amené à changer si le producteur change le nom de l’objet alors que l’identifiant technique lui ne change jamais. Il est donc préférable d’utiliser les identifiants techniques dans les scripts qui doivent être durables et rejouables.

Listes simples

Les listes simples sont renvoyées sous forme d’une liste JSON.

Par exemple, la liste des types de réutilisations:

[
  { "id": "paper", "label": "Papier" },
  { "id": "application", "label": "Application" },
  { "id": "hardware", "label": "Objet connecté" },
  { "id": "api", "label": "API" },
  { "id": "visualization", "label": "Visualisation" },
  { "id": "post", "label": "Article de blog" },
  { "id": "news_article", "label": "Article de presse" },
  { "id": "idea", "label": "Idée" }
]

Pagination

Certaines méthodes sont paginées et suivent le même modèle de pagination. La liste d’objets est encapsulée dans un objet Page.

Vous n’avez pas à calculer vous-même les pages précédentes et suivantes puisque les URL sont disponibles dans la réponse dans les attributs previous_page et next_page. Ils seront définis à null si il n’y a pas de page précédente et/ou suivante.

Exemple:

{
    "data": [{...}, {...}],
    "page": 1,
    "page_size": 20,
    "total": 10,
    "next_page": "https://www.data.gouv.fr/api/endpoint/?page=2",
    "previous_page": null
}

Gestion d’erreurs

La gestion d’erreur de l’API utilise les codes d’erreur HTTP standards :

• 400 : requête invalide

• 401 : authentification requise

• 403 : permissions insuffisantes

• 500 : erreur indéfinie côté serveur

• 502 : le serveur ne répond pas

Lorsque c’est possible, l’API répondra en JSON avec le format suivant :

{
  "message": "un message d’erreur"
}

Erreur 423

En cas d’activités suspectes ou de spams répétés, l’API pourra retourner l’erreur 423, empêchant ainsi toute nouvelle création d’utilisateur ou de contenu, à l’exception des ressources (hors ressources communautaires).

{
  "message": "Due to unusual activities, the creation of new content is currently disabled."
}

Support

Si vous n’arrivez pas à comprendre une erreur, que vous avez besoin de support et souhaitez contacter l’équipe de data.gouv.fr, pensez à fournir les éléments suivants :

• la requête HTTP effectuée (avec les entêtes HTTP)

• la réponse éventuelle du serveur (avec ses entêtes)

• la date et l’heure de la requête

• un peu de contexte sur la raison de cette requête, son cadre

Parfois, la réponse en erreur comprend une entête X-Sentry-ID. Pensez à fournir cet identifiant, il nous permettra de comprendre précisement ce qui ne va pas et, si c’est un bug, à le corriger.