Przegląd dokumentacji API TrackRoad

TrackRoad udostępnia interfejsy API REST i SOAP, które pomagają tworzyć aplikacje do optymalizacji tras, dispatchu wielu pojazdów, geokodowania, routingu oraz obliczania ETA i odległości.

Skorzystaj z tego centrum API, aby znaleźć metody uwierzytelniania, adresy bazowe usług oraz listę dostępnych endpointów REST i operacji SOAP dla integracji routingu i dispatchu TrackRoad.

Przegląd dokumentacji API TrackRoad pokazujący endpointy REST, operacje SOAP i uwierzytelnianie za pomocą TrackServiceKey
Przegląd dokumentacji API: endpointy REST, operacje SOAP i uwierzytelnianie z użyciem TrackServiceKey.

Zanim zaczniesz

Potrzebujesz pełnego kontraktu REST?

Swagger udostępnia pełną listę endpointów REST, parametrów, modeli żądań i modeli odpowiedzi, aby przyspieszyć integrację z API TrackRoad.

Otwórz Swagger UI Dispatch API

Spis treści

  1. Adresy bazowe REST i SOAP
  2. Endpointy API REST
  3. Operacje API SOAP
  4. Uwierzytelnianie REST (X-API-Key)
  5. Uwierzytelnianie SOAP (SessionIDHeader)
  6. Login / Logout (legacy)
  7. Najlepsze praktyki bezpieczeństwa
  8. Najczęstsze błędy uwierzytelniania
  9. FAQ

Adresy bazowe REST i SOAP#

TrackRoad oferuje dwa style API: REST i SOAP. Wszystkie endpointy korzystają z tego samego hosta usługi.

API URL
Adres bazowy https://trackservice.trackroad.com
Bazowy URL REST https://trackservice.trackroad.com/rest
Endpoint usługi SOAP https://trackservice.trackroad.com/TrackService.asmx

Endpointy API REST#

Wywołania REST są definiowane przez metodę HTTP + endpoint. Ten przegląd pomaga deweloperom szybko znaleźć endpointy TrackRoad dla dispatchu, geokodowania, routingu, kredytów i starszego uwierzytelniania.

Metoda HTTP Endpoint Operacja Opis
POST /rest/dispatch Dispatch Optymalizuje i przydziela przystanki do wielu pojazdów, uwzględniając kolejność przystanków, ETA, odległość, czas trwania oraz przystanki pominięte lub nieprzypisane.
Dokumentacja: Dispatch API
POST /rest/geocode Geocode Konwertuje adresy na współrzędne szerokości i długości geograficznej, opcjonalnie z oceną pewności dopasowania.
Dokumentacja: Geocoding API
POST /rest/route Route Oblicza trasę na podstawie sekwencji lokalizacji dla zastosowań routingu, nawigacji i czasu przejazdu.
Dokumentacja: Route API
POST /rest/routes Routes Oblicza wiele tras w jednym żądaniu dla wsadowego routingu i planowania floty.
Dokumentacja: Routes API
POST /rest/credit Credit Zwraca liczbę pozostałych kredytów dostępnych dla konta lub integracji TrackRoad.
Dokumentacja: Credit API
POST /rest/login Login (legacy) Starszy endpoint, który zwraca klucz API dla wcześniejszych integracji. Nowe implementacje powinny używać bezpośredniego uwierzytelniania kluczem API.
Dokumentacja: Uwierzytelnianie API
POST /rest/logout Logout (legacy) Starszy endpoint kończący starszą sesję.

Użyj Swagger UI aby zobaczyć pełny kontrakt REST, w tym parametry, modele i aktualne szczegóły schematów żądań i odpowiedzi.

Operacje API SOAP#

Wywołania SOAP są definiowane przez endpoint usługi + operację + SOAPAction. Wszystkie operacje są wywoływane metodą HTTP POST na endpoint usługi SOAP TrackRoad.

Uwierzytelnianie: W żądaniach SOAP dołącz SessionIDHeader i ustaw SessionID na swój klucz API (TrackServiceKey). Login i Logout są starszymi metodami i nie są wymagane w nowych integracjach.

Endpoint usługi Operacja SOAPAction Opis
/TrackService.asmx Dispatch http://TrackService.TrackRoad.com/Dispatch Wykonuje dispatch i optymalizację dużych list przystanków między wieloma pojazdami w procesach optymalizacji tras.
Dokumentacja: Dispatch API
/TrackService.asmx Geocode http://TrackService.TrackRoad.com/Geocode Przyjmuje listę adresów lub lokalizacji i zwraca geokodowane przystanki z szerokością, długością geograficzną i opcjonalnymi kodami dopasowania.
Dokumentacja: Geocoding API
/TrackService.asmx CalculateRoute http://TrackService.TrackRoad.com/CalculateRoute Generuje wskazówki turn-by-turn i mapy tras dla pojedynczej trasy.
Dokumentacja: Route API
/TrackService.asmx CalculateRoutes http://TrackService.TrackRoad.com/CalculateRoutes Generuje wskazówki i mapy dla wielu tras, w tym mapę zbiorczą wszystkich tras.
Dokumentacja: Routes API
/TrackService.asmx CalculateDistance http://TrackService.TrackRoad.com/CalculateDistance Zwraca odległość przejazdu i czas podróży z punktu A do punktu B.
/TrackService.asmx CreditRemaining http://TrackService.TrackRoad.com/CreditRemaining Zwraca liczbę pozostałych kredytów na koncie.
Dokumentacja: Credit API
/TrackService.asmx GetRouteList http://TrackService.TrackRoad.com/GetRouteList Zwraca listę tras utworzonych na koncie z filtrami takimi jak zakres dat, właściciel i nazwa trasy.
/TrackService.asmx GetRoute http://TrackService.TrackRoad.com/GetRoute Zwraca trasę na podstawie RouteID.
/TrackService.asmx GetTrack http://TrackService.TrackRoad.com/GetTrack Przyjmuje FromDate i ToDate w UTC i zwraca współrzędne GPS ze znacznikami czasu UTC dla wybranego okresu.
/TrackService.asmx Login http://TrackService.TrackRoad.com/Login Starsze uwierzytelnianie sesyjne. Nowe integracje powinny wysyłać TrackServiceKey jako SessionIDHeader i SessionID.
Dokumentacja: Uwierzytelnianie API
/TrackService.asmx Logout http://TrackService.TrackRoad.com/Logout Kończy starszą sesję SOAP.

