Bienvenue
Connexion
Ouvrir la navigation

Comment fonctionnent les multi-clés API dans le cadre de l'acquisition d'une offre de données accessibles via API Pull, en OpenAPI ?

La génération et la suppression des clés sont associées au rôle Acquéreur.

Les multi-clés d’API permettent aux acquéreurs de consommer les données acquises par OpenApi en renforçant la sécurité de l’accès aux données.

Génération de multi clés API dans l’acquisition

Une clé est nécessaire par transaction et par acquéreur et peut être générée par personne ou entité qui aura besoin de consommer l’API. L'acquéreur de données peut nommer ses clés d’APIs.

Il faut penser à copier et enregistrer les clés d’API générées car elles ne seront plus affichées par la suite. Un message s’affiche dans le portail participant pour l’indiquer.

Cas d’usage

  • Je souhaite donner accès aux données à un autre membre de mon organisation : je vais créer une clé API et la nommer de façon claire, avec par exemple le prénom et le nom du membre de mon organisation qui utilisera cette clé d'API.

  • Je souhaite donner accès aux données à une personne externe agissant en qualité de sous-traitant et ce de façon temporaire :  je vais créer une clé API et la nommer de façon claire, avec par exemple le nom de l’organisation externe qui utilisera cette clé d'API.

Lorsqu’une offre de données arrive à terme, le participant pourra refaire une acquisition sur cette même offre de données, et utiliser avec la même clé API.

Suppression de multi-clés API dans l’acquisition

Une clé peut être supprimée à tout moment afin de renforcer la sécurité. Il suffit à l’acquéreur de données de se rendre dans l’acquisition concernée et de supprimer la clé souhaitée.

Exporter les données acquises

Deux possibilités s’offrent à l’acquéreur pour exporter les données acquises : 

  • OpenApi via un connecteur cloud : il faut associer un connecteur cloud dans l’acquisition concernée. L’acquéreur devra choisir le standard de spécification OpenAPI OAS à transférer sur son connecteur cloud. Il pourra alors envoyer une clé existante ou en générer une nouvelle.

  • Export OpenAPI : l’acquéreur peut télécharger les caractéristiques de l’API au format OpenAPI (version 2.0 ou 3.0).

  • Si l’acquéreur de données exporte ses données via un connecteur cloud, les nouveaux exports seront générés automatiquement quand le fournisseur de données effectue une mise à jour.

  • Si l’acquéreur de données exporte ses données au format OpenAPI, il devra manuellement refaire les exports dès que le fournisseur de données effectue une mise à jour.

Cette réponse a-t-elle été utile ? Oui Non

Envoyer vos commentaires
Désolés de n'avoir pu vous être utile. Aidez-nous à améliorer cet article en nous faisant part de vos commentaires.