01_Présentation - BaseAdresseNationale/api-depot GitHub Wiki

Présentation

L'api-depot est un système de versionning de fichier BAL.

Il y a quatres moyen de publier une BAL sur l'api-depot:

  • Via mes-adresses
  • Via le moissonneur
  • Via le formulaire de publication
  • Via un client de l'api-depot

Les 3 premiers moyens utilise en réalités des clients de l'api-depot particuliers.

Clients

Un client de l'API est rattaché a une entité qui peut publié une nouvelle version de Base Adresse Locale (BAL) qu'on appelle revision.

Un client de l'API peut avoir :

  • un mandataire technique est la structure (entreprise, service, DSI, logiciel) qui assure la transmission des données. C'est le mandataire qui récupère le jeton pour échanger avec l'API.
  • un chef de file est le référent territorial qui s'engage vis-à-vis de la charte, qui a la responsabilité de coordonner les efforts sur son territoire.

Il existe 3 différents type de clients:

  • Interne: les clients pour les applications interne avec une authentification externe qui ont un mandataire mais pas de chef de file (utilisé principalement pour le moissonneur).
  • habilitation: les clients pour les applications interne qui utilisent une habilitation pour publié qui ont un mandataire mais pas de chef de file (utilisé principalement par mes-adresses).
  • Chef de file: Les clients externes (comme les communes/epcis) qui veulent publié sur l'api-depot. Ces client possède un mandataire et un chef de file avec un périmètre.

Schéma ecosystem

Schema interaction API depot drawio