Naar de hoofdinhoud

RAM Externe API

Handleiding voor het gebruik van de RAM API.

Krijg programmatisch toegang tot uw voertuigvolggegevens met onze externe API. Perfect voor het integreren van RAM-gegevens in uw eigen systemen, apps of dashboards.

Aan de slag

Wat je nodig hebt:

  • Een actief RAM-account

  • Basiskennis van API's en HTTP-verzoeken

  • Ontwikkeltools zoals Postman of een programmeertaal naar keuze

Volledige API-documentatie: https://api.qaifn.co.uk/swagger/docs

Vraag uw API-gegevens aan

  1. Klik op het profielpictogram in de rechterbovenhoek.

  2. Selecteer 'API-sleutel ophalen' in het dropdownmenu.

  3. Klik op de knop 'API-sleutel ophalen' om uw inloggegevens te genereren.

Je ontvangt:

  • Klant-ID

  • Klantgeheim

  • API-gebruikersnaam en -wachtwoord

Hoe de API te gebruiken

  • Stap 1: Verkrijg uw toegangstoken - Stuur een verzoek naar ons authenticatie-eindpunt met uw inloggegevens: https://auth.qaifn.co.uk/oauth/token . Vermeld uw API-gebruikersnaam, wachtwoord, client-ID en geheim.

Belangrijke beperkingen

  • Snelheidsbeperking: U kunt maximaal 3 verzoeken per minuut per eindpunt indienen. Dit voorkomt overbelasting van onze servers en garandeert een betrouwbare service voor alle gebruikers.

  • Gegevenssynchronisatie: Voertuiggegevens zijn in realtime beschikbaar, zodat u altijd over de meest actuele informatie beschikt.

Beschikbare gegevens

Onze API biedt toegang tot uitgebreide voertuigvolggegevens, waaronder:

  • Locaties en routes van voertuigen

  • Snelheid en rijgedrag

  • Reisgeschiedenis

  • Bestuurdersinformatie

  • Voertuigstatus en diagnose

Voor een complete lijst van beschikbare eindpunten en gegevensvelden kunt u onze Swagger-documentatie raadplegen via de bovenstaande link.

Overweeg in plaats daarvan webhooks.

Voordat je begint met API-polling, kun je overwegen om webhooks te gebruiken. In plaats van steeds opnieuw om nieuwe gegevens te vragen, sturen webhooks automatisch informatie naar je systeem wanneer er gebeurtenissen plaatsvinden.

Voordelen van webhooks

  • Realtime gegevenslevering

  • Geen snelheidslimieten

  • Efficiënter dan opiniepeilingen

  • Verminderde serverbelasting

Hulp krijgen

Belangrijk: Ons supportteam kan geen ontwikkelingsondersteuning bieden voor de externe API. We hebben echter een Postman-collectie samengesteld om u op weg te helpen.

Kopieer de onderstaande JSON naar een bestand, importeer het vervolgens in Postman en voer uw inloggegevens in om verbinding te maken met de externe API.

 { info: { _postman_id: a80d4065-e21a-41c1-8cba-d04727d1f569, name: External API Customer Example, schema: https://schema.getpostman.com/json/collection/v2.1.0/collection.json, _exporter_id: 21728610 }, item: [ { name: Get Token, event: [ { listen: test, script: { exec: [ var jsonData = pm.response.json();, pm.environment.set(access_token, jsonData.access_token); ], type: text/javascript } } ], request: { auth: { type: basic, basic: [ { key: password, value: {secret}, type: string }, { key: username, value: {clientId}, type: string } ] }, method: POST, header: [], body: { mode: formdata, formdata: [ { key: grant_type, value: password, type: text }, { key: username, value: {username}, type: text }, { key: password, value: {password}, type: text } ] }, url: { raw: https://auth.qaifn.co.uk/oauth/token, protocol: https, host: [ auth, qaifn, co, uk ], path: [ oauth, token ] } }, response: [] }, { name: GET All Vehicles for Account Copy, request: { auth: { type: bearer, bearer: [ { key: token, value: ######{{access_token}}, type: string } ] }, method: GET, header: [], url: { raw: https://api.qaifn.co.uk/api/v1/vehicle/for-account, protocol: https, host: [ api, qaifn, co, uk ], path: [ api, v1, vehicle, for-account ] } }, response: [] } ]}

Heb je nog steeds problemen met het instellen van de API?

Was dit een antwoord op uw vraag?