Créer et révoquer des jetons API

Ce que peut faire un jeton

Un jeton agit au nom de la personne qui l'a créé, dans l'équipe active à ce moment-là. Il ne peut faire que ce que vous lui permettez à la création. Vous choisissez l'un de ces accès :

Piloter les écrans et les scènes : voir les écrans, les contenus et les scènes, afficher un contenu sur un écran, et lancer et arrêter des scènes. Utilisez-le pour Bitfocus Companion.
Lecture seule : voir les écrans, les contenus et les scènes, rien d'autre.
Accès complet, y compris la création de designs : tout ce qui précède, plus la création de designs.

Si la personne qui a créé le jeton perd son accès à l'équipe, le jeton cesse de fonctionner.

Créer un jeton

Allez dans Paramètres > Connexions.
Sous Jetons API, cliquez sur Nouveau jeton API.
Donnez un nom au jeton, par exemple le nom du lieu ou du programme qui l'utilise.
Sous Accès, choisissez ce que le jeton peut faire.
Cliquez sur Créer le jeton.
Cliquez sur Copier et conservez le jeton en lieu sûr, par exemple dans le programme qui en a besoin.
Cliquez sur Terminé.

Le jeton ne s'affiche qu'une seule fois. Si vous le perdez, révoquez-le et créez-en un nouveau.

Le jeton fonctionne dans l'équipe active au moment où vous le créez. Pour les écrans d'une autre équipe, passez d'abord dans cette équipe et créez un jeton distinct. Utilisez un jeton distinct par programme : vous pourrez ainsi en révoquer un sans arrêter les autres.

Par défaut, le propriétaire et les administrateurs peuvent créer des jetons. Cela dépend de votre rôle. Vous modifiez ce droit par rôle dans Gérer les équipes.

E-mail à la création d'un jeton

Quand quelqu'un crée un jeton, cette personne et les propriétaires du compte reçoivent un e-mail. Il indique de quel jeton il s'agit, qui l'a créé, pour quelle équipe, quand, et ce qu'il peut faire. L'e-mail ne contient jamais le jeton lui-même. Si vous ne vous attendiez pas à ce jeton, révoquez-le aussitôt.

Consulter vos jetons

La carte Jetons API affiche, pour chaque jeton :

le nom et le type d'accès ;
les quatre derniers caractères du jeton, pour distinguer les jetons entre eux ;
l'équipe ;
la date de dernière utilisation, ou Jamais utilisé.

Le propriétaire voit les jetons de tous les membres du compte. Les autres ne voient que les leurs.

Révoquer un jeton

Allez dans Paramètres > Connexions.
Cliquez sur Révoquer à côté du jeton.
Confirmez avec Révoquer.

Tout ce qui utilise le jeton s'arrête aussitôt.

Jetons qui expirent

Un jeton resté inutilisé pendant un an est révoqué automatiquement. Un jeton qui n'a jamais servi compte à partir de sa date de création. Créez un nouveau jeton si vous en avez de nouveau besoin.

Limite

Un compte peut avoir un nombre limité de jetons. Quand vous atteignez cette limite, Screenbird vous demande d'abord d'en révoquer un.

Applications connectées

Les applications que vous connectez avec une identification Screenbird, au lieu d'un jeton, apparaissent dans leur propre carte Applications connectées sur la même page. Cliquez sur Déconnecter pour en retirer une.

Créer votre propre connexion

Screenbird dispose d'une API publique. Envoyez votre jeton comme bearer token avec chaque requête. La description complète de l'API, avec toutes les requêtes et les droits qu'exige chacune, se trouve sur api.screenbird.app/v1/openapi.json.