Clés API

Créer une clé SMS dans Cloud

Les clés décrites ici concernent SMS v2. Leur création et leur révocation se font dans BEFIANA Cloud ; les routes publiques SMS v2 ne proposent pas d’opération d’administration des clés.

1. Connectez-vous à l’intégration API SMS dans Cloud et sélectionnez l’organisation de votre intégration.
2. Dans Clés API de l’organisation, renseignez Nom de la clé. Choisissez un nom qui identifie l’application ou l’intégration responsable.
3. Sélectionnez au moins une capacité, en limitant les droits aux opérations nécessaires. Consultez la table des capacités.
4. Cliquez sur Créer une clé API et copiez la valeur complète dans votre gestionnaire de secrets.
5. Fermez la fenêtre après avoir enregistré la clé. Le secret ne sera plus affiché ensuite.

Votre compte Cloud doit avoir accès à l’organisation et disposer de la permission de gérer ses clés API SMS. Si les commandes de gestion ne sont pas accessibles, demandez cet accès à son administrateur. Créer une clé n’active pas automatiquement SMS et n’ajoute pas de crédits.

La valeur copiée commence par bf_sms_. Pour SMS v2, ajoutez Bearer devant cette valeur dans Authorization, comme indiqué dans Authentification. Les indications de Cloud relatives à l’en-tête de v1 ne changent pas cette syntaxe v2.

Conserver le secret

Le secret complet est disponible uniquement à la création. La liste des clés affiche notamment leur nom, leur identifiant, leurs capacités et leur état, mais ne permet pas de récupérer le secret. Si vous l’avez perdu, créez une autre clé et révoquez celle que vous ne pouvez plus utiliser.

Conservez la valeur dans un gestionnaire de secrets ou une configuration serveur protégée. Ne l’intégrez pas au code livré au navigateur, à une application distribuée, à un dépôt ou à une URL. Masquez l’en-tête Authorization dans les journaux et les échanges avec l’assistance. Voir aussi Sécurité.

Préférez une clé par intégration et une clé distincte par organisation. Cela permet de révoquer un accès sans remplacer les identifiants de toutes les applications. Les informations d’utilisation d’une clé aident au suivi de son activité ; elles ne constituent pas un décompte des SMS envoyés ou facturés.

Renouveler une clé

1. Créez une nouvelle clé dans la même organisation, avec les capacités nécessaires.
2. Mettez à jour le secret de l’intégration et vérifiez une opération de lecture autorisée. Par exemple, la consultation du solde exige balance.read.
3. Vérifiez que les instances de votre application utilisent la nouvelle clé, puis révoquez l’ancienne dans Cloud.

La rotation d’une clé API ne remet pas à zéro l’idempotence : pour reprendre un message ou un lot déjà soumis, gardez la même Idempotency-Key, le même chemin et le même corps. Sa portée dépend de l’organisation, pas de la clé API utilisée. N’envoyez pas un SMS supplémentaire pour tester la rotation d’une opération existante.

Pour changer les capacités accordées, créez une clé avec les droits souhaités, puis remplacez et révoquez l’ancienne. Il n’existe pas d’opération publique SMS v2 de modification de ces droits.

Révoquer un accès

Dans la liste Cloud, utilisez l’action de révocation de la clé concernée et confirmez. La révocation empêche les nouvelles authentifications avec cette clé et ne réaffiche pas son secret. Elle ne constitue pas une annulation des messages déjà acceptés ou programmés.

Révoquez une clé devenue inutile ou compromise. Le départ de son créateur ne suffit pas à révoquer une clé organisationnelle : incluez les clés dans votre procédure de retrait des accès.

Limites à connaître

Une clé valide ne dispense pas des contrôles d’activation, de capacités, de crédits et de nom d’expéditeur. Le contrat SMS v2 ne prévoit pas de renouvellement automatique, de durée d’expiration configurable ni de restriction par adresse IP pour ces clés. La création d’une clé supplémentaire n’augmente pas la taille autorisée d’un lot ou le débit disponible. Voir les limites SMS.