A propos de l'API

Cette documentation a pour but de décrire l'API REST de Mon Territoire.
Cette API vous donne accès aux données de votre collectivité en JSON.

Cette documentation propose de nombreux exemples fonctionnels, construits avec les commandes cURL ou HTTPie.
La commande jq peut aussi être utilisé pour extraire du JSON.

Version de l'API

Le versionnage de l'API utilise le format major.minor.micro. (cf wikipedia).
L'API est versionnée grâce à l'usage d'un préfix dans l'URL. Seul le numéro majeur de la version est retenu.

Ce préfix peut être omis lorsque vous communiquez avec la dernière version déployée.

Exemple :

https://api.solutions-territoire.fr/v0/datasets
https://api.solutions-territoire.fr/v1/datasets
https://api.solutions-territoire.fr/datasets

Format de requête

Sauf mentions contraires, le format JSON est le format attendu et retourné par défaut.
Lors de l'envoi de chaque requête, n'oubliez pas les en-têtes suivants :

Content-Type: application/json
Accept: application/json

Certaines ressources acceptent d'autres formats comme le GeoJSON, le PDF ou le CSV.
Dans ce cas, vous pouvez demander une autre représentation de la ressource en utilisant l'en-tête approprié ou, si vous ne pouvez pas définit l'en-tête, en ajoutant l'extension adéquate à la fin du chemin de l'URL.

Liste des formats possibles :

Code HTTP

Vous pouvez déterminer le résultat de chaque requête en vérifiant le code HTTP de sa réponse.
Ces codes sont standards et bien documentés sur wikipedia, mais vous trouverez ci-dessous une liste des codes récurrents.