Gestion des comptes API

Depuis la page d'accueil, le menu Mes comptes API permet de visualiser la liste des comptes API auquels on a accès et de gérer ces comptes API ainsi que les configurations d'accès API.

La liste des comptes API permet de visualiser certaines informations des comptes API, comme les noms des comptes, le statut du compte et les dates d'expiration des ClientSecrets.

Sur chaque ligne de compte API, un menu situé à droite propose des actions selon l'état du compte :

• Modifier :
  • Ajouter votre référence commande qui sera reprise sur votre facturation
  • bouton Activer le compte / Désactiver le compte
• Activer / Désactiver :
  • Désactiver un compte API : toutes les configurations d'accès API associées seront automatiquement désactivées.
  • Activer à nouveau un compte API : il sera nécessaire d'activer manuellement les configurations d'accès API rattachées.
• Supprimer le compte API

Les trois onglets de la gestion des comptes API

Informations générales

Cette section présente les informations relatives au compte API et aux utilisateurs de la société ayant accès à ce compte. Il permet d'activer ou de désactiver le compte via une coche sur la ligne indiquant le statut du compte.

S'il s'agit d'un compte API Partenaire (modèle 1A ou 1B, ou compte de test), un bloc hébergement présente les informations du domaine auquel est rattaché le compte API.

Si l'utilisateur a les droits de gestion de la société, un bloc supplémentaire apparaît avec la liste des utilisateurs rattachés à la société et permet d'autoriser/interdire l'accès au compte API pour chaque utilisateur.

Configurations d'accès API

Une fois la configuration d'accès réalisée sur le logiciel Silae, la liste des informations liées aux configurations d'accès apparaît sur le portail API dans cet onglet Configurations d'accès API.

Chaque configuration peut se voir attribuer l'un des quatre statuts suivants :

• Activé : L'activation est réalisée dans le portail API par l'éditeur.
• Désactivé : La désactivation est réalisée dans le portail API par l'éditeur.
• Erreur : Ce statut indique une erreur de configuration survenue lors d'un appel.
• Bloqué : Le bloquage et le débloquage sont réalisés par le gestionnaire de paie via le logiciel Silae.

Le symbole "⋮", situé à droite des titres de colonnes, permet d'appliquer des filtres (par date, par ID, etc) pour retrouver plus rapidement une configuration.
Le symbole "⋮" situé en bout de chaque ligne, permet d'ouvrir un menu déroulant qui propose d'éditer ou de désactiver une configuration. Il offre également de regénérer les clés primaires et secondaires depuis ce volet.

Cliquer sur éditer pour accéder à la liste complète des dossiers :

Gestion des ClientSecrets

Cet onglet permet de visualiser le nom du compte ainsi que le client ID. La date d'expiration des ClientSecrets principal et secondaire est également renseignée. Les ClientSecrets principal et secondaire peuvent être régénérés depuis ce même écran. Lorsqu'un ClientSecret est regénéré, le précédent devient obsolète.

➜ Quelle est l'utilité du ClientSecret secondaire ?

Il n'existe pas de différence technique entre le ClientSecret principal et le secondaire. Une fois généré, un ClientSecret est exploité dans l'application de l'éditeur lors de l'authentification. À l'approche de la date d'expiration du ClientSecret principal, il est recommandé de générer un ClientSecret secondaire. En effet, lorsqu'un ClientSecret arrive à expiration, l'application ne peut plus se connecter. Pouvoir remplacer dans l'application le ClientSecret principal par le ClientSecret secondaire (ou vice-versa) permet de fluidifier la transition en évitant une interruption de service.

➜ Pourquoi les ClientSecret disposent-ils d'une date d'expiration ?

L'expiration est une garantie de sécurité pour pallier une éventuelle compromission du ClientSecret du côté de l'application de l'éditeur. La date d'expiration permet de s'assurer que l'accès retrouve régulièrement un niveau de sécurité optimal.