Przejdź do głównej zawartości

Quick Start

wskazówka

Rozpocznij od razu i wykonaj pierwszy request API, aby pobrać listę pojazdów tutaj.

Rozpoczęcie pracy z Cartrack Fleet API jest proste. Ta sekcja zawiera podstawowy przykład pierwszego API call. Przykład używa curl, czyli uniwersalnego i szeroko wspieranego narzędzia do wykonywania HTTP requests z linii poleceń, ale te same zasady można zastosować w innych językach i narzędziach, takich jak Python, JavaScript czy dowolne HTTP client libraries.

Wymagania wstępne​

Przed przejściem dalej należy upewnić się, że mają Państwo:

  • cURL zainstalowany: Upewnij się, że cURL jest dostępny w systemie. cURL zwykle jest dostępny w Unix, Linux i macOS, a na Windows można go doinstalować.
  • Base URL i Authentication Credentials: Potrzebny będzie base URL Cartrack Fleet API oraz poprawne credentials. Szczegóły znajdują się w sekcjach Authentication i Base URLs.

Wykonanie API Call​

Poniżej przykład API call do pobrania listy pojazdów przez curl:

curl --location '{baseUrl}/rest/vehicles' \
--header 'Accept: application/json' \
--header 'Authorization: Basic your_encoded_credentials'

Zastąp {baseUrl} właściwym base URL Cartrack Fleet API, a your_encoded_credentials zakodowanymi w Base64 credentials do autoryzacji.

Wyjaśnienie komendy​

  • --location: Poleca curl podążać za przekierowaniami zwróconymi przez serwer.
  • --header: Służy do przekazania dodatkowych nagłówków request. W przykładzie wskazujemy format JSON i przekazujemy credentials autoryzacji.
  • URL endpointu ({baseUrl}/rest/vehicles) wskazuje endpoint API do pobrania listy pojazdów.

Response​

API zwróci JSON response z listą pojazdów i danymi takimi jak vehicle ID, model i inne istotne informacje.

Ten podstawowy przykład jest punktem startowym do wykonywania API calls do Cartrack Fleet API. Ten sam schemat można dostosować do wybranego języka lub narzędzia. Aby poznać więcej funkcji i dodatkowych endpointów, przejdź dalej przez pełną dokumentację API.

Import do Postman​

Można zaimportować specyfikację OpenAPI Cartrack do Postman i wygenerować gotową kolekcję requests.

  • Spec URL: https://developer.cartrack.com/openapi/openapi.yaml
  • W Postman: kliknij Import → Link, wklej URL i kliknij Import. Alternatywnie użyj Import → File i załaduj pobrany plik openapi.yaml.
  • Postman utworzy kolekcję requests na podstawie specyfikacji.
  • Skonfiguruj wartości środowiskowe:
    • Ustaw base URL zgodnie z instrukcją na stronie Base URLs.
    • Skonfiguruj authentication: Cartrack APIs używają Basic Authentication. W Postman otwórz request, przejdź do zakładki Authorization, wybierz Basic Auth i podaj username oraz password. Alternatywnie dodaj nagłówek Authorization o wartości Basic <base64-encoded-credentials>. Szczegóły generowania credentials są na stronie Authentication.
  • Uruchamiaj pojedyncze requests albo użyj Collection Runner do serii wywołań.