API-tokens maken en intrekken

Wat een token kan

Een token handelt namens de persoon die het maakte, in het team dat op dat moment actief was. Het kan alleen doen wat jij toestaat bij het maken. Je kiest een van deze opties:

Schermen en scenes bedienen: schermen, content en scenes bekijken, content op een scherm tonen, en scenes starten en stoppen. Gebruik dit voor Bitfocus Companion.
Alleen lezen: schermen, content en scenes bekijken, en verder niets.
Volledige toegang, ook ontwerpen maken: alles hierboven, en ontwerpen maken.

Raakt de persoon die het token maakte de toegang tot het team kwijt, dan werkt het token niet meer.

Een token maken

Ga naar Instellingen > Koppelingen.
Klik onder API-tokens op Nieuw API-token.
Geef het token een naam, bijvoorbeeld de naam van de locatie of van het programma dat het gebruikt.
Kies onder Toegang wat het token mag doen.
Klik op Token maken.
Klik op Kopiëren en bewaar het token op een veilige plek, bijvoorbeeld in het programma dat het nodig heeft.
Klik op Klaar.

Je ziet het token maar één keer. Ben je het kwijt, trek het dan in en maak een nieuw token.

Het token werkt in het team dat actief is op het moment dat je het maakt. Voor de schermen van een ander team schakel je eerst naar dat team en maak je een apart token. Gebruik voor elk programma een eigen token, zodat je er een kunt intrekken zonder de andere te stoppen.

Standaard kunnen de eigenaar en beheerders tokens maken. Je rol bepaalt dit. Je past dit per rol aan in Teams beheren.

Mail bij het maken van een token

Maakt iemand een token, dan krijgen die persoon en de eigenaren van het account een e-mail. De mail vermeldt om welk token het gaat, wie het maakte, voor welk team, wanneer en wat het mag. De mail bevat nooit het token zelf. Verwachtte je geen token, trek het dan meteen in.

Je tokens bekijken

De kaart API-tokens toont per token:

de naam en het soort toegang;
de laatste vier tekens van het token, zodat je tokens uit elkaar kunt houden;
het team;
wanneer het voor het laatst is gebruikt, of Nooit gebruikt.

De eigenaar ziet de tokens van iedereen in het account. Alle anderen zien alleen hun eigen tokens.

Een token intrekken

Ga naar Instellingen > Koppelingen.
Klik naast het token op Intrekken.
Bevestig met Intrekken.

Alles wat het token gebruikt, stopt direct.

Tokens die verlopen

Een token dat een jaar niet is gebruikt, wordt vanzelf ingetrokken. Een token dat nooit is gebruikt, telt vanaf de dag dat het is gemaakt. Maak een nieuw token als je er weer een nodig hebt.

Limiet

Een account kan een beperkt aantal tokens hebben. Bereik je de limiet, dan vraagt Screenbird je eerst een token in te trekken.

Gekoppelde apps

Apps die je koppelt met een Screenbird-login in plaats van een token, staan op dezelfde pagina in een eigen kaart Gekoppelde apps. Klik op Ontkoppelen om er een te verwijderen.

Je eigen koppeling bouwen

Screenbird heeft een openbare API. Stuur je token als bearer-token mee met elk verzoek. De volledige beschrijving van de API, met alle verzoeken en de rechten die elk verzoek nodig heeft, staat op api.screenbird.app/v1/openapi.json.