Fonctionnement

Introduction

Notre API fonctionne sur le protocole HTTP(S), elle accepte des requêtes de type POST ou GET (encodées en UTF-8) et répond au format JSON. Elle est donc utilisable par tous langages capables d'effectuer une requête HTTP(S) et d'interpréter le JSON comme le PHP, ASP, Python, Java...

Pour utiliser le protocole sécurisé HTTPS, il vous suffit de modifier "http://" par "https://" dans l'adresse des pages appelées.

Important

Pour utiliser notre API envoi SMS vous devez avoir un compte client Spot-Hit (Créez un compte gratuitement) (opens new window). Le paramètre "key" doit être renseigné à chaque requête. Il correspond à une clé unique à récupérer sur votre compte (différente de votre mot de passe) : Récupérer ma clé API (opens new window)

Si vous rencontrez des problèmes lors de l'utilisation de cette API SMS, n'hésitez pas à nous contacter (opens new window), vous serez mis en relation avec notre équipe technique.

Valeurs de retour

Après chaque requete effectuée, vous recevrez une réponse formatée en JSON sous le format suivant :

Voici un exemple de réponse en cas de requête acceptée :

Voici un exemple de réponse en cas de requête rejetée :

Exemple d'utilisation avec PHP (POST et GET)

Envoie d'un SMS avec la méthode HTTP POST (cURL doit être installée)

Envoi d'un SMS avec la méthode HTTP GET (file_get_contents)

Attention

Le nombre de caractères dans une URL est limitée, pour effectuer des envois à un nombre important de destinataires (> 100) ou avec d'autres contenus longs (par exemple un email html), vous devez utiliser la méthode POST mentionnée ci-dessus.

Le paramètre PHP allow_url_fopen doit être activé avec "1".