Clés API
Envoyer des SMS depuis vos propres applications avec une clé API SMS.
Une clé API permet à une application de votre entreprise (un logiciel de réservation, un site web, un outil interne) d'envoyer des SMS sans passer par l'écran d'envoi de One. Les SMS envoyés ainsi apparaissent dans l'Historique.
Les clés se gèrent dans SMS › Paramètres, bloc Intégrations, entrée Intégrations.
Réservé aux administrateurs
Cette page est réservée au propriétaire et aux administrateurs du compte, ainsi qu'aux utilisateurs de niveau Admin dans SMS.
Clé API SMS ou jeton de l'API One ?
Ce sont deux choses différentes. La clé API SMS décrite ici sert uniquement à l'adresse d'envoi de SMS affichée sur cette page. Les jetons de l'API One, créés dans les paramètres du compte, donnent accès aux autres modules (voir Paramètres du compte). L'un ne remplace pas l'autre.
Créer une clé
Dans le bloc Clés API, cliquez sur Créer une clé.
Donnez un Nom de la clé qui permet de reconnaître l'application qui l'utilise, par exemple « Site web ». Cliquez sur Créer.
La fenêtre Clé API créée affiche la clé complète. Cliquez sur Copier et collez-la dans votre application.
Copiez la clé tout de suite
La clé complète ne s'affiche qu'une seule fois. Une fois la fenêtre fermée, One n'en montre plus que le début. Si elle est perdue, supprimez-la et créez-en une nouvelle.
Une clé permet d'envoyer des SMS au nom de votre entreprise : traitez-la comme un mot de passe.
Suivre vos clés
Chaque clé affiche son nom, son statut Actif ou Inactif, le début de la clé, sa date de création (Créée le) et sa Dernière utilisation.
- Désactiver une clé : basculez l'interrupteur de sa ligne. L'application qui l'utilise ne peut plus envoyer de SMS, jusqu'à ce que vous réactiviez la clé.
- Supprimer une clé : cliquez sur l'icône corbeille, puis sur Supprimer dans la fenêtre Supprimer la clé API. La suppression est définitive.
Préférez la désactivation si vous voulez seulement couper l'accès un moment.
La documentation intégrée
Sous les clés, le bloc Documentation API donne à votre développeur tout ce qu'il faut pour brancher son application :
- Endpoint : l'adresse à appeler, avec un bouton pour la copier ;
- Paramètres : les champs à envoyer ;
- Exemples de code : en cURL, JavaScript, PHP et Python ;
- Réponse : un exemple de réponse.
La clé se transmet dans l'en-tête X-API-Key de la requête.
| Paramètre | Obligatoire | Contenu |
|---|---|---|
to | Oui | Le numéro du destinataire au format international, ou une liste de numéros. |
message | Oui | Le texte du SMS. |
from | Non | Le nom d'expéditeur. S'il est absent, l'expéditeur par défaut réglé dans les Paramètres est utilisé. |