Documentation API ScopTEL Français

Documentation API ScopTEL Français



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:

  1. Établissez une connnection SSH à ScopTel en tant qu’administrateur.
  2. Activez v2.5 avec cette commande : touch /var/www/scopserv/realtime/monitoring/.xapi_daemon
  3. 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:

  1. un API REST qui contient plus de 300 méthodes pour la lecture d’information et l’exécution d’opérations essetielles;
  2. un système de capture d’événements.

Prérequis

Assurez-vous d’avoir la dernière version de ScopTel sur CentOS.

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 :

  1. Dans SCOPTEL, allez à Configuration > Téléphonie > Configuration.
  2. Cliquez sur l’onglet Usager API.
  3. Cliquez Ajouter un nouvel utilisateur API.
  4. Inscrivez un nom d’utilisateur et un mot de passe.
  5. Vous pouvez appliquer des restrictions par tenant, mais nous vous recommendons de ne pas modifier les autres réglages.
  6. Cliquez Ajouter.

API Events

La documentation pour la capture d’événements se trouve à http://<server ip>:5555/api-events/docs.


    • Related Articles

    • ScopTEL - API Documentation English

      API This document explains how to use SCOPDEV v3. SCOPDEV v2.5 (a.k.a. xAPI) is still present for legacy integrations, but is turned off by default. If you wish to continue using v2.5, you must to the following: Establish an SSH connection to ScopTel ...
    • General-Presentation-ScopTEL-ENGLISH

      ScopServ – The Company  ScopServ is a Canadian firm founded in 2004, specializing in information technology.  It designs high-end corporate applications and holds the intellectual property rights for its products and solutions.  A strong actor in ...
    • Press Release: ScopTEL Introduces Context Sensitive Help

      ScopTEL is a constantly evolving product with new features added almost daily. This constant evolution makes updating documentation very difficult, so ScopServ is very pleased to announce that we have added Context Sensitive Help to each and every ...
    • Module20 - ScopTEL IP PBX Software - Reports-Summary

      Introduction to ScopSTATS Reporting Engine Real-time data access (real-time monitoring). Enhanced information tracking thanks to simultaneous access to multiple reports. Simplified and unified filters, easy access to reports (CDR, DAA, RVI...). ...
    • ScopTEL CentOS 6.X BootDisk Installation Guide

      ScopTEL CentOS 6.X BootDisk Installation Guide Previous versions of ScopTEL were either based on CentOS versions 4 or 5 However these versions have limited lifecycle support and it was necessary for ScopServ International to Release an installation ...