Authentifications API

L’API FasterMessage est l’outil principal pour intégrer les fonctionnalités d’envoi de SMS directement dans vos propres systèmes.

1. Utilisation de l’API FasterMessage #

Définition #

L’API Fastermessage est une API RESTful standard. Elle est conçue pour vous permettre d’envoyer des SMS de manière programmatique à partir de n’importe quelle application.

Plateformes #

L’intégration peut être réalisée sur :

• Application Web
• Application Mobile
• Application Desktop

2. Authentification : Sécuriser vos Échanges #

Pour garantir la sécurité et la fiabilité de toutes vos communications avec l’API, chaque requête HTTPS envoyée à FasterMessage doit inclure un mécanisme d’authentification valide.

Deux méthodes d’authentification sont actuellement prises en charge, offrant un contrôle d’accès strict et une flexibilité pour s’adapter à vos besoins techniques :

2.1. Authentification Basic #

L’authentification Basic repose sur la norme HTTP Basic Authentication.

• Mécanisme : Elle nécessite les étapes suivantes :
  1. Combinaison : Concaténer votre nom d'utilisateur et votre mot de passe (généralement séparés par un deux-points :).
  2. Encodage : Encoder la chaîne obtenue en Base64.
  3. Inclusion : Inclure la chaîne encodée en Base64 dans l’en-tête (Header) de la requête, sous le format : Authorization: Basic [Chaîne Base64].

2.2. Authentification par Clé API et Méthodes Alternatives #

L’authentification par clé API est une méthode de validation d’accès dédiée et simple à intégrer. Elle est particulièrement adaptée aux environnements automatisés ou aux communications serveur-à-serveur, offrant une bonne alternative à l’Authentification Basic.

2.3. Authentification par Clé API #

• Principe : Vous utilisez une clé API dédiée et unique à votre compte, qui doit être transmise dans les en-têtes (headers) de vos requêtes pour valider votre accès.
• Où la trouver : L’interface utilisateur Fastermessage fournit l’accès à votre clé API.

3. Méthodes d’Authentification Acceptées #

FasterMessage offre trois manières distinctes de s’authentifier, dont une seule doit être utilisée par requête :

1. Via le Header « Authorization » (Authentification Basic) #

C’est la méthode standard HTTP Basic Authentication détaillée précédemment.

• Format du Header :Authorization: Basic {username:password encodés en base64 selon votre langage de programmation}
• Mécanisme : Vous devez encoder la concaténation de votre nom d’utilisateur et mot de passe (username:password) en Base64 et préfixer cette chaîne par Basic .
• Identifiants : Vos identifiants (username et password) sont disponibles dans l’interface Développeur.

2. Via les Headers « username » et « password » #

Cette méthode transmet les identifiants en clair (non encodés en Base64) directement dans des en-têtes spécifiques.

• Format des Headers :username: {votre_username} password: {votre_password}
• Mécanisme : C’est une méthode simple, car l’encodage n’est pas nécessaire. Cependant, elle est toujours sécurisée car l’API Fastermessage exige l’utilisation de HTTPS.
• Identifiants : Vos identifiants sont disponibles dans l’interface Développeur.

3. Via le Header « x-api-key » (Authentification par Clé API) #

C’est la méthode d’authentification par Clé API dédiée.

• Format des Headers :x-api-key: {votre_clé_api} OU X-API-KEY: {votre_clé_api}
• Mécanisme : Vous transmettez la clé API (non encodée) directement dans un en-tête personnalisé (x-api-key ou X-API-KEY). L’API reconnaît cette clé et autorise l’accès.
• Clé : Votre clé API est disponible ici.

Remarque Importante : Méthodes HTTP pour l’Envoi de SMS #

Concernant la méthode HTTP à utiliser pour envoyer le SMS :

• Méthode GET : Recommandée uniquement pour les tests.
• Méthode POST : Recommandée pour un usage en production. Le POST est généralement considéré comme plus sûr et plus conforme aux bonnes pratiques RESTful pour les opérations qui modifient l’état (comme l’envoi d’un message).

Exemple de Code : Authentification Basic en PHP #

L’exemple de code fourni illustre la mise en œuvre de la méthode d’Authentification Basic en PHP, un langage de programmation courant pour les applications web.

PHP

<?php
// 1. Définition des identifiants
$username = "My_USERNAME";
$password = "My_PASSWORD";

// 2. Construction de l'en-tête (Header) d'autorisation
//    a) Concaténation des identifiants (username:password)
//    b) Encodage de la chaîne en Base64 (base64_encode)
//    c) Préfixage par "Basic "
$headers = array(
    "Authorization: Basic " . base64_encode($username . ":" . $password)
);

// Les $headers sont ensuite inclus dans la requête cURL ou Guzzle pour communiquer avec l'API
?>

Cet extrait montre clairement comment le langage PHP utilise la fonction base64_encode() pour préparer la chaîne d’authentification requise par la méthode Basic.