Przejdź do głównej treści
API GetQR jest w wersji beta i jest dostępne dla wybranych obszarów roboczych. Szczegóły mogą się zmienić przed ogólną premierą.
API GetQR uwierzytelnia każde żądanie kluczem API Twojego konta. Każdy użytkownik ma jeden klucz, który działa w Twoim imieniu w jednym obszarze roboczym.

​
Zanim zaczniesz

  • Jesteś właścicielem obszaru roboczego lub edytorem. Przeglądający nie mogą tworzyć ani używać klucza API.
  • Właściciel obszaru roboczego ma aktywną subskrypcję.

​
Tworzenie klucza API

1

Otwórz ustawienia konta

Otwórz ustawienia konta i przejdź do sekcji API.
2

Wygeneruj klucz

Kliknij Generate API key.
3

Skopiuj klucz

Wyświetl klucz i skopiuj go. Klucze zaczynają się od sk_live_.
Klucz możesz wyświetlić i skopiować ponownie w dowolnym momencie. Ustawienia pokazują też, kiedy klucz został utworzony i kiedy był ostatnio użyty.

​
Uwierzytelnianie żądań

Wysyłaj klucz jako token Bearer w nagłówku Authorization każdego żądania:
Sprawdzenie stanu to jedyny endpoint, który działa bez klucza.

​
Dostęp i role

  • Role. Klucz API mogą tworzyć i używać tylko właściciel obszaru roboczego i edytorzy. Przeglądający nie mają takiej możliwości.
  • Obszar roboczy. Każdy klucz należy do jednego obszaru roboczego i każde żądanie jest w nim wykonywane. Nie musisz podawać ID obszaru roboczego.
  • Sprawdzanie na bieżąco. Dostęp jest sprawdzany przy każdym żądaniu na podstawie Twojej obecnej roli i subskrypcji właściciela obszaru roboczego. Twoja własna subskrypcja nie ma znaczenia. Jeśli Twoja rola zmieni się na przeglądającego albo subskrypcja właściciela wygaśnie, żądania zwracają 403, dopóki dostęp nie zostanie przywrócony. Nie potrzebujesz nowego klucza.
  • Usunięcie. Jeśli zostaniesz usunięty z obszaru roboczego, Twój klucz API zostanie usunięty. Jeśli ponownie Cię dodadzą, wygeneruj nowy klucz.

​
Ponowne generowanie klucza

Wygeneruj klucz ponownie, jeśli wyciekł lub dostęp do niego uzyskał ktoś, kto nie powinien go mieć.
Obecny klucz od razu przestaje działać. Każda aplikacja lub integracja, która go używa, przestanie działać, dopóki nie zaktualizujesz jej nowym kluczem.
1

Kliknij Regenerate

W ustawieniach konta przejdź do sekcji API i kliknij Regenerate.
2

Potwierdź

Kliknij Regenerate key.
3

Zaktualizuj swoje aplikacje

Skopiuj nowy klucz i zastąp nim stary wszędzie, gdzie go używasz.

​
Bezpieczeństwo klucza

Traktuj klucz jak hasło: każdy, kto go ma, może tworzyć, zmieniać i usuwać kody QR w Twoim obszarze roboczym.
  • Przechowuj go w zmiennej środowiskowej lub menedżerze sekretów, a nie w kodzie źródłowym.
  • Wywołuj API tylko ze swojego serwera. Nigdy nie umieszczaj klucza na stronie internetowej, w aplikacji mobilnej ani w niczym, co użytkownicy mogą podejrzeć.
  • Udostępniaj go tylko programistom, którzy go potrzebują.
  • Wygeneruj go ponownie, gdy tylko podejrzewasz wyciek.

​
Typowe problemy

Klucz został wygenerowany ponownie albo zostałeś usunięty z obszaru roboczego i klucz został usunięty. Skopiuj aktualny klucz z ustawień konta lub wygeneruj nowy.
Sprawdź, czy masz rolę właściciela lub edytora i czy subskrypcja właściciela obszaru roboczego jest aktywna. Klucz zacznie znowu działać, gdy tylko dostęp zostanie przywrócony.
API jest w wersji beta i nie zostało jeszcze włączone dla Twojego obszaru roboczego.
Są widoczne tylko dla właściciela obszaru roboczego i edytorów, i tylko w obszarach roboczych z włączonym API.

​
Co dalej

Wprowadzenie do API

Błędy