Premier pas avec Opendatasoft
Explorer et utiliser les données
Explorer le catalogue et les jeux de données
Explorer un catalogue de jeux de données
Contenu d'un jeu de données
Filtrer des données dans un jeu de données
Introduction à l'API Explore
Introduction à l'API Automation
Présentation de l'API WFS
Télécharger un jeu de données
Créer des cartes et des graphiques
Création de graphiques avancés avec l'outil Graphiques
Présentation de l'interface Cartes
Configurez votre carte
Gérez vos cartes
Réorganiser et regrouper les couches dans une carte
Création de cartes multicouches
Partagez votre carte
Navigation dans les cartes créées avec le créateur de Cartes
Renommer et enregistrer une carte
Créer des pages avec l'éditeur de code
Archivage d'une page
Gérer la sécurité d'une page
Créer une page avec l'éditeur de code
Pages de contenu : idées, conseils et ressources
Comment insérer des liens internes sur une page ou créer une table des matières
Partager et intégrer une page de contenu
Comment dépanner les cartes qui ne se chargent pas correctement
Créer des pages avec le Studio
Créer du contenu avec Studio
Ajouter une page
Publier une page
Modifier la mise en page
Configurer des blocs
Aperçu d'une page
Ajouter du texte
Ajout d'un graphique
Ajouter un bloc image à une page Studio
Ajouter un bloc de carte choroplèthe dans Studio
Ajout d'un bloc de carte de points d'intérêt dans Studio
Ajouter un indicateur clé de performance (KPI)
Configurer les informations d'une page
Utiliser des filtres pour améliorer vos pages
Affiner les données
Gérer l'accès aux pages
Comment modifier l'url d'une page Studio
Ajouter un bloc de carte dans Studio
Les visualisations
Gérer les visualisations sauvegardées
Configurer la visualisation Calendrier
Explorer les différentes visualisations d'un jeu de données
Configurer la visualisation Images
Configurer la vue personnalisée
Configurer la visualisation Tableau
Configurer la visualisation Carte
Comprendre le regroupement automatique dans les cartes
Configurer la visualisation Analyse
Publier des données
Publier vos jeux de données
Créer un jeu de données
Créer un jeu de données à partir d'un fichier local
Créer un jeu de données avec plusieurs fichiers
Création d'un jeu de données à l'aide de connecteurs dédiés à des services distants spécifiques
Créer un jeu de données avec des fichiers multimédias
Fédérer un jeu de données Opendatasoft
Publier un jeu de données
Formats de fichiers pris en charge
Valorisez les données de mobilité grâce au GTFS et autres formats
Gérer les configurations de vos jeux de données
Suppression automatique des enregistrements
Configuration de l'export de jeux de données
Consulter l'historique du jeu de données
Configurer l'info-bulle
Actions et états des jeux de données
Limites des jeux de données
Définir un modèle de données
Comment Opendatasoft gère les dates
Comment et où Opendatasoft gère les fuseaux horaires
Comment trouver l'adresse IP de votre espace de travail
Maintenir les données à jour
Traiter des données
Traduire un jeu de données
Comment configurer une connexion HTTP à l'API de France Travail
Décider quelle licence convient le mieux à votre jeu de données
Formats de fichier source
Fichiers OpenStreetMap
Shapefiles
Fichiers JSON
Fichiers XML
Fichiers de feuille de calcul
Fichiers RDF
Fichiers CSV
Fichiers MapInfo
Fichiers GeoJSON
Fichiers KML
GeoPackage
Les connecteurs
Sauvegarde et partage de connexions
Connecteur Airtable
Connecteur Amazon S3
Connecteur ArcGIS
Connecteur de stockage Azure Blob
Connecteur de base de données
Connecteur Jeu de données de jeux de données (espace de travail)
Connecteur Eco Counter
Connecteur Feed
Connecteur Google BigQuery
Connecteur Google Drive
Comment trouver la clé API Open Agenda et l'URL Open Agenda
Connecteur JCDecaux
Connecteur Netatmo
Connecteur OpenAgenda
Connecteur Realtime
Connecteur Salesforce
Connecteur SharePoint
Connecteur US Census
Connecteur WFS
Connecteur Databricks
Les moissonneurs
Moissonner un catalogue
Moissonneur ArcGIS
Moissonneur ArcGis Hub Portals
Moissonneur CKAN
Moissonneur CSW
Moissonneur FTP avec CSV de métadonnées
Moissonneur Fédération Opendatasoft
Moissonneur Quandl
Moissonneur Socrata
Moissonneur data.gouv.fr
Moissonneur data.json
Les processeurs
Qu'est-ce qu'un processeur et comment l'utiliser ?
Processeur Ajouter un Champ
Processeur Calculer la distance géographique
Processeur Concaténer du texte
Processeur Convertir des degrés
Processeur Copier un Champ
Processeur Corriger les formes géographiques
Processeur Créer un point géo
Processeur Décoder les entités HTML
Processeur Décoder un polyline Google
Processeur Dédupliquer des champs multivalués
Processeur Supprimer un enregistrement
Processeur Déplier le tableau JSON
Processeur Déplier les champs à valeur multiples
Processeur Expression
Processeur Extraire du HTML
Processeur Extraire les URLs
Processeur Extraire la plage de bits
Processeur Extraire d'un objet JSON
Processeur Extraire du texte
Processeur Fichier
Processeur GeoHash en GeoJSON
Processeur de jointure géographique
Processeur Géocoder avec ArcGIS
Processeur Géocoder avec la BAN (France)
Processeur Géocoder avec PDOK
Processeur Géocoder avec le Census Bureau (États-Unis)
Processeur Masquage géographique
Processeur Récupérer les coordonnées d'une adresse 3 mots
Processeur Adresse IP vers Coordonnées Géo
Processeur Tableau JSON vers multivalué
Processeur Joindre des jeux de données
Processeur Méta-expression
Processeur Géocodeur Nominatim
Processeur Normaliser le Système de Projection
Processeur Normaliser une URL
Processeur Normaliser les valeurs Unicode
Processeur Normaliser une date
Processeur Filtrage du polygone
Processeur Remplacer le texte
Processeur Remplacer avec une expression régulière
Processeur Récupérer les divisions administratives
Processeur Définir le fuseau horaire
Processeur Simplifier les formes géo
Processeur Ignorer les enregistrements
Processeur Séparer le texte
Processeur Transformer des colonnes de booléens en champs multivalués
Processeur Transposer des colonnes en lignes
Processeur WKT et WKB en GeoJSON
Processeur what3words
La fonctionalité Formulaire de Collecte de Données
À propos de la fonctionnalité Formulaire de Collecte de Données
Formulaires de collecte de données associé à votre espace de travail Opendatasoft
Créez et gérez vos formulaires de collecte de données
Partager et modérer vos formulaires de collecte de données
Metadonnées des ensembles de données
Analyser l'utilisation de mes données
S'impliquer : partager, réutiliser et réagir
Découvrir et soumettre des réutilisations de données
Partage via les réseaux sociaux
Commenter via Disqus
Suivre les mises à jour d'un jeu de données
Partager et intégrer des visualisations de données
Statistiques d'utilisation
Introduction à l'utilisation des statistiques de vos espaces de travail
Analyser l'activité des utilisateurs
Analyser les actions
Détails sur les champs spécifiques du jeu de données ods-api-monitoring
Comment compter les téléchargements d'un jeu de données sur une période spécifique
Analyser l'utilisation des données
Analyser l'utilisation des ensembles de données
Analyser l'activité du back office
Utilisation de la fonctionnalité de lignage des données
Gérer les groupes et utilisateurs
Gérer les limites
Gérer les utilisateurs
Gestion des utilisateurs
Définition de quotas pour des utilisateurs individuels
Gérer les demandes d'accès
Inviter des utilisateurs sur le portail
Gérer les espaces de travail
Gérer mon portail
Configurer mon portail
Configurer les pages du catalogue et du jeu de données
Configuration d'un catalogue partagé
Partager, réutiliser, communiquer
Personnaliser l'URL de votre espace de travail
Gérer les mentions légales
Connecter Google Analytics (GA4)
Paramètres régionaux
Gérer le suivi
Navigabilité et apparence
Personnaliser votre portail
Personnaliser les thèmes du portail
Comment personnaliser mon portail selon la langue courante
Gérer les thèmes du jeu de données
Configurer les visualisations de données
Configurer la navigation
Ajouter des ressources
License et quotas
Monitoring de la licence et des quotas de votre espace de travail
Licences et quotas de votre espace de travail
Gérer la sécurité
Configurer la politique de sécurité générale de votre portail
L'onglet Sécurité d'un jeu de données
Mapping de vos groupes Opendatasoft avec votre annuaire (via SSO)
Authentification unique (SSO) avec OpenID Connect
Authentification unique (SSO) avec SAML
Paramètres
Langues prises en charge par Opendatasoft
Configuration des paramètres du compte
Gestion des identités
Comprendre les notifications reçues avec vos autorisations
Gestion des notifications
Gestion des clés API
Accessibilité chez Opendatasoft
Enregistrement des applications
Vérification du quota du compte
- Home
- Explorer et utiliser les données
- Explorer le catalogue et les jeux de données
- Introduction à l'API Explore
Introduction à l'API Explore
Une API, ou interface de programmation d'application, est un outil conçu pour permettre à différents systèmes logiciels de communiquer entre eux. Si vous souhaitez utiliser des données stockées quelque part en ligne, l'intérêt d'une API est de vous permettre d'interagir avec ces données d'une manière compréhensible pour la source. Et si vous souhaitez partager vos données avec d'autres, une API vous permet de définir le type d'accès dont ils disposent.
Opendatasoft fournit plusieurs API pour interagir avec la plateforme, mais la principale API utilisée pour accéder aux données publiques d'un espace de travail donné est notre API Explore.
Ce que notre API vous permet de faire
L'API Explore d'Opendatasoft vous donne accès aux données publiques sur la plateforme Opendatasoft. Ainsi, l'API Explore vous permet d'effectuer trois types d'actions :
- Explore : Demandez les enregistrements et les champs que vous aimeriez voir. Les données vous sont fournies dans un objet JSON.
- Exporter : Exporter l'intégralité du jeu de données selon les conditions spécifiées. Pour spécifier les conditions, vous utilisez un langage de requête que nous appelons "ODSQL". ODSQL est notre propre langage de requête, très similaire au langage SQL.
- Analyse : vous pouvez combiner des données au sein d'un jeu de données et/ou effectuer une analyse simple sur un jeu de données.
Par exemple, vous pouvez interroger un jeu de données qui contient des écoles, le nombre d'élèves dans ces écoles et la région où se trouve chaque école, et combiner ces informations en demandant le nombre total d'élèves par région.
Interagir avec l'API
Alors, comment allez-vous réellement utiliser l'API ? La réponse est à la fois simple et compliquée.
Comme nous l'avons vu plus haut, utiliser l'API consiste à lui demander des choses, et à recevoir une réponse. En langage API, vous effectuez un "appel" ou une "requête" et recevez, dans le cas d'ODS, un objet JSON en retour. Ainsi, lorsque vous utilisez l'API, votre appel API est envoyé au serveur Opendatasoft et vous recevez une réponse avec un objet JSON.
Ouvrez une fenêtre de navigateur et collez-y cette URL :
http://data.opendatasoft.com/api/v2/catalog/datasets
. Ce que vous voyez est un objet JSON contenant une sorte de liste des jeux de données, avec des liens vers d'autres objets JSON. Et rappelez-vous que vous pouvez remplacer "data.opendatasoft.com" par n'importe quel domaine Opendatasoft, et vous verrez les données de ce domaine. C'est l'API en action !Bien sûr, en soi, ce n'est pas très intéressant. Mais lorsque d'autres outils sont utilisés, l'API peut être un moyen puissant d'interagir avec les données. Lire la suite pour plus de détails.
En pratique, vous voudrez utiliser certains outils pour rendre l'interaction avec l'API plus pratique et utile. Par exemple, les appels d'API peuvent être effectués à l'aide de plates-formes telles que PostMan conçues pour interagir avec les API. Si vous êtes développeur, vous pouvez utiliser la bibliothèque de requêtes Curl ou Python.
Explorer les données
Comme nous l'avons vu ci-dessus, l'exploration des données est l'un des trois types d'actions que vous pouvez effectuer avec l'API Explore. En explorant les données, nous voulons dire que vous pouvez demander des enregistrements à partir d'un ensemble de données public afin de les traiter et de les utiliser de votre côté.
Il existe des méthodes que vous pouvez utiliser (et des limites à connaître) lorsque vous spécifiez les données que vous souhaitez recevoir :
- Select : vous pouvez sélectionner une plage spécifique de colonnes
- Where : vous pouvez filtrer les données en fonction d'une condition
- Order by : vous pouvez l'utiliser pour trier selon une colonne désignée
- Limit/offset : vous pouvez limiter les enregistrements renvoyés ou accéder directement à un enregistrement spécifique
- Group by : vous pouvez regrouper les données en fonction de certaines valeurs de champ ou de fonctions appliquées à ces champs.
Exportation des données
Les appels d'API sont limités à 100 enregistrements par appel. Mais si vous avez besoin de gérer toutes les données à la fois, vous pouvez exporter l'intégralité des données.
Les mêmes méthodes répertoriées sous "Explorer les données" peuvent être utilisées pour personnaliser vos demandes.
Analyse des données
Après avoir exploré ou exporté les données, vous souhaiterez peut-être effectuer une analyse de base sur celles-ci. C'est ce qu'on appelle l'agrégation, et vous pouvez utiliser différentes fonctions pour combiner ou agréger les données de manière productive :
- avg (moyenne)
- count
- count distinct
- envelope
- bbox
- max (maximum)
- median
- min (minimum)
- percentile
- sum
Ces fonctions s'appliquent à des "groupes" qui peuvent être définis par la méthode "group by", décrite ci-dessus.
Cela peut être utile si, par exemple, vous souhaitez obtenir le total des dépenses chaque mois, lorsque votre jeu de données est une liste de dépenses et leurs dates. Dans ce cas, vous pouvez regrouper les dépenses par mois et effectuer une somme de la colonne des dépenses. De cette façon, même avec une petite quantité d'analyses, vous pouvez commencer à comprendre et à utiliser réellement les données brutes. Et, selon la façon dont vous utilisez l'API, vous pouvez le faire de manière standardisée, automatisée ou évolutive.
Pourquoi passer à la version 2 ?
Différences et avantages de la v2 :
V1 | V2 | |
Utiliser le paradigme | 3 points d'accès principaux pour le catalogue et le jeu de données : "/search" pour récupérer les données "/analyse" pour utiliser la fonction d'agrégation "/download" pour exporter les données | Deux points de terminaison principaux pour le catalogue et jeu de données : - "/records" pour récupérer ou effectuer des analyses de données sur un échantillon du jeu de données (10 000 enregistrements max) - "/exports" pour exporter le jeu de données complet dans les différents formats disponibles Les deux points de terminaison utilisent notre langage ODSQL, qui fournit entre autres des fonctions d'agrégation. |
Exports | • Tous les formats d'export ne sont pas disponibles • Group_by n'est pas pris en charge | • Tous les formats d'export sont disponibles • Group_by pris en charge |
Utilisations internes et externes | Utilisé uniquement par les anciens outils ODS | Utilisé par le Studio et d'autres services externes (WFS, CSW, AUTOMATION, ...) |
Encodage d'URL | Besoin d'échapper certains caractères spéciaux, par exemple « # » | Pas besoin d'échapper les caractères spéciaux |
Cartographie des paramètres :
V1 | V2 |
q, sort | Utilisez plutôt select, where, order_by, et group_by de notre langage ODSQL |
dataset | dataset est dans le endpoint, ce n'est plus un paramètre |
rows & start | Deviennent limit et offset (mais gardent le même sens) |
refine.<facet_name>=<face_value> exclude.<facet_name>=<face_value> | refine=<facet_name>:<face_value> exclude=<facet_name>:<face_value> |
lang, timezone | Aucun changement |
Traduction de requête :
Exemple avec ce portail : https://documentation-resources.opendatasoft.com
V1 /api/records/1.0 | V2 /api/explore/v2.1 |
|
|
|
|
|
|
Quelle destination maintenant?
J'espère que vous comprenez mieux maintenant pourquoi une API peut être utile et que vous avez une idée de ce qu'Opendatasoft vous permet de faire avec l'API Explore.
Il ne fait aucun doute que l'utilisation d'une API n'est pas pour tout le monde. Mais avec un peu de travail, l'API peut vous permettre de mieux comprendre et d'utiliser efficacement vos propres données ou d'autres données publiques.
Pour répondre à vos questions et vous aider sur votre chemin, nous vous invitons à plonger dans notre documentation pour l'API Explore !