Passer au contenu principal
Toutes les collectionsAdministration
API
API
Mis à jour il y a plus d'un mois

Introduction

👋 L'API tout-en-un pour les données, les opérations et la maintenance de vos équipements

Notre API est faite pour vous, n'hésitez pas à nous faire part de vos commentaires ou de vos idées, nous sommes à votre écoute. L'objectif principal de notre API est de vous permettre d'utiliser toutes les données relatives aux équipements d'une manière qui ait du sens.

Fonctionnement

Documentation

La version actuelle est la V2.

Environnements

⚠️ Les identifiants ne sont pas les mêmes entre Sandbox et Production

Endpoints

Login

  • POST • /login

    Authenticate on the API

Fleet

  • GET • /v2/fleet/equipments

    Returns the list of all equipments and their identity

  • GET • /v2/fleet/equipments/history

    Returns the list of all equipments and their history: daily usages (hours, distance, cumulativeOperatingHours...), positions, fault codes, fuel remaining, engine conditions

  • GET • /v2/fleet/equipments/snapshot

    Returns the list of all equipments snapshot

  • GET • /v2/fleet/equipments/{id}/snapshot

    Returns the last information available for all data kinds for specific equipment

  • GET • /v2/fleet/equipments/{id}/{dataKind}

    Returns all data available for one dataKind for specific equipment. It's the timeseries mindset of the ISO/AEMP standard.

FAQ

Avez-vous un cURL ?

Voici un curl avec les exigences minimales :

curl -X POST 'https://api-sandbox.hiboo.io/login' \ 
--header 'Content-Type: application/json' \ 
--data-raw '{ 
"email": "FILL_YOUR_EMAIL", 
"password": "FILL_YOUR_PASSWORD" 
}'

J'ai reçu une erreur, que dois-je faire ?

N'hésitez pas à nous contacter ([email protected]) en détaillant l'erreur que vous recevez.

Si vous recevez quelque chose comme :

{"message":"Error: WHERE parameter \"email\" has invalid \"undefined\" value"}

Vous pouvez essayer d'y remédier en ajoutant un header tel que Content-Type: application/json

Y a-t-il une rate-limit?

Il n'y a aucune rate limit sur aucun de nos endpoints, mais les données changeront au maximum une fois toutes les 10 minutes.

Quelle est la time range que je peux obtenir ?

Pour les endpoints où des dates peuvent être fournies comme paramètres (tels que /equipments/history), la valeur maximale possible est de 14 (quatorze) jours avant la date du jour.

Quelle est la fréquence des données ?

  • La quantité de données fournies peut varier pour un seul paramètre en fonction de la source des données. Une valeur par jour au maximum peut être fournie pour toutes les variables quotidiennes (dailyFuel, dailyDistance...). Plusieurs valeurs par jour peuvent être fournies pour toutes les autres variables. (cumulativeUsageHours, positions, cumulativeDistances...)

  • Certains constructeurs ne fournissent qu'une valeur cumulée par jour, d'autres peuvent fournir jusqu'à une valeur par minute.

  • Dans notre environnement sandbox, il y a moins de données aujourd'hui. Vous pouvez vous attendre à un point de données par jour. Tous les points de données ne sont pas encore traités, par exemple CumulativePowerTakeOff n'est pas encore disponible.

Avez-vous une collection Postman ?

Oui, vous pouvez télécharger notre spécification OpenAPI sur https://docs.hiboo.io (bouton Download en haut de la page) puis l'importer dans Postman.

Je reçois des erreurs 503, que dois-je faire ?

  • Veuillez nous en informer dès que possible et nous indiquer l'URL exacte et les paramètres utilisés.

  • Cela est probablement dû à un volume élevé de données demandées. Veuillez essayer de réduire la limite et/ou la période de temps utilisée.

Quelles sont les données disponibles ?

➡️ Notez que toutes ces données ne sont pas disponibles dans l'environnement sandbox et le seront dans l'environnement de production si l'équipement fournit les données.

  • positions: Historique de la latitude et de la longitude visitées par l'équipement

  • faultCodes: Également appelés codes erreur. Les codes erreur sont des indicateurs de fonctionnement hors tolérance ou de défaillance des composants.

  • fuelRemainings: Pourcentage de carburant restant dans le réservoir de l'équipement.

  • engineConditions: Vrai si le moteur est passé de la marche à l'arrêt. Faux si le moteur est passé de l'arrêt à la marche.

  • Jour par jour

    • operatingHours: Nombre total d'heures de fonctionnement du moteur à cette date

    • idleHours: Nombre total d'heures de fonctionnement au ralenti du moteur à cette date.

    • workingHours: Nombre total d'heures « utiles », c'est-à-dire d'heures où le moteur n'est pas au ralenti, à cette date.

    • fuelUsed: Le nombre total de litres de carburant utilisés à cette date.

    • distance: Nombre de kilomètres parcourus à cette date

  • cumulativeIdleHours: Nombre total d'heures d'inactivité depuis le démarrage initial de l'équipement.

  • cumulativeOperatingHours: Nombre total d'heures de fonctionnement du moteur depuis la mise en service initiale de l'équipement.

  • cumulativeFuelUsed: Nombre total de litres de carburant utilisés depuis la mise en service initiale de l'équipement.

  • cumulativeDistance: Nombre total de kilomètres parcourus depuis la mise en service initiale de l'équipement.

  • cumulativeLoadCount: Le nombre de cycles effectués par la machine.

  • cumulativePayloadTotal: Charge utile totale soulevée, transportée ou traitée par la machine.

  • cumulativeActiveRegenerationHours: Durée pendant laquelle la machine est placée dans un état non productif pour achever le processus de régénération.

  • cumulativePowerTakeOffHours: Temps pendant lequel la prise de force a entraîné un outil tel qu'une tondeuse ou un pulvérisateur.

  • peakDailySpeed: Utilisé pour surveiller la vitesse excessive de la machine afin d'identifier une mauvaise utilisation ou une sous-utilisation de la machine.

  • averageDailyEngineLoadFactor: Le pourcentage calculé comme le carburant réel consommé au cours des 24 heures précédentes divisé par le carburant qui aurait été consommé au cours de cette période si la machine avait fonctionné continuellement à la puissance nominale du moteur.

  • DEFRemainingRatio: Le pourcentage de DEF (Diesel exhaust fluid) restant est utilisé pour programmer la livraison de DEF au véhicule.

Il existe des données quotidiennes, mais qu'en est-il du fuseau horaire ?

Excellente question, lorsque nous calculons les données journalières (operatingHours, idleHours, fuelUsed...) le fuseau horaire de l'équipement est pris en considération.

Ainsi, si vous recherchez des données pour 2022-04-20T00:00:00Z, nous ne devrions en fait fournir que 2022-04-20 car l'heure prise en compte dépend de la géolocalisation de l'équipement.

Par exemple, si un équipement se trouve dans le fuseau horaire Amérique/Pacifique, nous prendrons en compte l'activité entre 2022-04-20T07:00:00Z et 2022-04-21T06:59:59Z.

Avez-vous trouvé la réponse à votre question ?