Overview

SERVICE DESCRIPTION

This service enables connection through the GHUBEE interface, facilitating integration and providing information about drivers based on the provided input data.

INTEGRATION SPECIFICATION
Service Details:

Service Name	Driver
Context	/ELD/drivers
Description	Query drivers information on ELD devices
Endpoint	https://ghubee.com/api/{eld}/drivers
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 data 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 driver API.

Field	Description	Format	Size	Required	Remarks
ELD_name	ELD Name that appears in the URL	Parameter	-	Yes	No
Token_Ghubee	Token that allows GHUBEE to access the ELD	Authorization: Bearer token_ghubee	-	Yes	No
driver_license_company	company responsible for issuing the driver's license	Parameter		No	Yes
driver_license_number	Driver's license number	Parameter		No	Yes
driver_license_state	State where the driver's license was issued	Parameter		No	Yes

Data input example:

Access URL:

https://ghubee.com/api/{eld}/drivers?driver_license_company&driver_license_number&driver_license_state

https://ghubee.com/api/{eld}/drivers/{driver_id}

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 driver API output data

Field	Description	Format	Size	Required	Remarks
first_name	Driver's first name.	String	-	Yes	No
last_name	Driver's last name.	String	-	Yes	No
email	Driver's email	String	-	Yes	No
phone_number	Driver's phone number	String	-	Yes	No
time_zone	Time zone of the server closest to the driver	String	-	Yes	No
role	Related to his role, which in this case will be driver	String	-	Yes	No
status	Driver status (active/inactive)	String	-	Yes	No
driver_license_number	Driver's license number	String	-	Yes	No
driver_license_state	Regarding the driver's license status	String	-	Yes	No
mobile_current_sign_in_at	Driver's current mobile sign-in at (date and time).	Timestamp	-	Yes	No
mobile_last_sign_in_at	Driver's last sign-in on mobile at (date and time)	Timestamp	-	Yes	No
mobile_last_active_at	Date and time of the driver's last mobile activity	Timestamp	-	Yes	No
web_last_active_at	Date and time of the driver's last web activity	Timestamp	-	Yes	No
create_in_timezone	Time zone of the driver's creation	Timestamp	-	Yes	No
updated_in_timezone	Driver's update time zone	Timestamp	-	Yes	No

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