GET /datasets/:id

A propos

Cette ressource permet d'accéder à différents formats de réprésentation d'un jeu de données.

Informations

URL https://api.solutions-territoire.fr/v0/datasets/:id
Disponibilité 0.5.2
Authentification requise Authorization Code ou Client Credentials
Scope requis Données fiscales ou économiques (Selon le jeu de données)
Formats disponibles JSON, GeoJSON & CSV
Code HTTP attendu 200 ou 302 (selon le format)

Notes au sujet des formats JSON et GeoJSON

Certains jeu de données ne sont pas encore disponible en JSON et GeoJSON.
Cela dépend du type de données. Reportez-vous aux points d'API correspondants pour connaitre les formats disponibles.
(Exemple: GET /ca/locaux pour le modéle local)

Notes au sujet de l'obtention des fichiers CSV

Les fichiers CSV sont stockés sur un serveur de fichiers statiques tiers.
Cette ressource vous permet d'obtenir une URL temporaire pour télécharger un fichier CSV depuis ce serveur. Plusieurs méthodes et options sont disponibles pour obtenir cette URL.

Attention : à compter du 31 octobre 2023, ce point d'API ne délivrera plus qu'un seul format du fichier CSV.

L'encodage du fichier CSV ne pourra plus être spécifié lors de la requète : il devra être défini en amont lors de la création du jeu de données. Il pourra être modifier à tout moment dans l'Atelier Serveur. Nous vous invitons dés à présent à vérifier les options d'encodage de vos jeux de données définies dans l'Atelier Serveur.

Cette modification permettra d'améliorer significativement la flexibilité et l'adaptabilité de nos services à vos besoins spécifiques. Elle permettra par ailleurs une mise à jour plus rapide de vos fichiers. Vous pouvez toujours créer plusieurs jeux de données à partir de la même recherche afin de couvrir tous les options d'encodage nécessaires.

Nous restons à votre disposition pour toute question liée à cette mise à jour.

- Redirection

En interrogeant la ressource au format CSV (Accept: text/csv), vous obtiendrez l'URL dans l'en-tête de réponse Location

- Obtention de l'URL en JSON

Si votre client ne gère pas correctement la redirection HTTP, vous pouvez obtenir l'URL en JSON, en ajoutant le paramètre ?csv à l'URL.

- Encodage du fichier

Par défaut, le fichier retourné est encodé en UTF-8.
Pour intégrer le fichier dans Excel, vous devez demander un fichier au format Latin-9 (ISO-8859-15) en modifiant le paramètre encoding dans l'onglet API de l'atelier serveur.

- Expiration de l'URL

Par défaut, l'URL retournée à une validité d'une heure.
Pour obtenir une URL avec une durée de validité plus longue, ajoutez le paramètre ?expires=7200 à l'URL.
La valeur numérique est exprimée en secondes.

- Obtention d'un fichier CSV avec FME Workbench

Consultez les étapes de configuration du workbench.

Exemples

Les exemples ci-dessous utilises la variable $ACCESS_TOKEN décrite dans la section Exemple : authentification en ligne de commande.

Exemple de requête JSON

cURL :

curl -X GET \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  https://api.solutions-territoire.fr/v0/datasets/95ade69a-6aff-45ef-bafd-06052e5d3b86

HTTPie :

http -jv GET https://api.solutions-territoire.fr/v0/datasets/95ade69a-6aff-45ef-bafd-06052e5d3b86 \
  Accept:"application/json" \
  Authorization:"Bearer $ACCESS_TOKEN"

Résultat :

GET /v0/datasets/95ade69a-6aff-45ef-bafd-06052e5d3b86 HTTP/1.1
Accept: application/json
Authorization: Bearer dGCMv3RWEcgWjgeKS5D6IUw0gv2VKmaPqJzZg9mM_3A

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "title":   "Locaux de catégories 7 & 8",
  "version": 3
  "total":   2567,
  "page":    1,
  "model": {
    "type": "local",
    "url":  "https://support.solutions-territoire.fr/api/modeles/local"
  },
  "data":  [
    {
      "id":           "201834017220219027173",
      "annee":        2018,
      "commune":      "Montpellier",
      "codcom":       "340172",
      "invariant":    "20219027173 X",
      "parcelle":     "AB 0025",
      "proprietaire": "SASU FISCALITE ET TERRITOIRE",
      "adresse":      "84 RUE MAURICE BEJART",
      "url":          "/v0/ca/locaux/201834017220219027173"
    },
    ...
  ]
}

Exemple de requête pour obtenir un fichier CSV

cURL :

curl -X GET \
  -H "Accept: text/csv" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  https://api.solutions-territoire.fr/v0/datasets/95ade69a-6aff-45ef-bafd-06052e5d3b86

