API¶
Ce document explique comment se servir de SCOPDEV v3. SCOPDEV v2.5 (alias xAPI) est encore présent pour supporter les intégrations qui en dépendent, mais est inactif par défaut. Si vous désirez utiliser v2.5, faîtes les étapes suivantes:
Établissez une connnection SSH à ScopTel en tant qu’administrateur.
Activez v2.5 avec cette commande : touch /var/www/scopserv/realtime/monitoring/.xapi_daemon
Redémarrez Realtime avec cette commande : service scopserv_realtime restart
SCOPDEV 2.5 et 3 peuvent être utilisés côte-à-côte sans problèmes, mais la version 2.5 doit être considérée obsolète.
SCOPDEV v.3 a deux composants:
un API REST qui contient plus de 300 méthodes pour la lecture d’information et l’exécution d’opérations essetielles;
un système de capture d’événements.
Prérequis¶
Assurez-vous d’avoir la dernière version de ScopTel sur CentOS6.
Ports¶
Le port par défaut des APIs est le 5555, le même que celui du GUI ScopTel. Si vous modifiez le port du GUI, vous devrez utiliser ce même port pour l’API.
SSL¶
Si l’administrateur active SSL pour une sécurité accrue, l’accès via http:// doit être changé à https://.
API REST¶
L’API REST se trouve à http://<adresse serveur>:5555/api/, où <adresse serveur> est l’adresse IP de votre serveur ScopTel.
Pour accéder à la documentation REST interactive sur votre serveur, vous devez naviguer à l’adresse http://<adresse serveur>:5555/api/docs/. Vous devrez utiliser l’API /authenticate avant de pouvoir utiliser les fonctions interactives des autres API.
Utilisateurs REST API¶
Lors du développement d’une intégration, vous aurez besoin de créer un usager API qui est autorisé à faire les opérations. Pour créer un usager API :
Dans SCOPTEL, allez à Configuration > Téléphonie > Configuration.
Cliquez sur l’onglet Usager API.
Cliquez Ajouter un nouvel utilisateur API.
Inscrivez un nom d’utilisateur et un mot de passe.
Vous pouvez appliquer des restrictions par tenant, mais nous vous recommendons de ne pas modifier les autres réglages.
Cliquez Ajouter.
API Events¶
La documentation pour la capture d’événements se trouve à http://<server ip>:5555/api-events/docs.