WSDL: https://trackservice.trackroad.com/TrackService.asmx?WSDL

Uwierzytelnianie REST (X-API-Key)#

W żądaniach REST wysyłaj swój klucz API (TrackServiceKey) w nagłówku X-API-Key przy każdym wywołaniu.

curl -X POST "https://trackservice.trackroad.com/rest/dispatch" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_TRACKSERVICEKEY" \
  -d '{ }'

Przechowuj klucze API po stronie serwera. Nie umieszczaj kluczy w kodzie przeglądarki ani aplikacji mobilnych.

Uwierzytelnianie SOAP (SessionIDHeader)#

W żądaniach SOAP dołącz SessionIDHeader i ustaw SessionID na swój klucz API (TrackServiceKey).

<soap:Header>
  <SessionIDHeader xmlns="http://TrackService.TrackRoad.com/">
    <SessionID>YOUR_TRACKSERVICEKEY</SessionID>
  </SessionIDHeader>
</soap:Header>

Example SOAP call (Dispatch)

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <SessionIDHeader xmlns="http://TrackService.TrackRoad.com/">
      <SessionID>YOUR_TRACKSERVICEKEY</SessionID>
    </SessionIDHeader>
  </soap:Header>
  <soap:Body>
    <Dispatch xmlns="http://TrackService.TrackRoad.com/">
      <specification>
        <RoutingService>NetRoad</RoutingService>
        <DistanceUnit>Mile</DistanceUnit>
        <RouteOptimize>MinimizeTime</RouteOptimize>
        <Vehicles>
          <Vehicle><Name>Truck 1</Name></Vehicle>
        </Vehicles>
        <Locations>
          <Location>
            <Address>
              <Street>1 Market St</Street>
              <City>San Francisco</City>
              <State>CA</State>
              <PostalCode>94105</PostalCode>
              <Country>USA</Country>
            </Address>
          </Location>
        </Locations>
      </specification>
    </Dispatch>
  </soap:Body>
</soap:Envelope>

Ustaw poprawny nagłówek HTTP SOAPAction dla każdej operacji SOAP podczas wywoływania API SOAP TrackRoad.

Login / Logout (legacy)#

Uwaga legacy: Login i Logout są nadal opisane dla starszych integracji, ale nie są wymagane w nowych wdrożeniach. Nowe integracje powinny korzystać z klucza API (TrackServiceKey) wygenerowanego na koncie TrackRoad.

  • Zalecane: uwierzytelnianie kluczem API — Uwierzytelnianie API
  • Legacy: REST /rest/login, /rest/logout oraz SOAP Login / Logout.

Najlepsze praktyki bezpieczeństwa#

  • Nigdy nie umieszczaj kluczy API w kodzie po stronie klienta, takim jak aplikacje webowe lub mobilne. Przechowuj klucze po stronie serwera.
  • Używaj wyłącznie HTTPS dla wszystkich żądań do API TrackRoad.
  • Rotuj klucze w przypadku ujawnienia i ogranicz dostęp do danych uwierzytelniających produkcyjnych.
  • Unikaj logowania sekretów, takich jak nagłówki, klucze API lub pełne payloady zawierające wrażliwe dane.

Najczęstsze błędy uwierzytelniania#

  • 401 / Unauthorized: brak lub nieprawidłowy nagłówek X-API-Key w REST albo brak lub nieprawidłowy SessionIDHeader w SOAP.
  • 403 / Forbidden: klucz jest prawidłowy, ale zablokowany, wygasł lub konto nie ma kredytów.

FAQ#

Jak uwierzytelnić się w API REST TrackRoad?
Wysyłaj swój klucz API (TrackServiceKey) w nagłówku X-API-Key przy każdym żądaniu REST.
Jak uwierzytelnić się w API SOAP TrackRoad?
Dołącz SessionIDHeader do żądań SOAP i ustaw SessionID na swój klucz API (TrackServiceKey). Login i Logout są starszymi metodami i nie są wymagane w nowych integracjach.
Czy nadal potrzebuję Login i Logout?
Nie w przypadku nowych integracji. Nowoczesne integracje TrackRoad powinny korzystać z uwierzytelniania kluczem API. Login i Logout pozostają dostępne dla zgodności wstecznej ze starszymi wdrożeniami.
Gdzie znajdę pełny kontrakt API REST?
Użyj Swagger UI aby przejrzeć pełną listę endpointów REST, parametrów, modeli żądań i modeli odpowiedzi.

Gotowy, aby budować z TrackRoad?

Wygeneruj swój klucz API (TrackServiceKey), a następnie przejrzyj pełny kontrakt REST w Swagger lub przejdź do dokumentacji Dispatch API.

Pobierz klucz API Otwórz Swagger UI