Création de l’offre
Créez une nouvelle offre de données depuis Mes offres > Mes offres de données > Ajouter une offre et choisissez le mode de distribution “API Push”.
L’ensemble des étapes de l’offre sont similaires aux offres par fichier, avec une description de vos données, le choix lié à la visibilité sur la plateforme, les informations liées à la licence et au tarif. La spécificité de ce type d’offre se situe au niveau de l’étape “API”.
Caractéristiques de votre API
Commencez par indiquer la méthode de requête et le format des données qui seront envoyées.
La fréquence de livraison est donnée à titre indicatif pour vos acquéreurs, mais vos données seront en réalité livrées dès que vous les enverrez sur le endpoint fourni.
Les paramètres servent à générer un endpoint sur lequel envoyer vos données afin que la plateforme les redistribue aux acquéreurs. Cette partie est d’autant plus importante qu’elle sert de base aux filtres qui pourront être appliqués sur les données envoyées.
Les filtres
Les filtres permettent à vos acquéreurs de données de paramétrer leur endpoint pour ne s’abonner qu’aux données pouvant les intéresser. Cette fonctionnalité peut être très utile pour éviter du bruit dans les données reçues (ex : je souhaite m’abonner aux données météorologiques mais ne souhaite recevoir que celles de la région me concernant).
Seuls les paramètres obligatoires présents dans le header de la requête peuvent être utilisés comme filtre.
Envoi des données
Pour que chaque acquéreur reçoive les données le concernant, les messages que vous envoyez sur le endpoint fourni par la plateforme ne doivent contenir qu’une seule valeur de chacun des filtres configurés.
Ex : Je définis un filtre “Ville” avec Lyon, Paris, Reims, Dijon, Nantes et un paramètre “Données météo” avec “Température”, “Pression atmosphérique" et “Pluviométrie”.
Je dois envoyer séparément les messages contenant les informations suivantes :
Lyon + Température
Lyon + Pluviométrie
Reims + Température
Reims + Pluviométrie
Gestionnaire du consentement
La vérification du consentement peut être appliquée sur une offre par API push. Elle ne peut être réalisée que si vous avez déclaré des paramètres dans le header filtrables.
Vous pouvez alors sélectionner parmi ces paramètres lesquels correspondent à la famille de données concernée et aux ayants droits.
Endpoint à utiliser
Cliquer sur le bouton “Appliquer la configuration” qui est disponible dès que l’ensemble des paramètres est correctement configuré.
La plateforme génère le endpoint sur lequel vous devez envoyer les données ainsi que la clé d’API nécessaire à l’identification.
A cette étape vous pouvez récupérer :
- un export de ces informations au format OpenAPI (formats 2.0 et 3.0 disponibles)
- un CURL contenant le endpoint généré automatiquement que vous devez compléter avec la clé d’API
- une clé d’API disponible en cliquant sur sur “Copier la clé d’API”
- les codes de réponse (erreur et succès) utilisés pour ce endpoint
- les limites techniques pour l’envoi de requêtes au endpoint
Documentation
Définissez une URL sur laquelle vos acquéreurs pourront consulter une documentation publique afin de faciliter l’utilisation de vos données.