SMSEagle propose de puissantes fonctionnalités API REST intégrées. Cette 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.

• 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 compatibilité ascendante 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 dans un document séparé. Suivez les liens ci-dessus pour trouver chaque spécification de chaque API.

Accès à l’API

Avant de pouvoir utiliser l’API SMSEagle, vous devez activer l’accès API dans l’interface web (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 » mis en évidence.

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

• APIv1

• APIv2

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

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

• 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 et 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 du répertoire, groupes, etc.). 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 aux ressources créées par lui-même. 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.