Overview

SERVICE DESCRIPTION

This service enables connection through the GHUBEE interface, facilitating integration and retrieving vehicle information based on the provided input data.

INTEGRATION SPECIFICATION
Service Details:

Service Name	Vehicles
Context	/ELD/vehicles
Description	Query vehicle information on ELD devices
Endpoint	https://ghubee.com/api/{eld}/vehicles
Environment Specifications	https://ghubee.com/api
Protocol/Transport	HTTPS
Method	GET
Representation format	JSON
Input/Output Interface or Both	Both
Data transformation	No

Assumption:

The service must be invoked with the mandatory fields filled in.

If the request includes filters, the relevant filter fields must be correctly provided.

Authentication is required to access services within GHUBEE.

Data input

Identification of the input data for the vehicle API.

Field	Description	Format	Size	Required	Remarks
ELD_name	ELD Name that appears in the URL	Parameter	-	Yes	Supported: motive, truckspy, multiportal, geotab, sandbox
Token_Ghubee	Token that allows GHUBEE to access the ELD	Authorization: Bearer token_ghubee	-	Yes
vehicle_id	The Vehicle ID	Parameter	-	No	If omitted, returns all vehicles
start_date	Start date filter	Filter	-	No	Format: `YYYY-MM-DD` (e.g., 2024-01-15).
end_date	End date filter	Filter	-	No	Format: `YYYY-MM-DD` (e.g., 2024-12-31)

Data input example:

Access URL: https://ghubee.com/api/{eld}/vehicles/{vehicle_id}?start_date&end_date

Headers - Information that standardizes the submissions

Content-Type: application/json

Accept: application/json

Authorization: Bearer token_ghubee

ELD-Specific Credentials

Depending on the chosen ELD, you must provide the corresponding credentials as headers:

ELD	Required Headers	Description
truckspy	client-id client-secret	OAuth credentials from your Truckspy account
multiportal	username password appid	MultiPortal login credentials + application ID
geotab	username password database	Geotab login credentials + database name
motive	access-token-motive OR api-key-eld	Access token or API Key from your Motive account
sandbox	-	No additional credentials required

Data output

Return of the vehicle API output data

Field	Description	Format	Size	Required	Remarks
vehicle_id	Returns the Vehicle ID	Biginterger	-	Yes	No
driver_id	Returns the Driver ID	Biginterger	-	Yes	No
v-number	Returns the vehicle registration number	String	-	Yes	No
vehicle_model	Returns the vehicle model	String	-	Yes	No
vehicle_year	Returns the vehicle's year of manufacture	String	-	Yes	No
state_licensing	Returns the state to which the vehicle is registered	String	-	Yes	No
id_ELD_Device	Returns the ELD device ID	Biginterger	-	Yes	No
actual_odometer	Returns the vehicle's mileage	Biginterger	-	Yes	No
status	Vehicle status	String	-	No	No
license_plate	Vehicle license plate	String	-	No	No
vin	Vehicle vin(chassis) number	String	-	Yes	No
connections	Vehicle connections	Array	-	Yes	Only for Truckspy

Error messages

Identification and description of error message types.

Situation	Message Code	Message description
Unauthenticated	{ "status": "Error", "message": "Unauthenticated", "data": null }	Authentication error with GHUBEE.
The user is not enabled. Please enable the integration through the web panel	{ "status": "Error", "message": "The user is not enabled. Please enable the integration through the web panel.", "data": null }	Authentication error with the ELD.
Vehicle not found	{ "status": "Error", "message": "vehicle not found", "data": null }	The vehicle ID was not identified.
Integration not found	{ "status": "Error", "message": "Integration not found", "data": null }	Some data was entered incorrectly