Przejdź do treści

Klucze API

Klucz API to dostęp serwer–serwer: dla Twoich skryptów, integracji i systemów, które mają rozmawiać z Kangurem bez człowieka przy klawiaturze.

Zakładanie

Ustawienia → Klucze API → Nowy klucz. Nadaj nazwę mówiącą, co z niego korzysta („eksport do hurtowni”, „skrypt raportów”) — przy pięciu kluczach nazwy typu „klucz 2” nie powiedzą Ci, który wolno wyłączyć.

Klucz widzisz jeden raz

Pełna wartość pokazuje się tylko przy tworzeniu. W bazie trzymamy wyłącznie jej skrót, więc nie potrafimy jej odtworzyć — to ta sama zasada co przy hasłach. Nie zdążyłeś skopiować? Skasuj klucz i załóż nowy.

Użycie

curl -H "X-API-Key: $KLUCZ" https://twoja-instancja/api/orders

Klucz działa w imieniu konta firmy, nie użytkownika: nie zniknie, gdy ktoś odejdzie z zespołu, i nie dziedziczy niczyich uprawnień.

Higiena

  • Osobny klucz na każde zastosowanie. Wtedy wyłączenie jednego nie zatrzymuje reszty.
  • Nigdy w repozytorium ani w przeglądarce. Klucz w kodzie strony jest kluczem publicznym.
  • Wymieniaj po odejściu osoby, która go znała.
  • Kasuj nieużywane. Klucz, o którym nikt nie pamięta, to klucz, którego nikt nie pilnuje.

Klucze specjalne

Poza zwykłymi kluczami panel pozwala wystawić dostęp zgodny z API BaseLinkera — przydatny, gdy masz narzędzie napisane pod BaseLinkera i chcesz je skierować na Kangura bez przepisywania. Obsługiwane metody wypisuje sam panel; wywołanie metody spoza listy zwraca jawny błąd, nie pustą odpowiedź.