Tworzenie i unieważnianie tokenów API

Co może token

Token działa w imieniu osoby, która go utworzyła, w zespole aktywnym w tamtej chwili. Może robić tylko to, na co pozwolisz przy jego tworzeniu. Wybierasz jedną z opcji:

  • Steruj ekranami i scenami: podgląd ekranów, treści i scen, wyświetlanie treści na ekranie oraz uruchamianie i zatrzymywanie scen. Użyj tej opcji dla Bitfocus Companion.
  • Tylko odczyt: podgląd ekranów, treści i scen, nic więcej.
  • Pełny dostęp, także tworzenie projektów: wszystko powyższe oraz tworzenie projektów.

Jeśli osoba, która utworzyła token, straci dostęp do zespołu, token przestaje działać.

Utwórz token

  1. Otwórz Ustawienia > Połączenia.
  2. W sekcji Tokeny API kliknij Nowy token API.
  3. Nadaj tokenowi nazwę, na przykład nazwę obiektu albo programu, który go używa.
  4. W polu Dostęp wybierz, co token może robić.
  5. Kliknij Utwórz token.
  6. Kliknij Kopiuj i zapisz token w bezpiecznym miejscu, na przykład w programie, który go potrzebuje.
  7. Kliknij Gotowe.

Token widzisz tylko raz. Jeśli go zgubisz, unieważnij go i utwórz nowy.

Token działa w zespole, który jest aktywny w chwili jego tworzenia. Dla ekranów innego zespołu najpierw przełącz się na ten zespół i utwórz osobny token. Używaj osobnego tokenu dla każdego programu, aby móc unieważnić jeden bez zatrzymywania pozostałych.

Domyślnie tokeny mogą tworzyć właściciel i administratorzy. Zależy to od Twojej roli. Zmienisz to dla każdej roli w artykule Zarządzanie zespołami.

E-mail po utworzeniu tokenu

Gdy ktoś tworzy token, ta osoba i właściciele konta dostają e-mail. Wiadomość podaje, o który token chodzi, kto go utworzył, dla jakiego zespołu, kiedy i co może on robić. E-mail nigdy nie zawiera samego tokenu. Jeśli ten token jest dla Ciebie niespodzianką, natychmiast go unieważnij.

Zobacz tokeny

Karta Tokeny API pokazuje dla każdego tokenu:

  • nazwę i rodzaj dostępu;
  • cztery ostatnie znaki tokenu, aby łatwo odróżnić tokeny;
  • zespół;
  • kiedy był ostatnio używany albo Nigdy nie użyto.

Właściciel widzi tokeny wszystkich osób na koncie. Pozostali widzą tylko własne.

Unieważnij token

  1. Otwórz Ustawienia > Połączenia.
  2. Kliknij Unieważnij obok tokenu.
  3. Potwierdź przyciskiem Unieważnij.

Wszystko, co używa tokenu, od razu przestaje działać.

Tokeny, które wygasają

Token nieużywany przez rok jest unieważniany automatycznie. Token, który nigdy nie był używany, liczy się od dnia utworzenia. Jeśli znów będziesz go potrzebować, utwórz nowy token.

Limit

Konto może mieć ograniczoną liczbę tokenów. Gdy osiągniesz limit, Screenbird poprosi Cię o unieważnienie jednego z nich.

Połączone aplikacje

Aplikacje, które łączysz przez logowanie Screenbird zamiast tokenu, pojawiają się na tej samej stronie we własnej karcie Połączone aplikacje. Kliknij Odłącz, aby usunąć jedną z nich.

Zbuduj własne połączenie

Screenbird ma publiczne API. Wysyłaj token jako token typu bearer z każdym żądaniem. Pełny opis API, ze wszystkimi żądaniami i uprawnieniami wymaganymi przez każde z nich, znajdziesz pod adresem api.screenbird.app/v1/openapi.json.

© screenbird.app