RAM Tracking fournit une API permettant aux clients d'utiliser les données de suivi de leurs véhicules
Documentation externe de l'API Swagger : https://api.qaifn.co.uk/swagger/docs
Comment puis-je obtenir un ID client et un secret pour l'API ?
Une fois que vous vous êtes connecté à votre portail RAM Tracking et que vous avez cliqué sur l'icône en forme de visage en haut à droite de l'écran, les options déroulantes incluent une clé API d'obtention et vous verrez ici un bouton marqué obtenir une clé API.
Utilisation de l'API externe
Authentifiez-vous pour obtenir un jeton
Transmettez votre nom d'utilisateur et votre mot de passe d'utilisateur API, votre jeton et votre secret à https://auth.qaifn.co.uk/oauth/token
Utiliser le jeton pour faire des requêtes
Vous pouvez ensuite utiliser ce jeton pour authentifier les requêtes adressées à l'API telles que https://api.qaifn.co.uk/api/v1/vehicle/for-account en incluant le jeton de l'étape 1 en tant que jeton du porteur.
Comment les données sont-elles synchronisées entre le suivi RAM et l'API externe ?
Les données sont disponibles en temps réel, mais le débit des requêtes est limité à 3 requêtes par minute pour chaque point de terminaison individuel.
Quelles données sont disponibles via l'API externe.
Veuillez consulter le document Swagger pour le dernier guide sur les points finaux disponibles.
Avez-vous pensé à utiliser des Webhooks ?
Nous avons une intégration de webhook qui fournit un flux de données de suivi à un point de terminaison que vous définissez et qui transmet les données au fur et à mesure que l'événement se produit plutôt que d'avoir à interroger de nouvelles données. Vous pouvez en savoir plus ici : https://help.ramtracking.com/en/articles/6873160-what-are-webhooks
Obtenir de l'aide avec l'API
Notre équipe d'assistance n'est pas en mesure de fournir une assistance au développement avec l'API externe, mais vous trouverez ci-dessous notre collection de tests Postman pour vous aider à démarrer. Copiez simplement le JSON ci-dessous dans un fichier, puis importez-le dans Postman et entrez vos informations d'identification pour vous connecter à l'API externe.
{ "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": [] } ]}