Introduction

👋 The all-in-one API for your equipment data, operations, and maintenance

Our API is made for you, please share with us any feedback or ideas you may have. We are all ears. The main goal of our API is to allow you to use all the equipments data in a way that makes sense.

Fonctionnement

Documentation

Current version is V2.

Environments

⚠️ Credentials are not the same between Sandbox and Production

Sandbox. Generated data to help you integrate our API
https://api-sandbox.hiboo.io

Production. All your actual equipment data
https://api.hiboo.io

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

Do you have a cURL?

Here is a curl with the minimum requirements:

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

I got an error, what should I do?

Don't hesitate to contact us ([email protected]) with the error you get.

If you receive something like :

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

You can try fixing it by adding a header like Content-Type: application/json

Is there a rate-limit?

There is no rate limit on any of our endpoints, but the data will change at most once every 10min

What time range can I request ?

For endpoints where dates can be provided as parameters (such as /equipments/history), the maximum possible value is 14 (fourteen) days before the current date.

What is the frequency of the data ?

The amount of data given can vary for a single endpoint depending on the source of the data. One value per day at maximum can be provided for all daily variables (dailyFuel, dailyDistance...). Multiple values per day can be provided for all other variables (cumulativeUsageHours, positions, cumulativeDistances...)
Some constructors provide only one cumulative value per day, others can provide up to one value per minute
In our sandbox environment there is less data today. You can expect one data point per day. All data point are not handled too, for instance CumulativePowerTakeOff is not yet available.

Do you have a Postman collection?

Yes, you can download our OpenAPI specification on https://docs.hiboo.io (Download button at the top of the page) then import it on Postman

I receive 503 errors, what should I do?

Please let us know as soon as possible and let us know the exact URL and parameters used.
It is probably due to a high volume of data requested. Please try to reduce the limit and/or the time frame used.

What data are available?

➡️ Note that all those data are not available on the sandbox environment and will be available on production if the equipment provide the data

positions: History of the latitude and longitude visited by the equipment
faultCodes: Also called Diagnostic Trouble Codes. Fault codes are an indicator of components operating out of tolerance or failure.
fuelRemainings: Percentage of fuel remaining in the equipment's tank.
engineConditions: True if engine went from running to stopped. False if engine went from stopped to running.
Day by day
- operatingHours: The total number of engine hours on this date
- idleHours: The total number of idle engine hours on this date
- workingHours: The total number of "useful" e.g. non-idle engine hours on this date
- fuelUsed: The total of liter of fuel used on this date
- distance: Number of kilometers traveled on this date
cumulativeIdleHours: The total number of idle hours since the initial start of the equipment
cumulativeOperatingHours: The total number of engine hours since the initial start of the equipment
cumulativeFuelUsed: The total number of liters of fuel used since the initial start of the equipment
cumulativeDistance: The total number of kilometers traveled since the initial start of the equipment
cumulativeLoadCount: The number of cycles performed by the machine.
cumulativePayloadTotal: Total payload lifted, hauled or processed by the machine.
cumulativeActiveRegenerationHours: The time when the machine is placed in a non-productive state to complete the regeneration process.
cumulativePowerTakeOffHours: The time the power take off was driving an implement such as a mower or sprayer.
peakDailySpeed: Used to monitor excessive machine speed to identify machine misuse or underuse.
averageDailyEngineLoadFactor: The percentage calculated as the actual fuel consumed over the previous 24 h period divided by the fuel that would have been consumed during that period if the machine had been continually operated at the engine’s rated output.
DEFRemainingRatio: The percent of DEF — Diesel exhaust fluid — remaining is used to schedule DEF delivery to the vehicle

There’s daily data, but what about timezone?

Great question, when we compute daily data (operatingHours, idleHours, fuelUsed...) the timezone of the equipment is taken into consideration.

So if you fetch data for 2022-04-20T00:00:00Z, we should actually only provide 2022-04-20 as the time we consider depends on the geolocation of the equipment.

For instance, if an equipment is on the America/Pacific timezone, we would consider activity between 2022-04-20T07:00:00Z and 2022-04-21T06:59:59Z