FAQ: Partner API-methoden

Wat is de Partner API?

De GPS-Trace Partner API is een krachtig hulpmiddel waarmee bedrijven geavanceerde GPS-trackingmogelijkheden kunnen integreren in hun bestaande systemen. Het biedt verschillende methoden voor het aanmaken en beheren van gebruikersaccounts en klantplannen, configuratie-eenheden en het genereren van aangepaste rapporten en zelfs het downloaden van statistieken.

Hoe authenticeer ik mijn verzoeken aan de Partner API?

De Partner API maakt gebruik van API-tokenauthenticatie om veilige toegang te garanderen. U moet een API-token genereren vanuit uw account, dat u vervolgens gebruikt om al uw verzoeken te authenticeren.

Wat zijn de belangrijkste functies van de Partner API?

Belangrijke functies van de GPS-Trace API zijn onder andere:

• Accountbeheer
• Bedrijfsbeheer
• Beheer van klantplannen
• Beheer van eenheden
• Gebruikersbeheer
• Facturatiebeheer

Hoe kan ik gebruikers beheren met de Partner API?

De Partner API biedt eindpunten voor gebruikersregistratie en -beheer. U kunt nieuwe gebruikersaccounts aanmaken, gebruikersinformatie bijwerken en klantplannen en sets van modules en permissies beheren om een veilige en georganiseerde gebruikersbasis te garanderen.

Hoe werkt accountbeheer?

De account CRUD-subsectie behandelt methoden met betrekking tot CRUD (Create, Read, Update, Delete) operaties voor accounts, waaronder:

• Accounts aanmaken: Methoden om nieuwe accounts in het systeem aan te maken.
• Accounts verwijderen: Methoden om accounts uit het systeem te verwijderen.
• Accounts bijwerken: Methoden om bestaande accountinformatie bij te werken.
• Accountinformatie ophalen: Methoden om details van specifieke accounts op te halen.

Bij het aanmaken van een klantaccount wordt een applicatie toegewezen aan het account, waardoor de klant toegang krijgt. Dit wordt geïmplementeerd via een verzoek, waarbij een van de verplichte velden "reg_apps" is. ID's van applicaties zijn onder andere:

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

Gebruikersentiteiten worden tegelijkertijd met het aanmaken van een klantaccount aangemaakt en zijn aanvankelijk inactief. 

Om het account te activeren:

• stuurt de partner een speciale activatielink naar zijn klant.
• Bij het klikken op de activatielink voert de klant zijn/haar unieke e-mailadres in (dat aan het account wordt gekoppeld) en een wachtwoord.
• De klant ontvangt vervolgens een registratiebevestigingsmail op het opgegeven adres. Door de link in de e-mail te volgen, voltooit de klant het registratieproces door de gevraagde informatie in het formulier in te voeren, zoals wachtwoord, inlogsleutel, enz.

Als resultaat creëert u een nieuwe gebruiker met behulp van onze API in slechts een paar klikken.

Is het een Partner API of een API voor GPS-monitoring?

Het is zeker een partner API gebaseerd op de functionaliteit van ons Partner Panel. U kunt er uw vloot niet mee monitoren. Het belangrijkste doel is het beheren en aanpassen van klantaccounts en eenheden, het vaststellen van tarieven, het beheren van analyses en geschiedenis. Met onze API kunt u ons partnerplatform integreren met uw CRM- en factureringssysteem.

Hoe kan het mijn bedrijf ten goede komen?

De Partner API vereenvoudigt verschillende operationele aspecten, zoals voertuigbeheer, activatracking en datareporting. Door deze processen te automatiseren, kunnen bedrijven handmatige inspanningen verminderen en de winstgevendheid gemakkelijk verhogen.

Kan ik toegang krijgen tot historische trackinggegevens met de Partner API?

Ja, de GPS-Trace Partner API biedt toegang tot historische trackinggegevens.
Deze gegevens zijn waardevol voor het analyseren van prestaties, het onderzoeken van incidenten en het optimaliseren van toekomstige operaties. U kunt bijvoorbeeld de “GET /partner/units/{id}/messages“ (Get Unit Messages) methode gebruiken om berichten van een apparaat (unit) op Forguard op te halen. Het maximale aantal berichten dat kan worden opgehaald is 10.000, en u kunt ook het aantal recente berichten specificeren dat u wilt verkrijgen.

Voorbeeldverzoek om de laatste 10 berichten op te halen:

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

De velden in de reactie zijn afhankelijk van de parameters die door de tracker zijn verzonden.

Hoe kan aangepaste rapportage mijn bedrijf helpen?

Aangepaste rapportage stelt u in staat om gedetailleerde rapporten te genereren op basis van uw specifieke behoeften.
Deze rapporten kunnen gegevens bevatten over voertuiggebruik en efficiëntie, wat waardevolle inzichten biedt voor besluitvorming en het verbeteren van bedrijfsstrategieën. Om bijvoorbeeld de nieuwste telemetriegegevens van een eenheid te verkrijgen, moet u de “GET /partner/units/{id}/telemetry” (Get Telemetry Data) methode gebruiken.

Voorbeeldverzoek:

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

Als resultaat downloadt u een rapport met het nieuwste telemetriebericht van elk apparaat dat u hebt opgegeven.

Hoe kan ik aan de slag met de Partner API?

Om aan de slag te gaan met de Partner API, kunt u het formulier invullen op deze pagina van onze website of ons schrijven op business@gps-trace.com