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

Référence de l’API (Documentation)

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

• API v2 – recommandée pour les nouveaux projets API RESTful moderne basée sur la spécification OpenAPI 3.0 Lien vers la référence APIv2

• API v1 – pour les projets existants et la rétrocompatibilité API HTTP et JSONRPC simple Lien vers la référence APIv1

En raison du contenu volumineux de la documentation de l’API, celle-ci a été déplacée vers 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 le web-GUI (menu Users). Vous trouverez ci-dessous la description de la procédure d’activation de l’API sur votre appareil.

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

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

• APIv1

• APIv2

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

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

• Pour 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 dans APIv1 & APIv2

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

Dans APIv1, un utilisateur API (clé API unique) a par défaut accès aux ressources de tous les autres utilisateurs (contacts de l’annuaire, groupes, etc.). APIv2 est plus granulaire en matière d’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.