Identifiants et environnements
Trois identifiants, deux environnements, une règle : ne jamais les écrire dans le code.
Vos trois identifiants
Ce sont des UUID que vous obtenez dans le portail Secure Exchanges : voir Obtenir vos identifiants dans le portail. Dans le code, ils s'appellent :
| Identifiant | Nom dans le code |
|---|---|
| Numéro de série de la licence | serial |
| Utilisateur API | apiUser |
| Mot de passe API | apiPassword |
Attention
Vos trois identifiants valent un mot de passe. Quiconque les détient peut envoyer, lire et supprimer des messages en votre nom, et la consommation vous est facturée.
- Ne les écrivez jamais dans le code ni dans un dépôt. Un secret poussé une fois sur un dépôt distant est compromis : régénérez-le.
- Conservez-les dans un gestionnaire de secrets (Azure Key Vault, AWS Secrets Manager, HashiCorp Vault) ou, à défaut, dans un fichier protégé hors de la racine web, lisible seulement par le compte de service.
- Méfiez-vous des variables d'environnement : elles apparaissent dans les vidages mémoire et dans la plupart des rapporteurs d'erreurs.
Obtenir vos identifiants dans le portail
Les identifiants sont générés pour un utilisateur qui a une licence API. Deux façons de les obtenir :
- Par un administrateur, avec la permission de gérer les utilisateurs :
- Dans le portail Secure Exchanges, ouvrez Licences et utilisateurs > Gestion des utilisateurs.
- Sur la ligne de l'utilisateur qui utilisera l'API, cliquez sur l'icône Gérer la licence, attribuez-lui une licence API, puis enregistrez.
- Une icône de clé apparaît alors sur sa ligne : cliquez dessus.
- Par l'utilisateur lui-même, s'il a déjà une licence API : Mon compte > Identifiants API > Recevoir mes clés.
Dans les deux cas, Secure Exchanges envoie à l'adresse de l'utilisateur un message sécurisé qui contient le serial, l'API user et l'API password. Le portail affiche le mot de passe qui ouvre ce message.
Important
- 15 minutes, une seule ouverture. Le message expire 15 minutes après l'envoi et ne s'ouvre qu'une fois : ouvrez-le aussitôt et enregistrez les identifiants dans votre coffre de secrets. S'il a expiré, demandez de nouvelles clés.
- Les nouvelles clés remplacent les anciennes. Demander des clés désactive aussitôt les précédentes de cette licence, ainsi que les connecteurs déjà liés à la licence (Outlook, Gmail…) : mettez à jour chaque application qui les utilise.
Production et préproduction
Vos identifiants de préproduction et de production sont différents : un serial de production ne fonctionne pas en préproduction, et inversement. Testez toujours en préproduction d'abord.
En .NET, la préproduction demande trois réglages, à appliquer avant tout appel et seulement dans votre configuration de test.
Un seul appel choisit l'environnement : il règle à la fois l'adresse de l'API et celle du service qui envoie les courriels.
using SecureExchangesSDK;
Uri endpoint;
if (estPreproduction) // lu dans votre configuration de test, jamais codé en dur
{
endpoint = new Uri("https://preview.secure-exchanges.com/_api/0217/0217.asmx");
// À régler avant tout appel. Ne doit jamais s'exécuter en production.
SettingsHelper.CustomFileHandler = "https://preview.secure-exchanges.com/Handler/ReadFileTob64.ashx";
SettingsHelper.CustomSEMSEndpoint = "https://previewsems.secure-exchanges.com/SEMS_api.asmx";
}
else
{
endpoint = new Uri("https://www.secure-exchanges.com/_api/0217/0217.asmx");
}