Dokumentacja dla Developera

⌘K
  2. Home
  4. Docs
  6. Dokumentacja dla Develope...
  8. API
  10. Narzędzia automatyzacji A...
  12. Korzystanie z Postamana dla TrackSystem

Korzystanie z Postamana dla TrackSystem

Testowanie API za pomocą Postmana

Pracując z żądaniami API, programiści mają do dyspozycji szeroką gamę narzędzi, od prostych danych wejściowych przeglądarki po zaawansowane rozwiązania programowe. Jednym z preferowanych narzędzi wśród programistów jest Postman, solidna platforma do tworzenia API. Postman doskonale radzi sobie z różnymi zadaniami, w tym prostym testowaniem żądań, tworzeniem API i bieżącą konserwacją.

Navixy usprawnia integrację API, oferując gotowe kolekcje Postman. Kolekcje te umożliwiają programistom szybkie importowanie, testowanie i modyfikowanie żądań API bez ręcznej konfiguracji, zwiększając wydajność i upraszczając proces interakcji z platformą Navixy.

Adres URL kolekcji Navixy Postman:Kopiuj

https://www.postman.com/navixyapisandbox

Piaskownica API Navixy w adresie URL Postmana:Kopiuj

https://www.postman.com/navixyapisandbox/workspace/navixy-api-sandbox/overview

W tym przewodniku skupimy się na wykorzystaniu Postmana jako klienta API.

Pierwsze kroki z Postmanem

Czym jest Postman?

Postman to platforma współpracy przy tworzeniu API, z której korzysta ponad 10 milionów programistów na całym świecie. Upraszcza proces tworzenia, testowania i utrzymywania interfejsów API, oferując przyjazny dla użytkownika interfejs do wysyłania żądań i odbierania odpowiedzi.

Instalacja Postmana

Aby uzyskać najnowszą wersję Aplikacja Postman, odwiedź stronę pobierania i kliknij “Pobierz” dla swojej platformy. Postępuj zgodnie z instrukcjami instalacji specyficznymi dla Twojego systemu operacyjnego.

Konfigurowanie listonosza

  1. Otwórz listonosza: Po instalacji otwórz aplikację Postman.
  2. Utwórz konto: Zarejestruj konto Postman, jeśli jeszcze go nie masz. Pozwoli Ci to zapisać swoją pracę i zsynchronizować ją na różnych urządzeniach.
  3. Importuj kolekcje Navixy: Użyj podanego powyżej linku, aby zaimportować kolekcje Navixy Postman do swojego obszaru roboczego.

Twoja pierwsza prośba

Klient API Postman upraszcza wysyłanie żądań API i zapewnia prawidłowe formatowanie parametrów. Jest to szczególnie przydatne przy obsłudze złożonych i dużych żądań.

Kroki, aby złożyć pierwszą prośbę

  1. Wybierz metodę żądania:
    Wybierz metodę żądania w PostmanieKażde żądanie API wykorzystuje metodę HTTP. Najczęstszymi metodami dla API Navixy są GET i POST. GET pobiera dane z API, podczas gdy POST wysyła nowe dane.
  3. Wprowadź adres URL żądania podstawowego wraz z zasobem i podzasobem:W naszym przykładzie użyjemy user/auth i tracker/list wnioski. Podstawowe adresy URL żądań to:
    • Dla serwera UE – https://api.eu.navixy.com/v2/Dla serwera w USA – https://api.us.navixy.com/v2/



    Wprowadź adres URL
  4. Kliknij na przycisk Params:

    Wprowadź parametry: Wypełnij pola – Klucz (nazwa parametru z dokumentacji) i wartość. Dla user/auth Na prośbę mamy 2 klucze, które należy przesłać – login i hasło.Po wypełnieniu nazwy parametru jest ona automatycznie dodawana do wiersza żądania.



    Wprowadź parametry: Podobnie, z wartościami i dodatkowymi parametrami:



    Wprowadź parametry:


    Wprowadź parametry:
  5. Naciśnij Wyślij:Zobaczysz odpowiedź, już podzieloną i wyróżnioną dla łatwiejszej lektury:

    Wprowadź parametry: W tym przypadku otrzymaliśmy skrót, który należy skopiować i wykorzystać w przyszłych żądaniach.Przykład: tracker/list request
    Wprowadź parametry

Zarządzanie parametrami

Jeśli Twoje żądanie zawiera wiele wymienionych parametrów, możesz je łatwo włączyć i wyłączyć, aby zapobiec błędom:

Wprowadź parametry

Poproś o historię

Listonosz przechowuje historię Twoich żądań po lewej stronie aplikacji. Możesz ponownie przeglądać i ponownie wykonywać poprzednie żądania za pomocą prostego dwukrotnego kliknięcia, otwierając je w nowej karcie:

Wprowadź parametry

Przykłady w dokumentacji

Dokumentacja interfejsu API Navixy zawiera zarówno strukturę żądań, jak i przykłady. Możesz skopiować te przykłady do Postmana, gdzie parametry zostaną automatycznie przeanalizowane w celu wygodnej edycji:

Wprowadź parametry

Importowanie przykładów cURL do Postmana

Przykłady cURL możesz również zaimportować z naszej dokumentacji do Postmana. Skopiuj przykład cURL, otwórz kartę importu w Postmanie, wybierz Surowy tekst, wklej przykład i zapisz go:

Wprowadź parametry

Zobacz także