Gestion du clé API

Cette section permet de gérer la ou les clés API SMTP2GO propres à ce sous-compte c'est-à-dire les clés qui permettent d'envoyer des e-mails ou d'appeler l'API SMTP2GO au nom de ce sous-compte spécifiquement, indépendamment de la clé API du compte principal.

Le tableau liste, pour chaque clé existante : sa description, sa valeur (masquée par défaut), son statut, les points de terminaison endpoints) autorisés et sa limitation d'envoi personnalisée le cas échéant.

Créer une clé API : 

Cliquer sur « Créer une clé API ». Le formulaire comporte les champs suivants :

• • Description : texte libre permettant d'identifier la clé.
  • Statut de la clé : Autorisée / Bloquée / Bac à sable (sandbox).
  • Endpoints autorisés : liste à sélection multiple des routes de l'API SMTP2GO que cette clé est autorisée à appeler (par exemple « Envoi d'e-mail », « Statistiques : cycle de facturation »...). Si aucun endpoint n'est sélectionné, la route « Envoi d'e-mail » (/email/send) est retenue par défaut SMTP2GO refuse en effet une clé sans aucune autorisation.
  • Limitation d'envoi personnalisée (case à cocher) : si cochée : affiche un nombre d'e-mails maximum et une période, comme pour un utilisateur SMTP.
  • Pool d'IP dédiées (ID) : identifiant numérique optionnel.
  • Suivi des ouvertures / Suivi des clics / Archivage des e-mails : cases à cocher : avec la même signification que pour un utilisateur SMTP.
  • Pied de page de désinscription (case à cocher « Activer le pied de page de désinscription ») : si cochée : affiche un pied de page HTML et un pied de page texte.
  • E-mail d'audit (optionnel).
  • Notifications de rebond : « from » par défaut, « drop », ou une adresse e-mail dédiée.

Valider avec le bouton « Créer ».

IMPORTANT : SMTP2GO ne communique la valeur complète de la clé API qu'une seule fois, au moment de sa création. Le module la conserve chiffrée en base Dolibarr afin de pouvoir ensuite la modifier, la supprimer ou (en interne) l'utiliser pour interroger l'API en son nom. 

Si cet enregistrement local venait à être perdu (purge manuelle de la base, restauration partielle...) alors que la clé existe toujours côté SMTP2GO, le module ne pourra plus la retrouver ni la gérer : il faudrait alors la recréer, puis supprimer l'ancienne directement depuis le tableau de bord SMTP2GO.

Consulter la valeur d'une clé API : 

Dans la colonne « Clé API », la valeur est affichée masquée par défaut (seuls les 8 premiers caractères sont visibles, le reste est remplacé par des astérisques). Une icône « œil » permet d'afficher la valeur complète en clair lorsque celle-ci est disponible localement (c'est-à-dire pour toute clé créée ou synchronisée depuis Dolibarr et dont le secret n'a pas été perdu).

Modifier ou supprimer une clé API

Les actions « Modifier » (crayon) et « Supprimer » (corbeille) ne sont proposées que pour les clés « gérables » depuis Dolibarr, c'est-à-dire celles dont la valeur complète est connue localement. Pour une clé créée directement depuis l'interface SMTP2GO, ou dont le secret local a été perdu, seule une icône d'information « Clé non gérable depuis Dolibarr » est affichée : la gestion de cette clé doit alors se faire depuis le tableau de bord SMTP2GO.

Synchroniser les clés API du sous-compte

Le bouton « Synchroniser les clés API du sous-compte » récupère la liste des clés existantes côté SMTP2GO pour ce sous-compte et met à jour le miroir local : 

• • Les clés déjà connues localement (reconnues par leur valeur en clair : ou à défaut par leur description si SMTP2GO ne renvoie qu'une valeur masquée) sont mises à jour ; 
  • Les clés inconnues localement sont créées en miroir : avec la valeur (éventuellement masquée) renvoyée par SMTP2GO. Un message récapitule le nombre de clés mises à jour et, le cas échéant, le nombre de clés ignorées (lorsque SMTP2GO ne renvoie aucune valeur exploitable pour les identifier).