Przejdź do treści

Publiczne API

Utwórz klucz API i wybierz jego scope

Utwórz klucz w workspace, w którym będzie działał, przyznaj tylko te scope, których integracja potrzebuje, i przechowuj go jak sekret. Klucz pokazuje się raz — jeśli zginie, unieważnij go i wydaj nowy.

Kroki

  1. Utwórz klucz wewnątrz workspace, którego kodów dotknie. Klucze nie przechodzą między workspace’ami.
  2. Przyznaj najwęższe scope, przy których integracja działa — tylko odczyt, jeśli tylko czyta.
  3. Od razu skopiuj klucz do swojego magazynu sekretów.
  4. Uwierzytelniaj się tokenem Bearer albo nagłówkiem X-Mosaqo-API-Key, zależnie od klienta.
  5. Ograniczaj po adresie, gdzie się da, i rotuj według harmonogramu.

Jak sprawdzić wynik

Wywołaj endpoint tożsamości, na przykład /me. Powinien odpowiedzieć oczekiwanym workspace, co przy okazji potwierdza, gdzie klucz obowiązuje.

Co zwykle idzie nie tak

  • Klucz wrzucony do repozytorium albo wklejony na czacie.
  • Jeden wszechmocny klucz współdzielony przez wszystkie integracje.
  • Klucz utworzony w złym workspace, który potem na wszystko zwraca 403.
Czy to rozwiązało twój problem?

To nie pomogło

Napisz do nas, podając platformę i wersję, wykonane kroki, oczekiwany wynik oraz workspace lub kod QR, którego to dotyczy. Zamaskuj każdy sekret, zanim cokolwiek załączysz.

Napisz do pomocy