Jak działają klucze API i webhooki w priceq?

Obie funkcje są na stronie Ustawienia i obie są przeznaczone dla programisty. Klucz API pozwala Twojemu systemowi pobierać Twoje produkty, linki i ceny oraz przesyłać Twój katalog. Webhook działa odwrotnie: priceq wywołuje Twój adres, gdy coś się wydarzy. Pełna dokumentacja techniczna jest pod adresem /developers.

Klucze API

Sekcję Klucze API widzi tylko administrator. Aby utworzyć klucz:

1. Wpisz w polu nazwy, do czego służy klucz.
2. Kliknij Utwórz klucz.
3. Od razu skopiuj klucz. Okno mówi Skopiuj ten klucz teraz, bo nie możemy pokazać go ponownie: priceq przechowuje tylko jego zakodowaną wersję.

Klucz daje dostęp do danych, nie do administracji. Nie anuluje abonamentu, nie uruchomi pełnego eksportu danych i nie utworzy kolejnych kluczy. Twoja organizacja może mieć jednocześnie do 10 aktywnych kluczy.

Każdy klucz widać na liście po pierwszych znakach, z datą utworzenia i datą ostatniego użycia. Kliknij Cofnij, żeby wyłączyć klucz. Od tej chwili każde wywołanie z tym kluczem jest odrzucane, a klucz znika z listy. Zgubionego klucza nie da się odzyskać: cofnij go i utwórz nowy.

Webhooki

Sekcję Webhooki widzi każdy. Dodawanie, wstrzymywanie i usuwanie webhooka wymaga jednak roli Nadzorca albo Administrator. Zobacz Role i ich uprawnienia.

Kliknij Dodaj webhook, wpisz Adres docelowy i wybierz co najmniej jedno zdarzenie w polu Wysyłaj przy. Adres musi zaczynać się od https:// i być dostępny z internetu. Następnie kliknij Utwórz.

Webhook może wysyłać przy tych zdarzeniach:

• Alert wyzwolony
• Produkt dodany
• Produkt zarchiwizowany
• Cena sugerowana zmieniona
• Skan zakończony
• Synchronizacja katalogu zakończona

Po utworzeniu webhooka priceq jeden raz pokazuje jego sekret do podpisywania. Skopiuj go od razu. Twój system sprawdza nim, czy wywołanie naprawdę pochodzi od priceq. Jak to zrobić, wyjaśnia /developers.

Gdy wysyłka się nie uda

Każdy wiersz kończy się menu z opcjami Wstrzymaj, Wznów, Usuń oraz dziennikiem wysyłek. Każda wysyłka ma tam status W kolejce, Wysłane albo Nieudane.

Gdy Twój serwer nie działa, odpowiada za wolno albo zwraca błąd serwera, priceq próbuje ponownie: łącznie pięć prób, rozłożonych na około dwadzieścia minut. Gdy Twój serwer odpowie błędem klienta, na przykład 404, priceq od razu przestaje. Kolejna próba dałaby tę samą odpowiedź.

Które alerty mogą wywołać webhook, wyjaśnia artykuł Co wywołuje każdy typ alertu?.