API-Tokens erstellen und widerrufen

Was ein Token kann

Ein Token handelt für die Person, die es erstellt hat, in dem Team, das in diesem Moment aktiv war. Es kann nur tun, was du beim Erstellen erlaubst. Du wählst eine dieser Optionen:

Bildschirme und Szenen steuern: Bildschirme, Inhalte und Szenen ansehen, Inhalt auf einem Bildschirm zeigen sowie Szenen starten und stoppen. Nutze das für Bitfocus Companion.
Nur Lesezugriff: Bildschirme, Inhalte und Szenen ansehen, sonst nichts.
Voller Zugriff, auch zum Erstellen von Designs: alles oben Genannte und das Erstellen von Designs.

Verliert die Person, die das Token erstellt hat, den Zugriff auf das Team, funktioniert das Token nicht mehr.

Ein Token erstellen

Gehe zu Einstellungen > Verbindungen.
Klicke unter API-Tokens auf Neues API-Token.
Gib dem Token einen Namen, zum Beispiel den Namen des Veranstaltungsorts oder des Programms, das es nutzt.
Wähle unter Zugriff, was das Token darf.
Klicke auf Token erstellen.
Klicke auf Kopieren und bewahre das Token an einem sicheren Ort auf, zum Beispiel in dem Programm, das es braucht.
Klicke auf Fertig.

Du siehst das Token nur ein einziges Mal. Hast du es verloren, widerrufe es und erstelle ein neues.

Das Token gilt in dem Team, das beim Erstellen aktiv ist. Für die Bildschirme eines anderen Teams wechselst du zuerst zu diesem Team und erstellst ein eigenes Token. Nutze für jedes Programm ein eigenes Token, damit du eines widerrufen kannst, ohne die anderen zu stoppen.

Standardmäßig dürfen der Besitzer und die Administratoren Tokens erstellen. Das hängt von deiner Rolle ab. Du änderst es pro Rolle unter Teams verwalten.

Mail beim Erstellen eines Tokens

Erstellt jemand ein Token, bekommen diese Person und die Besitzer des Kontos eine E-Mail. Sie nennt, um welches Token es geht, wer es erstellt hat, für welches Team, wann und was es darf. Die E-Mail enthält nie das Token selbst. Hast du kein Token erwartet, widerrufe es sofort.

Deine Tokens ansehen

Die Karte API-Tokens zeigt für jedes Token:

den Namen und die Art des Zugriffs;
die letzten vier Zeichen des Tokens, damit du Tokens unterscheiden kannst;
das Team;
wann es zuletzt verwendet wurde, oder Nie verwendet.

Der Besitzer sieht die Tokens aller Personen im Konto. Alle anderen sehen nur ihre eigenen.

Ein Token widerrufen

Gehe zu Einstellungen > Verbindungen.
Klicke neben dem Token auf Widerrufen.
Bestätige mit Widerrufen.

Alles, was das Token nutzt, stoppt sofort.

Tokens, die ablaufen

Ein Token, das ein Jahr lang nicht verwendet wurde, wird von selbst widerrufen. Bei einem Token, das nie verwendet wurde, zählt der Tag, an dem es erstellt wurde. Erstelle ein neues Token, wenn du wieder eines brauchst.

Limit

Ein Konto kann nur eine begrenzte Zahl von Tokens haben. Wenn du das Limit erreichst, bittet Screenbird dich, zuerst eines zu widerrufen.

Verbundene Apps

Apps, die du mit einer Screenbird-Anmeldung statt mit einem Token verbindest, erscheinen auf derselben Seite in einer eigenen Karte Verbundene Apps. Klicke auf Trennen, um eine zu entfernen.

Eigene Verbindung bauen

Screenbird hat eine öffentliche API. Sende dein Token bei jeder Anfrage als Bearer-Token mit. Die vollständige Beschreibung der API, mit allen Anfragen und den Rechten, die jede braucht, findest du unter api.screenbird.app/v1/openapi.json.