Klucze API

Klucz API pozwala programowi korzystać z API Omnilinkera bez logowania się człowieka: narzędziu do raportów, sklepowi internetowemu albo middleware, które przenosi zamówienia. Otwórz Klucze API w menu głównym, aby tworzyć klucze i nimi zarządzać. Strona jest w Administracja > Ustawienia, w grupie Integracje > Klucze API, pod adresem /settings/integrations/api-keys; pozycja menu jest skrótem do niej. Klucz działa w imieniu osoby, która go utworzyła, i tylko w zakresie wybranego dla niego dostępu. Nigdy nie może więcej niż jego właściciel:

• Klucz może użyć uprawnienia tylko wtedy, gdy klucz je dostał i jego właściciel nadal je ma. Jeśli stracisz uprawnienie, Twoje klucze też je stracą.
• Klucz przestaje działać, gdy konto właściciela zostanie dezaktywowane lub zablokowane.
• Niektórych uprawnień klucz nigdy nie dostanie, bez względu na to, co ma właściciel; zobacz Czego żaden klucz nie może.

Jak program wysyła klucz, opisuje strona Uwierzytelnianie.

​

Uprawnienia

Uprawnienia znajdziesz w edytorze ról w grupie Klucze API. Edytować, wymieniać i zmieniać dostęp możesz tylko swoich kluczy, nawet z uprawnieniem Podgląd i zarządzanie wszystkimi kluczami w organizacji. Żaden klucz API nie może mieć żadnego z tych uprawnień.

​

Tworzenie klucza

Wybieraj Nigdy tylko dla klucza, którego ktoś pilnuje: pozostaje ważny, dopóki go nie usuniesz.

​

Szablony

Szablon nadaje tylko to, co sam masz; resztę pomija.

​

Wybór, co klucz może robić

Kliknij Dostosuj dostęp…, aby otworzyć Dostęp dla „…”. Widzisz tam tylko to, co sam możesz robić. Inne narzędzia panelu:

• Szukaj uprawnień znajduje uprawnienie w dowolnym module, np. „eksport” albo „poziom cen”.
• Wszystkie i Nadane pokazują wszystkie uprawnienia albo tylko te, które klucz ma.
• Zacznij od, widoczne podczas tworzenia klucza, zastępuje wybór dostępem z szablonu.
• Akcje oznaczone znakiem ostrzeżenia usuwają dane albo ujawniają dane osobowe klientów. Gdy klucz ma taką akcję, panel pokazuje „Ten klucz może teraz usuwać dane lub widzieć dane osobowe.”
• „Niewidoczne, bo sam ich nie masz: …” wymienia moduły, których nie możesz nadać.

​

Czego żaden klucz nie może

Niektóre uprawnienia nigdy nie są dostępne dla klucza API, nawet gdy ma je właściciel i klucz je dostał:

• Nie dla kluczy API: zarządzanie użytkownikami, rolami, funkcjami, ustawieniami i kluczami API; zarządzanie regułami automatyzacji, własnymi wyzwalaczami i ustawieniami automatyzacji oraz uruchamianie własnego wyzwalacza na rekordach, które jego konfiguracja wyklucza; zmiana tego, kto zarządza stanami magazynu lub tożsamością produktów; konta marketplace’ów i kurierów; generowanie klucza agenta ERP i wybór użytkownika ERP, którym Omnilinker zapisuje dane; zmiana czasu przechowywania zapisów wysyłek do ERP; panel zadań w tle. Moduły złożone wyłącznie z takich uprawnień panel pokazuje w sekcji Nie dla kluczy API: „Klucz nie może zarządzać użytkownikami, kluczami ani ustawieniami, więc wyciek klucza nie odetnie Ci dostępu.”
• Tylko ekran: m.in. zapisane filtry, pulpity, strony ustawień, Centrum powiadomień i panel producenta. Korzysta z nich człowiek na ekranie; klucz nie może. Zaznacz Pokaż uprawnienia tylko dla ekranu, aby zobaczyć je w panelu z oznaczeniem Tylko ekran.

​

Kopiowanie klucza

Okno Klucz utworzony pokazuje cały klucz jeden raz. Omnilinker przechowuje tylko jego skrót, więc nikt nie pokaże Ci go ponownie. Jeśli zgubisz klucz, wymień go, aby dostać nowy; zobacz Wymiana klucza.

​

Lista kluczy

