Se connecter

API

Pilotez une salle depuis votre propre logiciel grâce à l'API client.

Le module complémentaire API donne accès à l'API client WebSocket de la salle. Votre logiciel rejoint la salle comme un présentateur muni d'une télécommande de présentation : il change les diapositives, gère le minuteur du présentateur, déplace le point laser et envoie des messages à l'hôte.

Un pupitre de régie avec un ordinateur portable et un pavé de commande à distance

Ce que vous obtenez

Contrôle des diapositives

Diapositive suivante et précédente, ainsi que première, dernière, accès direct à une diapositive et écran noir lorsque l'application de présentation les prend en charge.

Contrôle du minuteur

Démarrer, arrêter, réinitialiser, ajouter ou retirer 1, 2 ou 5 minutes, utiliser des préréglages de 5 à 20 minutes, ou définir n'importe quelle durée jusqu'à 999 minutes.

Point laser

Déplacez le point laser sur l'écran partagé de l'hôte.

Messages à l'hôte

Envoyez une note de 1000 caractères maximum.

Forfaits

ForfaitAPI
Presenter, Studio HD, Studio 4KAchetez le module complémentaire
Studio 8K, EnterpriseInclus

Aucun écran de l'application ne lui est consacré. Vous l'utilisez depuis votre propre code.

L'acheter

Ouvrir la page du module complémentaire

Connectez-vous, puis ouvrez https://cliqer.io/addons/api.

Choisir une durée

Semaine, mois, année ou achat unique. L'année est sélectionnée par défaut.

Finaliser la commande

Chaque siège de la licence bénéficie de l'API. Consultez Facturation par siège.

L'utiliser

Vérifier la licence

La licence de l'hôte doit inclure le module complémentaire API, ou être une licence Studio 8K ou Enterprise.

Établir la connexion

Connectez-vous à la salle comme décrit dans WebSocket.

Envoyer des commandes

Envoyez des commandes de diapositive, de minuteur, de pointeur et de message. Pour les commandes de minuteur, l'hôte doit autoriser les clics provenant de votre connexion.

Les clés API d'équipe disponibles sur https://cliqer.io/dash/team/api-keys sont une fonctionnalité distincte des forfaits Studio 8K et Enterprise, destinée aux points de terminaison REST. Elles ne permettent pas de se connecter au socket de la salle.
Sans l'API, le socket refuse les commandes et renvoie l'erreur api_not_in_plan.

Limites

ÉlémentLimite
Commandes de diapositive et de minuteur10 par seconde
Messages5 par tranche de 10 secondes
Déplacements du pointeur30 par seconde
Longueur des messages1000 caractères

En cas de dépassement d'une limite, le socket répond rate_limited.

FAQ

Pour aller plus loin

Module complémentaire API

Tarifs et commande.

Référence WebSocket

Chaque message, champ et erreur.

Tous les modules complémentaires

Qui peut acheter quoi, et facturation par siège.