SMSEagle propose de puissantes fonctionnalités API REST intégrées. L’API est dédiée à l’intégration de SMSEagle avec n’importe quel système ou application externe.

Référence API (Documentation)

L’appareil SMSEagle propose deux versions d’API : APIv2 et APIv1.

En raison du contenu volumineux de la documentation API, celle-ci a été déplacée dans un document séparé. Suivez les liens ci-dessus pour trouver la spécification de chaque API.

Accès à l’API

Avant de pouvoir utiliser l’API SMSEagle, vous devez activer l’accès à l’API dans l’interface web (menu Users). Vous trouverez ci-dessous une description de la façon d’activer l’API sur votre appareil.

Capture d’écran du menu « Users » avec le lien « Access to API » indiqué.

L’accès peut être accordé pour :

  • APIv1

  • APIv2

  • Le jeton d’accès API peut être généré ou saisi

  • Pour l’APIv1, l’authentification par utilisateur/mot de passe peut être accordée (à utiliser uniquement pour la compatibilité descendante)

  • Pour l’APIv2, l’accès aux ressources d’autres utilisateurs (créées par d’autres) peut être accordé

  • Des permissions particulières peuvent être accordées pour les méthodes de l’APIv1 et de l’APIv2

Accès aux ressources d’autres utilisateurs dans l’API

Dans l’APIv1, un utilisateur API (clé API unique) a par défaut accès aux ressources de tous les autres utilisateurs (contacts du répertoire, groupes, etc.). L’APIv2 est plus granulaire en ce qui concerne l’accès aux ressources : un utilisateur API (clé API unique) a par défaut accès uniquement aux ressources qu’il a lui-même créées. Si vous souhaitez autoriser l’accès aux ressources de tous les autres utilisateurs, vous devez cocher la case « Access to resources of all users » dans la fenêtre Access to API.