Czym jest GPS-Trace Platform API?
Platform API to interfejs programistyczny dla zarejestrowanych użytkowników GPS-Trace Console. Umożliwia on systemom zewnętrznym, takim jak CRM, narzędzia rozliczeniowe (billing) czy raportowe, pobieranie danych z GPS-Trace oraz wykonywanie wybranych operacji w Console.
API obejmuje metody do pracy z użytkownikami, planami klientów, jednostkami, danymi rozliczeniowymi, statystykami i raportami.
Jak uwierzytelnić żądania API?
Żądania API są uwierzytelniane za pomocą tokena API. Token to klucz dostępu generowany w GPS-Trace Console. Musi zostać dołączony do każdego żądania, aby platforma mogła sprawdzić, jakie działania są dozwolone dla danego użytkownika.
Token jest przesyłany w nagłówku żądania X-AccessToken.
Jakie grupy metod API są dostępne?
API obejmuje następujące grupy metod:
- Metody danych konta
- Metody danych firmy
- Metody planów klientów
- Metody jednostek
- Metody użytkowników
- Metody danych rozliczeniowych
- Metody statystyk i raportów
Jak mogę pracować z użytkownikami przez API?
Platform API udostępnia metody do pracy z użytkownikami. W zależności od dostępnych uprawnień użytkownicy Console mogą tworzyć rekordy użytkowników, aktualizować dane użytkowników oraz przypisywać plany klientów, moduły i uprawnienia.
Jak działają metody danych konta?
Sekcja konta obejmuje metody tworzenia, odczytu, aktualizacji i usuwania danych konta. Działania te często określa się jako operacje CRUD.
- Utwórz konto
- Usuń konto
- Zaktualizuj dane konta
- Pobierz dane konta
Podczas tworzenia konta klienta żądanie może zawierać aplikację, która ma zostać przypisana do konta. Realizuje się to poprzez pole reg_apps. Dostępne aplikacje zależą od poziomu dostępu użytkownika oraz warunków umowy.
Rekordy użytkowników są tworzone razem z kontem klienta i pozostają nieaktywne do momentu zakończenia procesu aktywacji.
Aby aktywować konto:
- Użytkownik Console wysyła do klienta link aktywacyjny.
- Klient otwiera link i podaje adres e-mail oraz hasło.
- Klient potwierdza rejestrację poprzez link potwierdzający w wiadomości e-mail.
- Po potwierdzeniu konto użytkownika staje się aktywne zgodnie z przypisaną aplikacją, planem i uprawnieniami.
Czy to API służy do bezpośredniego śledzenia pojazdów?
API jest przeznaczone do operacji w GPS-Trace Console oraz do wymiany danych z systemami zewnętrznymi. Nie zastępuje aplikacji mobilnej Forguard ani innych interfejsów śledzenia GPS-Trace.
Użytkownicy Console mogą wykorzystywać API do pracy z jednostkami, planami klientów, statystykami, historią, systemami CRM oraz systemami rozliczeniowymi (billing), w zależności od poziomu dostępu.
Do czego można wykorzystać API?
Platform API można wykorzystać do połączenia GPS-Trace z CRM, systemami rozliczeniowymi (billing), narzędziami raportowymi lub systemami wewnętrznymi.
Na przykład użytkownicy Console mogą pobierać dane jednostek, pracować z planami klientów, eksportować statystyki oraz ograniczać powtarzalne działania manualne w zewnętrznych procesach.
Czy mogę uzyskać dostęp do historycznych danych śledzenia przez API?
Tak, Platform API może zapewnić dostęp do historycznych danych śledzenia, w zależności od dostępnych metod i uprawnień.
Na przykład metoda GET /partner/units/{id}/messages pobiera wiadomości z jednostki. Maksymalna liczba wiadomości, które można pobrać, to 10 000. Można także określić liczbę najnowszych wiadomości, które mają zostać zwrócone.
Przykładowe żądanie pobrania ostatnich 10 wiadomości:
curl -X 'GET' \
'https://api.gps-trace.com/partner/units//messages?count=10' \
-H 'accept: application/' \
-H 'X-AccessToken: '
Pola w odpowiedzi zależą od parametrów wysyłanych przez urządzenie śledzące.
Jak mogę pobrać dane telemetryczne?
Aby pobrać najnowsze dane telemetryczne dla jednostki, użyj metody GET /partner/units/{id}/telemetry. Odpowiedź zawiera najnowszą dostępną wiadomość telemetryczną dla wskazanej jednostki. Dokładne pola zależą od danych wysyłanych przez urządzenie śledzące.
Przykładowe żądanie:
curl -X 'GET' \
'https://api.gps-trace.com/partner/units//telemetry' \
-H 'accept: application/' \
-H 'X-AccessToken: '
Jak zacząć korzystać z API?
Aby uzyskać dostęp do API, wystarczy zalogować się na swoje konto Console. Jeśli go nie masz, możesz również zarejestrować się tutaj.