HTTPie :

http -jv GET https://api.solutions-territoire.fr/v0/datasets/95ade69a-6aff-45ef-bafd-06052e5d3b86 \
  Accept:"text/csv" \
  Authorization:"Bearer $ACCESS_TOKEN"

Résultat :

GET /v0/datasets/95ade69a-6aff-45ef-bafd-06052e5d3b86 HTTP/1.1
Accept: text/csv
Authorization: Bearer dGCMv3RWEcgWjgeKS5D6IUw0gv2VKmaPqJzZg9mM_3A

HTTP/1.1 302 Found
Location: https://static.mon-territoire.fr/datasets/95ade69a-6aff-45ef-bafd-06052e5d3b86-v3.csv?Signature=6kq6XtzBt8zja2tq7S%2FJaAPy90U%3D&Expires=1566213533

Exemple de requête pour obtenir un fichier CSV avec un encodage particulier

cURL :

curl -X GET \
  -H "Accept: text/csv" \
  -H "Accept-Charset: iso-8859-15" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  https://api.solutions-territoire.fr/v0/datasets/95ade69a-6aff-45ef-bafd-06052e5d3b86

HTTPie :

http -jv GET https://api.solutions-territoire.fr/v0/datasets/95ade69a-6aff-45ef-bafd-06052e5d3b86 \
  Accept:"text/csv" \
  Accept-Charset:"iso-8859-15" \
  Authorization:"Bearer $ACCESS_TOKEN"

Résultat :

GET /v0/datasets/95ade69a-6aff-45ef-bafd-06052e5d3b86?csv&encoding=iso-8859-15&expires=7200 HTTP/1.1
Accept: text/csv
Accept-Charset: iso-8859-15
Authorization: Bearer dGCMv3RWEcgWjgeKS5D6IUw0gv2VKmaPqJzZg9mM_3A

HTTP/1.1 302 Found
Location: https://static.mon-territoire.fr/datasets/95ade69a-6aff-45ef-bafd-06052e5d3b86-v3-iso8859.csv?Signature=6kq6XtzBt8zja2tq7S%2FJaAPy90U%3D&Expires=1566213533

Exemple de requête JSON pour obtenir un fichier CSV

cURL :

curl -X GET \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  https://api.solutions-territoire.fr/v0/datasets/95ade69a-6aff-45ef-bafd-06052e5d3b86\?csv

HTTPie :

http -jv GET https://api.solutions-territoire.fr/v0/datasets/95ade69a-6aff-45ef-bafd-06052e5d3b86\?csv \
  Accept:"application/json" \
  Authorization:"Bearer $ACCESS_TOKEN"

Résultat :

GET /v0/datasets/95ade69a-6aff-45ef-bafd-06052e5d3b86?csv HTTP/1.1
Accept: application/json
Authorization: Bearer dGCMv3RWEcgWjgeKS5D6IUw0gv2VKmaPqJzZg9mM_3A

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "title":    "Locaux de catégories 7 & 8",
  "version":  3,
  "total":    2567,
  "encoding": "UTF-8",
  "location": "https://static.mon-territoire.fr/datasets/95ade69a-6aff-45ef-bafd-06052e5d3b86-v3.csv?Signature=6kq6XtzBt8zja2tq7S%2FJaAPy90U%3D&Expires=1566213533"
}

Exemple de requête JSON pour obtenir un fichier CSV avec de nouveaux paramètres d'expiration et d'encodage

cURL :

curl -X GET \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  https://api.solutions-territoire.fr/v0/datasets/95ade69a-6aff-45ef-bafd-06052e5d3b86\?csv\&encoding\=iso-8859-15\&expires\=7200

HTTPie :

http -jv GET https://api.solutions-territoire.fr/v0/datasets/95ade69a-6aff-45ef-bafd-06052e5d3b86\?csv \
  Accept:"application/json" \
  Authorization:"Bearer $ACCESS_TOKEN" \
  encoding==iso-8859-15 \
  expires==7200

Résultat :

GET /v0/datasets/95ade69a-6aff-45ef-bafd-06052e5d3b86?csv&encoding=iso-8859-15&expires=7200 HTTP/1.1
Accept: application/json
Authorization: Bearer dGCMv3RWEcgWjgeKS5D6IUw0gv2VKmaPqJzZg9mM_3A

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "title":    "Locaux de catégories 7 & 8",
  "version":  3,
  "total":    2567,
  "encoding": "ISO-8859-15",
  "location": "https://static.mon-territoire.fr/datasets/95ade69a-6aff-45ef-bafd-06052e5d3b86-v3-iso8859.csv?Signature=6kq6XtzBt8zja2tq7S%2FJaAPy90U%3D&Expires=1566217133
}