FAQ: Metody API Partnera

5.7.2024 | Veranika Patachyts

Co to jest Partner API?


GPS-Trace Partner API to potężne narzędzie, które umożliwia firmom integrację zaawansowanych funkcji śledzenia GPS z ich istniejącymi systemami. Oferuje różnorodne metody tworzenia i zarządzania kontami użytkowników i planami klientów, konfiguracji obiektów oraz generowania niestandardowych raportów, a nawet pobierania statystyk.


Jak uwierzytelnić moje żądania do Partner API?


Partner API wykorzystuje uwierzytelnianie tokenem API, aby zapewnić bezpieczny dostęp. Musisz wygenerować token API ze swojego konta, który następnie użyjesz do uwierzytelniania wszystkich swoich żądań.


Jakie są kluczowe funkcje Partner API?


Kluczowe funkcje GPS-Trace API obejmują:

  • Zarządzanie kontami
  • Zarządzanie firmą
  • Zarządzanie planami klientów
  • Zarządzanie obiektami
  • Zarządzanie użytkownikami
  • Zarządzanie rozliczeniami

Partner platform


Jak mogę zarządzać użytkownikami za pomocą Partner API?


Partner API udostępnia punkty końcowe do rejestracji i zarządzania użytkownikami. Możesz tworzyć nowe konta użytkowników, aktualizować informacje o użytkownikach oraz zarządzać planami klientów i zestawami modułów oraz uprawnień, aby zapewnić bezpieczną i zorganizowaną bazę użytkowników.


Jak działa zarządzanie kontami?


Podsekcja CRUD kont obejmuje metody związane z operacjami CRUD (Create, Read, Update, Delete) dla kont, które obejmują:

  • Tworzenie kont: Metody tworzenia nowych kont w systemie.
  • Usuwanie kont: Metody usuwania kont z systemu.
  • Aktualizacja kont: Metody aktualizacji istniejących informacji o koncie.
  • Pobieranie informacji o koncie: Metody pobierania szczegółów dotyczących konkretnych kont.

Podczas tworzenia konta klienta, aplikacja jest przypisywana do konta, co daje klientowi dostęp. Jest to realizowane poprzez żądanie, z jednym z obowiązkowych pól "reg_apps". ID aplikacji obejmują:

  • Ruhavik - 5a5ca87f-7cbe-4540-ab5d-77bf4bf69884
  • Petovik - 962e19f0-6b4a-4f81-a3fe-4b657689b6f9
  • Forguard - b901da51-ce00-4af2-b978-8d0fca8ae1ea

Jednostki użytkowników są tworzone jednocześnie z tworzeniem konta klienta i początkowo są nieaktywne. 

Aby aktywować konto:

  • partner wysyła specjalny link aktywacyjny do swojego klienta.
  • Po kliknięciu linku aktywacyjnego klient wprowadza swój unikalny adres e-mail (który będzie powiązany z kontem) oraz hasło.
  • Klient otrzymuje następnie e-mail z potwierdzeniem rejestracji na podany adres. Po kliknięciu linku w e-mailu klient kończy proces rejestracji, wprowadzając wymagane informacje w formularzu, które mogą obejmować hasło, klucz logowania itp.

W rezultacie tworzysz nowego użytkownika za pomocą naszego API w zaledwie kilku kliknięciach.


Czy to jest Partner API czy API do monitorowania GPS?


To zdecydowanie partner API oparte na funkcjonalności naszego Partner Panel. Nie możesz monitorować swojej floty za jego pomocą. Głównym celem jest obsługa i dostosowywanie kont klientów i obiektów, ustalanie taryf, zarządzanie analizami i historią. Korzystając z naszego API, możesz zintegrować naszą platformę partnerską z Twoim systemem CRM i systemem rozliczeniowym.

GPS Partner API Documentation


Jakie korzyści może przynieść mojej firmie?


Partner API upraszcza różne aspekty operacyjne, takie jak zarządzanie pojazdami, śledzenie zasobów i raportowanie danych. Automatyzując te procesy, firmy mogą zmniejszyć wysiłek manualny i zwiększyć rentowność z łatwością.


Czy mogę uzyskać dostęp do danych śledzenia historycznego za pomocą Partner API?


Tak, GPS-Trace Partner API umożliwia dostęp do danych śledzenia historycznego.
Te dane są cenne do analizy wydajności, badania incydentów i optymalizacji przyszłych operacji. Na przykład, możesz użyć metody GET /partner/units/{id}/messages(Pobierz wiadomości jednostki), aby pobrać wiadomości z urządzenia (obiekt) na Forguard. Maksymalna liczba wiadomości, które można pobrać, to 10 000, a także możesz określić liczbę ostatnich wiadomości, które chcesz uzyskać.

Przykładowe żądanie, aby uzyskać ostatnie 10 wiadomości:

curl -X 'GET' \
  'https://api.gps-trace.com/partner/units/<unit id>/messages?count=10' \
  -H 'accept: application/' \
  -H 'X-AccessToken: <your token>'

Pola w odpowiedzi będą zależeć od parametrów wysyłanych przez tracker.


Jak niestandardowe raportowanie może pomóc mojej firmie?


Niestandardowe raportowanie pozwala generować szczegółowe raporty na podstawie Twoich specyficznych potrzeb.
Te raporty mogą zawierać dane dotyczące użytkowania i wydajności pojazdów, dostarczając cennych informacji do podejmowania decyzji i poprawy strategii biznesowych. Na przykład, aby uzyskać najnowsze dane telemetryczne jednostki, powinieneś użyć metody GET /partner/units/{id}/telemetry” (Pobierz dane telemetryczne).

Przykładowe żądanie:

curl -X 'GET' \
  'https://api.gps-trace.com/partner/units/<unit id>/telemetry' \
  -H 'accept: application/' \
  -H 'X-AccessToken: <your token>'

W rezultacie pobierzesz raport z najnowszą wiadomością telemetryczną każdego urządzenia, które określiłeś.


Jak mogę zacząć korzystać z Partner API?


Aby rozpocząć korzystanie z Partner API, możesz wypełnić formularz na naszej stronie internetowej lub napisać do nas na adres business@gps-trace.com