Overview

SERVICE DESCRIPTION

This service enables connection through the GHUBEE interface, facilitating integration and providing information about vehicle and driver safety. This allows for monitoring and analyzing non-standard driving behaviors, such as acceleration, braking, cornering, and distractions like cellphone use or eating while driving, among others.

INTEGRATION SPECIFICATION
Service Details

Service Name	Safety drivers
Context	/ELD/safety-drivers
Description	Query safety driver information on ELD devices
Endpoint	https://ghubee.com/api/{eld}/safety-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 safety 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
vehicle_id	Vehicle ID	Parameter	-	No	Yes
event_types (hard_accel, hard_brake, hard_corner, manual_event, crash, etc.)	Types of event	Parameter	-	No	Yes

Data input example

Access URL: https://ghubee.com/api/{eld}/safety-drivers?driver_license_company&driver_license_number&driver_license_state&vehicle_id&event_types

Headers - Information that standardizes the submissions

Content-Type: application/json

Accept: application/json

Authorization: Bearer token_ghubee

Data output

Return of the safety driver API output data.

Field	Description	Format	Size	Required	Remarks
id	Safety driver ID	Biginterger	-	Yes	No
acceleration	Vehicle acceleration	Decimal	-	Yes	No
duration	Duration	Decimal	-	Yes	No
end_bearing	End bearing	Decimal	-	Yes	No
end_speed	End speed	Decimal	-	Yes	No
end_time	End time	Timestamp	-	Yes	No
lat	Latitude	Decimal	-	Yes	No
lon	Longitude	Decimal	-	Yes	No
m_gps_heading	GPS heading magnitude	Array with decimals inside	-	Yes	No
m_gps_lat	GPS latitude magnitude	Array with decimals inside	-	Yes	No
m_gps_lon	GPS longitude magnitude	Array with decimals inside	-	Yes	No
m_veh_odo	Vehicle odometer reading	Array with decimals inside	-	Yes	No
m_veh_spd	Vehicle speed measurement	Array with decimals inside	-	Yes	No
start_bearing	Initial heading	Decimal	-	Yes	No
start_speed	Initial speed	Decimal	-	Yes	No
start_time	Start time	Timestamp	-	Yes	No
type	Type of device associated with the safety driver	String	-	Yes	No
max_speed	Maximum speed	Decimal	-	Yes	No
min_speed	Minimum speed	Decimal	-	Yes	No
driver	Driver informatio	Array with driver information	-	Yes	No
id	Driver ID	Biginterger	-	Yes	No
first_name	Driver's first name	String	-	Yes	No
last_name	Driver's last name	String	-	Yes	No
username	driver's username	String	-	Yes	No
email	Driver's email address	String	-	Yes	No
driver_company_id	Driver's company ID	String	-	Yes	No
mcleod_id	Mcleod ID	String	-	Yes	No
status	Driver activity status	String	-	Yes	No
role	Role (in this case, driver)	String	-	Yes	No
vehicle	Vehicle information	Array with vehicle information	-	Yes	No
id	Vehicle ID	Biginterger	-	Yes	No
number	Vehicle number	String	-	Yes	No
year	Year of the vehicle	Biginterger	-	Yes	No
make	Make of the vehicle	String	-	Yes	No
model		String	-	Yes	No
vin	Vehicle identification number	String	-	Yes	No
metric_unit	unit of measurement (kilometer or mile)	Boolean	-	Yes	No
mcleod_id	Mcleod ID	String	-	Yes	No
eld_device	ELD device information	Array with ELD device information	-	Yes	No
id	ELD ID	Biginterger	-	Yes	No
identifier	ELD identifier	String	-	Yes	No
model	ELD device model	String	-	Yes	No
camera_media	Camera information	Array with camera information	-	Yes	No
id	Camera ID	Biginterger	-	Yes	No
available	Camera availability	Boolean	-	Yes	No
cam_positions	Camera position	Array	-	Yes	No
driver_facing	Camera facing the driver	String	-	Yes	No
cam_type	Camera type	String	-	Yes	No
uploaded_at	Date and time when the file or data was uploaded to the system	Timestamp	-	Yes	No
start_time	Camera start time	Timestamp	-	Yes	No
duration	Camera recording duration	Decimal	-	Yes	No
downloadable_videos	Availability of videos for download	Array	-	Yes	No
front_facing_enhanced_url	Enhanced front-facing camera URL	String	-	Yes	No
front_facing_enhanced_ai_viz_url	AI-enhanced front-facing camera visualization URL	String	-	Yes	No
dual_facing_enhanced_url	Enhanced dual-facing URL	String	-	Yes	No
dual_facing_enhanced_ai_viz_url	AI-enhanced dual-facing visualization URL	String	-	Yes	No
front_facing_plain_url	Front facing plain URL	String	-	Yes	No
driver_facing_plain_url	Plain URL of the driver-facing camera	String	-	Yes	No
auto_transcode_status	Automatic transcoding status	String	-	Yes	No
downloadable_images	Downloadable images	Array	-	Yes	No
front_facing_jpg_url	Front-facing JPG URL	String	-	Yes	No
driver_facing_jpg_url	Driver-facing JPG URL	String	-	Yes	No
location	Location	String	-	Yes	No
intensity	Intensity	String	-	Yes	No
coaching_status	Status de orientação	String	-	Yes	No
coached_at	The training occurred on [data e hora]	Timestamp	-	Yes	No
coachable_behaviors	Coachable behaviors	Array	-	Yes	No
event_intensity	Event (vehicle related to the driver)	Array with information inside	-	Yes	No
name	Driver name associated with the vehicle	String	-	Yes	No
value	Value	Decimal	-	Yes	No
unit_type	Unit type	String	-	Yes	No
metadata	Metadata	Array with information inside	-	Yes	No
additional_context	Additional context	Array	-	Yes	No
slope	Slope	Array	-	Yes	No
Lighting	Lighting	Array	-	Yes	No
Road_type	Road type	Array	-	Yes	No
Lane_spacing	Lane spacing	Array	-	Yes	No
Tpv_behavior	Tpv behavior	Array	-	Yes	No
Road_geometry	Road geometry	Array	-	Yes	No
Vehicle_speed	Vehicle speed	Array	-	Yes	No
Sensitive_zone	Sensitive zone	Array	-	Yes	No
Road_conditions	Road conditions	Array	-	Yes	No
road_visibility	Road visibility	Array	-	Yes	No
Traffic_density	Traffic density	Array	-	Yes	No
Driving_visibility	Driving visibility	Array	-	Yes	No
Traffic_conditions	Traffic conditions	Array	-	Yes	No
Traffic_violations	Traffic violations	Array	-	Yes	No
annotation_tags	Annotation tags	Array	-	Yes	No
seat_belt_violation	Seat belt violation	String	-	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