Wat is de GPS-Trace Platform API?
De Platform API is een software-interface voor geregistreerde GPS-Trace Console-gebruikers. Hiermee kunnen externe systemen, zoals CRM-, facturatie- of rapportagetools, GPS-Trace-gegevens opvragen en geselecteerde Console-bewerkingen uitvoeren.
De API bevat methoden voor het werken met gebruikers, clientplannen, units, facturatiegegevens, statistieken en rapporten.
Hoe authenticeer ik API-aanvragen?
API-aanvragen worden geauthenticeerd met een API-token. Een token is een toegangssleutel die in GPS-Trace Console wordt gegenereerd. Het moet bij elke aanvraag worden meegestuurd zodat het platform kan controleren welke acties voor de gebruiker zijn toegestaan.
Het token wordt meegestuurd in de request-header X-AccessToken.
Welke groepen API-methoden zijn beschikbaar?
De API bevat de volgende methodengroepen:
- Accountgegevens-methoden
- Bedrijfsgegevens-methoden
- Clientplan-methoden
- Unit-methoden
- Gebruikersmethoden
- Facturatiegegevens-methoden
- Statistiek- en rapportagemethoden
Hoe kan ik via de API met gebruikers werken?
De Platform API biedt methoden om met gebruikers te werken. Afhankelijk van de beschikbare rechten kunnen Console-gebruikers gebruikersrecords aanmaken, gebruikersgegevens bijwerken en clientplannen, modules en rechten toewijzen.
Hoe werken accountgegevens-methoden?
De accountsectie bevat methoden voor het aanmaken, lezen, bijwerken en verwijderen van accountgegevens. Deze acties worden vaak CRUD-bewerkingen genoemd.
- Een account aanmaken
- Een account verwijderen
- Accountgegevens bijwerken
- Accountgegevens ophalen
Wanneer een clientaccount wordt aangemaakt, kan de aanvraag de applicatie bevatten die aan het account moet worden toegewezen. Dit gebeurt via het veld reg_apps. De beschikbare applicaties zijn afhankelijk van het toegangsniveau van de gebruiker en de voorwaarden van de overeenkomst.
Gebruikersrecords worden samen met het clientaccount aangemaakt en blijven inactief totdat het activatieproces is voltooid.
Om het account te activeren:
- De Console-gebruiker stuurt een activatielink naar de client.
- De client volgt de link en voert een e-mailadres en wachtwoord in.
- De client bevestigt de registratie via de bevestigingslink in de e-mail.
- Na bevestiging wordt het gebruikersaccount actief volgens de toegewezen applicatie, het plan en de rechten.
Wordt deze API gebruikt om voertuigen rechtstreeks te volgen?
De API is bedoeld voor GPS-Trace Console-bewerkingen en gegevensuitwisseling met externe systemen. Het is geen vervanging voor de Forguard mobiele applicatie of andere GPS-Trace-trackinginterfaces.
Console-gebruikers kunnen de API gebruiken om met units, clientplannen, statistieken, historie, CRM-systemen en facturatiesystemen te werken, afhankelijk van hun toegangsniveau.
Waarvoor kan de API worden gebruikt?
De Platform API kan worden gebruikt om GPS-Trace te koppelen aan CRM-, facturatie-, rapportage- of interne systemen.
Zo kunnen Console-gebruikers bijvoorbeeld unitgegevens ophalen, met clientplannen werken, statistieken exporteren en herhaalde handmatige acties in externe workflows verminderen.
Kan ik via de API toegang krijgen tot historische trackinggegevens?
Ja, de Platform API kan toegang bieden tot historische trackinggegevens, afhankelijk van de beschikbare methoden en rechten.
Zo haalt de methode GET /partner/units/{id}/messages berichten van een unit op. Het maximale aantal berichten dat kan worden opgehaald is 10.000. Je kunt ook het aantal recente berichten opgeven dat je wilt ontvangen.
Voorbeeldrequest om de laatste 10 berichten op te halen:
curl -X 'GET' \
'https://api.gps-trace.com/partner/units//messages?count=10' \
-H 'accept: application/' \
-H 'X-AccessToken: '
De velden in de response zijn afhankelijk van de parameters die door het trackingapparaat worden verzonden.
Hoe kan ik telemetriegegevens ophalen?
Gebruik de methode GET /partner/units/{id}/telemetry om de nieuwste telemetriegegevens voor een unit op te halen. De response bevat het meest recente telemetriebericht dat beschikbaar is voor de opgegeven unit. Welke velden precies worden teruggegeven, hangt af van de data die door het trackingapparaat wordt verzonden.
Voorbeeldrequest:
curl -X 'GET' \
'https://api.gps-trace.com/partner/units//telemetry' \
-H 'accept: application/' \
-H 'X-AccessToken: '
Hoe kan ik met de API aan de slag?
Meld je aan bij je Console account om API-toegang aan te vragen. Als je die nog niet hebt, kun je je ook hier registreren.