Skip to main content
Tabela kluczy API z typem, zakresem i ostatnim użyciem

Lista kluczy API w panelu sklepu

Klucz API jest sekretem dla programu, nie dla człowieka. Tworzysz go w kontekście konkretnego sklepu i decydujesz, do jakich zasobów ma dostęp.

​
Dwa typy kluczy

Plugin

Wyłącznie oficjalny protokół realizacji w czasie rzeczywistym. Domyślny i zalecany zakres to tylko orders:write.

Sklep (integracja)

Wywołania REST dla jednego sklepu. Nadaj tylko zakres potrzebny raportowi, panelowi albo automatyzacji.
Klucze obejmujące całe konto nie są oferowane. Operacje konta, utworzenie sklepu i akcje tylko dla właściciela wymagają sesji panelu.

​
Utworzenie klucza

1

Wybierz preset

Plugin Minecraft ustawia orders:write. Integracja sklepu proponuje zakres tylko do odczytu. Pełny dostęp wybieraj wyłącznie dla własnego, zaufanego systemu.
2

Nadaj nazwę i typ

Nazwa powinna identyfikować usługę i środowisko, np. „Raporty produkcja”. Typu Plugin nie używaj jako zwykłego klucza REST.
3

Ogranicz uprawnienia

Zaznacz zasób i akcję. write zawiera read, a manage zawiera read, write i delete.
4

Ustaw wygaśnięcie

Dla integracji tymczasowej wybierz datę. Data w przeszłości jest odrzucana.
5

Skopiuj sekret

Pełny klucz jest wyświetlany tylko raz. Zapisz go w menedżerze sekretów; nie w repozytorium ani pliku wysyłanym użytkownikom.

​
Uprawnienia

Katalog obejmuje: Sklep, Produkty, Serwery, Zamówienia, Płatności, Metody płatności, Kody rabatowe, Vouchery, Statystyki, Klucze API i Zespół. Aktualną listę pobiera panel z GET /api/v2/api-keys/permissions.
Członek zespołu może utworzyć lub rozszerzyć klucz tylko do zakresu, który sam posiada. Klucz typu shop jest dodatkowo porównywany z {shopId} w URL. Próba użycia go dla innego sklepu zwraca 403.

​
Użycie

W API reference szukaj endpointów z mechanizmem apiKeyAuth. Nie każdy endpoint Bearer jest dostępny dla klucza. Klucz pluginu łączy się przez Socket.IO zgodnie z przewodnikiem pluginu, a nie przez stary polling REST.

​
Edycja i odwołanie

Na liście widać nazwę, typ, skrócony podgląd, zakres, utworzenie, ostatnie użycie, wygaśnięcie i status. Możesz zmienić nazwę lub zmniejszyć zakres. Po utracie sekretu odwołaj klucz i utwórz nowy — pełnego sekretu nie da się odzyskać. Odwołaj klucz natychmiast, gdy:
  • trafił do logów, czatu, zgłoszenia lub publicznego repozytorium;
  • usługa została wyłączona;
  • nie rozpoznajesz ostatniego użycia;
  • zmienił się właściciel integracji albo serwera.