Przejdź do głównej zawartości

Użycie endpointów API

A
Napisane przez Arek
Zaktualizowano dzisiaj

Strona Użycie endpointów API daje pełny wgląd w to, jak działają Twoje integracje API. Możesz monitorować kondycję każdego endpointu, śledzić postęp wdrożenia oraz przechodzić do szczegółowych logów wywołań API, aby analizować błędy.

Co będzie potrzebne:

  • Dostęp do Vehicle Management.

  • Zakładka API Endpoints.


🧭 Jak uzyskać dostęp

Przejdź do Vehicle Management i wybierz zakładkę API Endpoints z górnej nawigacji.


📋 Lista endpointów

Strona wyświetla wszystkie aktywne endpointy API, posortowane alfabetycznie. Każda karta endpointu pokazuje:

  • Endpoint name — nazwę endpointu API.

  • API Health status — kolorowy wskaźnik aktualnej kondycji endpointu:

    • 🟢 Healthy (zielony) — endpoint działa prawidłowo.

    • 🟡 Concerning (żółty) — wykryto błędy; warto monitorować.

    • 🔴 High error rate (czerwony) — znaczna część ostatnich wywołań kończy się błędem.

    • All calls failed (czerwony) — wszystkie ostatnie wywołania zakończyły się błędem.

  • Implementation status — etap wdrożenia endpointu:

    • Implemented (zielony) — endpoint jest w pełni aktywny.

    • 🛠️ Under implementation (żółty) — endpoint jest w trakcie konfiguracji.

    • 💤 Inactive > 30 days (szary) — brak wywołań od ponad 30 dni.


🔎 Szczegóły endpointu

Kliknij kartę endpointu, aby ją rozwinąć. Widok rozszerzony zawiera:

  • Source — identyfikator integracji wykonującej wywołania.

  • First Call — data pierwszego zarejestrowanego wywołania.

  • Last Call — data ostatniego zarejestrowanego wywołania.

  • Implemented At — data oznaczenia endpointu jako wdrożonego (jeśli dotyczy).

  • Webhook Status — aktualny status subskrypcji webhooka (jeśli dotyczy).

  • Tabela Recent Activity — dzienny podział pokazujący datę, liczbę wywołań i kod statusu HTTP dla każdego wpisu. Kody są kolorowane: zielony dla sukcesu (2xx) i czerwony dla błędów (4xx/5xx).


🧾 Podgląd szczegółów wywołań API

W tabeli Recent Activity kliknij "View details" przy dowolnym wierszu (lub kliknij wiersz), aby otworzyć modal API Call History. Zobaczysz:

  • Nagłówek z nazwą endpointu, source, datą i łączną liczbą wywołań.

  • Przewijalny log pojedynczych wywołań API z:

    • numerem wiersza

    • kodem statusu HTTP (kolorowany)

    • URL żądania

    • znacznikiem czasu (UTC)

  • Dla odpowiedzi błędów (4xx/5xx) kliknij expand, aby zobaczyć komunikat błędu i payload żądania, co ułatwia debugowanie.

Log ładuje wyniki stronami po 50 i automatycznie pobiera kolejne podczas przewijania.

💡Uwaga: synchronizacja szczegółowych logów ma opóźnienie. Logi z dzisiaj mogą nie być jeszcze widoczne. Payloady żądań są logowane tylko dla odpowiedzi błędów (4xx/5xx).

Potrzebujesz pomocy?

  • Ask our AI Assistant: aby uzyskać wsparcie w czasie rzeczywistym, użyj AI Assistant dostępnego bezpośrednio w interfejsie platformy Visibility.

  • Send Feedback: cenimy Twoją opinię. Kliknij ikonę "?" w lewym dolnym rogu i wybierz "Send feedback."

  • Support Portal: w przypadku problemów technicznych wymagających wsparcia człowieka odwiedź nasze Support Portal.

Czy to odpowiedziało na twoje pytanie?