À propos de Keyyo Partenaires

FAQ

L’API Keyyo met à disposition des développeurs un ensemble d’outils puissants pour intégrer, automatiser et administrer efficacement les services de communication. Que vous découvriez l’API ou que vous souhaitiez optimiser votre intégration, cette FAQ répond aux questions les plus fréquentes concernant son utilisation, l’authentification et les bonnes pratiques à adopter.

Présentation Générale

  • Keyyo propose trois grandes familles d’APIs :
    - API Manager : permet d’administrer et de configurer les services de téléphonie Keyyo.
    - API Metris : destinée aux partenaires Keyyo pour automatiser la gestion de leur parc clients et de leurs services.
    - APIs CTI (Computer Telephony Integration) : permettent d’intégrer les fonctionnalités téléphoniques dans les applications métier (CRM, ERP, applications web, etc.). Elles sont disponibles en version client et serveur.

  • L’API Manager permet d’interroger et de configurer automatiquement les services téléphoniques Keyyo.
    Elle donne notamment accès aux fonctionnalités suivantes :
    - consultation des services souscrits ;
    - gestion des profils de renvoi d’appels ;
    - récupération des détails d’appels ;
    - gestion des listes noires ;
    - consultation des statistiques d’usage ;
    - gestion des plugins CTI.

  • L’API Metris est principalement destinée :
    - aux partenaires Keyyo ;
    - aux revendeurs ;
    - aux intégrateurs ;
    - aux opérateurs administrant un parc de services Keyyo.
    Elle permet d’automatiser les opérations de gestion et d’intégrer les données Keyyo dans les outils métiers ou les portails partenaires.

  • Les APIs CTI permettent d’intégrer la téléphonie directement dans les applications métier.
    Les principaux cas d’usage sont :
    - les notifications d’appels entrants et sortants ;
    - le click-to-call ;
    - les remontées automatiques de fiches clients ;
    - le suivi des événements d’appels ;
    - l’historique des communications ;
    - l’envoi de SMS selon les fonctionnalités utilisées.

  • L’API Manager permet d’administrer les services téléphoniques d’un client (lignes, profils, renvois, statistiques, etc.), tandis que l’API Metris est destinée aux partenaires et permet de gérer un parc complet de clients et de services depuis leurs propres outils.

Authentification

  • Les API Manager et Metris reposent sur le protocole OAuth 2.0.
    Une application doit être enregistrée afin d’obtenir un jeton d’accès (Access Token) qui devra être transmis lors des appels API.

  • Le CSI (Common Service Identifier) est l’identifiant unique d’un service téléphonique Keyyo.
    Il est utilisé dans de nombreux endpoints API pour identifier une ligne ou un service.

  • Le CSI Token est un jeton temporaire associé à un service téléphonique.
    Il est notamment utilisé avec les APIs CTI et possède une durée de validité limitée à une heure.

Cas d’usage fréquents

  • Oui. L’API Manager permet de récupérer les informations relatives aux appels afin d’alimenter des outils de reporting, de supervision ou des applications CRM.

  • Oui. Les APIs CTI permettent de déclencher des appels directement depuis une application métier afin d’améliorer l’expérience utilisateur et de réduire les erreurs de composition.

  • Oui. Les APIs CTI permettent de recevoir les événements téléphoniques et de les exploiter pour afficher automatiquement les informations du correspondant dans un CRM.

  • Oui. Les profils de service peuvent être consultés et modifiés via l’API Manager afin d’automatiser le paramétrage des lignes.

  • Oui. L’API Manager permet de gérer les listes noires associées aux services téléphoniques.

Développement et intégration

  • Administrer des lignes et des services d'un client : API Manager
    Consulter les détails d'appels d'un client : API Manager
    Gérer et superviser le parc clients d'un partenaire : API Metris
    Récupérer des événements téléphoniques avancés : API CTI Client
    Intégrer simplement la téléphonie dans un CRM ou une application métier : API CTI Serveur

  • Oui. Keyyo fournit notamment un client PHP permettant de simplifier l’utilisation de l’API Manager.
    Des exemples d’intégration sont également disponibles sur GitHub.

  • Les APIs Manager et Metris sont des APIs REST exposant des ressources accessibles via HTTP.

Performance et limitations

  • Oui. Certaines limitations concernent notamment l’émission d’appels et l’envoi de SMS.
    Pour certains usages CTI, une limite d’environ un appel par seconde peut s’appliquer.

  • Oui. Une nouvelle tentative peut être effectuée lorsqu’un appel n’a pas pu être établi.

Sécurité

  • Nous recommandons d’appliquer les bonnes pratiques suivantes :
    - utiliser OAuth 2.0 lorsque disponible ;
    - stocker les jetons d’accès de manière sécurisée ;
    - renouveler les jetons avant leur expiration ;
    - appliquer le principe du moindre privilège ;
    - utiliser HTTPS pour l’ensemble des échanges ;
    - ne jamais exposer de secrets applicatifs côté client.

Support et ressources