Każdy wiersz pokazuje nazwę klucza, pierwsze znaki klucza (jego prefiks), co klucz może robić, jego status, datę wygaśnięcia i akcje. Twoje klucze są w grupie Twoje integracje. Z uprawnieniem Podgląd i zarządzanie wszystkimi kluczami w organizacji grupa nazywa się Integracje, przy każdym kluczu widać jego właściciela, a klucze agentów i stacji są w grupie Agenci i urządzenia, z odnośnikiem Otwórz połączenie albo Otwórz stacje do miejsca, w którym się nimi zarządza. Listę filtrujesz przyciskami nad nią: Szukaj kluczy znajduje klucz po nazwie, notatkach lub prefiksie. Dokumentacja API otwiera dokumentację referencyjną API. Kliknij strzałkę na początku wiersza, aby zobaczyć szczegóły klucza: Co może robić, Działa jako, prefiks klucza, Notatki, Utworzony, Ostatnio użyty, Wygasa oraz, dla klucza z datą wygaśnięcia, Przypomnienie.

​

Statusy

Ostatnio użyty aktualizuje się najczęściej raz na pięć minut.

​

Edycja klucza

Otwórz menu Więcej akcji w wierszu i kliknij Edytuj. Możesz zmienić:

• Nazwa i Notatki. Sam klucz się nie zmienia.
• Wygasa: Bez zmian, +30 dni, +90 dni, Wybierz datę albo Nigdy. +30 dni i +90 dni dodają dni do obecnej daty wygaśnięcia albo do dzisiaj, jeśli klucz wygasł lub nie ma daty.
• Aktywny: wyłącz, aby zatrzymać klucz bez usuwania go.

Kliknij Zapisz zmiany: „Klucz zapisany”. Aby zmienić, co klucz może robić, kliknij Zmień dostęp w menu albo Dostosuj dostęp… w oknie edycji. Potrzebujesz uprawnienia Zmiana dostępu kluczy API. Zmiany dostępu działają od razu.

​

Wymiana klucza

Wymiana daje Ci nowy klucz z tą samą nazwą, notatkami i dostępem. Stary klucz działa jeszcze przez chwilę, więc wymienisz go bez przerwy w działaniu. Oba klucze są na liście, dopóki stary nie przestanie działać; stary ma status Zastąpiony. Podmień klucz w swoim narzędziu przed tym czasem. Wymienić można tylko aktywny klucz, który nie wygasł. Dezaktywowany klucz trzeba najpierw ponownie aktywować.

​

Wygasanie i przypomnienia

Gdy do wygaśnięcia klucza zostaje siedem dni lub mniej, jego właściciel dostaje powiadomienie: „Klucz API „…” wygasa za N dni”, z odnośnikiem do klucza. Przy kluczu, który wygasa w ciągu doby, powiadomienie brzmi „Klucz API „…” wygasa w ciągu doby”. Każdy klucz dostaje jedno przypomnienie; zmiana daty wygaśnięcia je odnawia. Gdy data minie, klucz przestaje działać. Aby integracja działała dalej, wymień klucz przed wygaśnięciem albo przedłuż go przez Edytuj > Wygasa. Klucze, które wkrótce wygasają, liczy też karta Klucze API na stronie głównej; zobacz Strona główna.

​

Dezaktywacja lub usunięcie klucza

Aby włączyć dezaktywowany klucz, kliknij Aktywuj ponownie w jego menu: „Klucz ponownie aktywny”. Klucza, który wygasł lub został zastąpiony, nie można ponownie aktywować. Gdy Twój klucz dezaktywuje osoba z uprawnieniem Podgląd i zarządzanie wszystkimi kluczami w organizacji, ponownie włączyć go może tylko osoba z tym uprawnieniem. Okno edycji pokazuje „Zatrzymany przez …. Poproś tę osobę o ponowne włączenie albo utwórz nowy klucz.”

​

Kiedy klucz przestaje działać

Program korzystający z klucza dostaje odpowiedzi 401, gdy:

• klucz został dezaktywowany lub usunięty;
• minęła jego data wygaśnięcia;
• został wymieniony i skończył się wybrany czas działania starego klucza;
• konto jego właściciela zostało dezaktywowane, zablokowane lub usunięte.

Wywołanie, do którego klucz nie ma uprawnienia, zostanie odrzucone, choć sam klucz jest ważny. Sprawdź Co może robić przy kluczu i czy jego właściciel nadal ma to uprawnienie.

​

Rozwiązywanie problemów