API Signal Logement - MTES-MCT/histologe GitHub Wiki

API Signal Logement

📎 Documentation : https://bo.signal-logement.beta.gouv.fr/api/doc

Pré-requis

  • Être connecté au Back-Office avec un compte disposant du rôle Super Administrateur.
  • Avoir identifié en amont :
    • les partenaires ou groupes de partenaires à associer.
    • Une entreprise privée intervenant pour le compte d’un partenaire utilisateur de la plateforme doit fournir un accord de confidentialité signé entre elle-même et son client, utilisateur de la plateforme.
  • Un modèle d'accord de confidentialité se trouve sur le drive HISTOLOGE → 4.Plateforme → 6.Doc → accord_de_confidentialite_api_signal_logement.docx

🧑‍🔬 Recommandation en environnement demo

Créer un compte responsable territoire directement depuis le BO afin de rendre les tests plus concrets et donner de l'autonomie aux utilisateurs d'API.

Les mots de passe devront être partagé par le service https://vaultwarden.incubateur.net/

🛠️ Création utilisateur API

Créer un utilisateur

Depuis le Back-Office, accéder au menu :

  1. Accueil → Outils SA → Permissions utilisateurs API

  2. Cliquer sur « Ajouter un utilisateur API ».

  3. Renseigner l’adresse e-mail de l’utilisateur.

  4. Valider la création de l’utilisateur. Un mot de passe est généré automatiquement et affiché dans un message flash.

⚠️ Point de vigilance support

  • Le mot de passe est affiché une seule fois.
  • Il n’est ni stocké ni récupérable ultérieurement.
  • Doit impérativement être conservé afin de le transmettre via vaultwarden.

👉 En cas de perte du mot de passe, aucune réinitialisation n’est possible : la seule solution consiste à supprimer l’utilisateur API et en créer un nouveau.

🛠️ Gestion des permissions

  1. Sur la liste des utilisateurs API, cliquer sur le bouton d'action
  2. Attribuer les permissions à l’utilisateur API :
  • soit en sélectionnant un ou plusieurs partenaires.
  • soit en sélectionnant un ou plusieurs groupes de partenaires.

ℹ️ Il est possible d’associer plusieurs partenaires et/ou groupes à un même utilisateur API.

⚠️ Partager le mot de passe de manière sécurisé

Générer un lien sécurisé sur https://vaultwarden.incubateur.net afin de partager le mot de passe

  1. Aller sur https://vaultwarden.incubateur.net/#/sends
  2. Cliquer sur Nouveau Send en donnant un nom lisible pour identifier le partage.
  3. Cocher Texte pour puis coller le mot de passe généré depuis la console.
  4. Cocher la case Lors de l'accès à ce Send, masquer le texte par défaut
  5. Définisser les options suivantes :
    • Date de suppression (valeur : 1 semaine après la date de création)
    • Date d’expiration (optionnel) (ex: 48h, privilégier un partage entre lundi et jeudi)
    • Nombre maximum d’accès (optionnel) (ex : 1, si 1 ne mettre personne en copie)

Communication (Exemple mail)

Un compte API a été créé sur la plateforme de production, avec les permissions partenaires suivantes :

  • PARTENAIRE 1
  • PARTENAIRE 2
  • ect..

L’identifiant de connexion est : [adresse-email]

Le mot de passe est disponible via un lien sécurisé à usage unique. [Lien VaultWarden]

Accès et documentation :

Nous restons à votre disposition si besoin

Cordialement, Signal Logement