Overview

SERVICE DESCRIPTION

This service enables connection through the GHUBEE interface, facilitating integration and providing information about the vehicle's traveled perimeter.

INTEGRATION SPECIFICATION
Service Details:

Service Name	Geofence
Context	/ELD/geofences
Description	Query geofence information on ELD devices.
Endpoint	https://ghubee.com/api/{eld}/geofences
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 geofence 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	N existe esses filtros (n retorna nd)	-	-	-
driver_license_number	Driver's license number	N existe esses filtros (n retorna nd)	-	-	-
driver_license_state	State where the driver's license was issued	N existe esses filtros (n retorna nd)	-	-	-
geofence_id	ID of each geolocation	Biginterger	-	No	No

Data input example:

Access URL: https://ghubee.com/api/{eld}/geofences/{geofence_id}

Headers - Information that standardizes the submissions

Content-Type: application/json

Accept: application/json

Authorization: Bearer token_ghubee

Data output

Return of the geofence API output data.

Field	Description	Format	Size	Required	Remarks
id	Geofence ID	Biginterger	-	Yes	No
name	Nome da geolocalização ou do motorista (confirmar)	String	-	Yes	No
category (type of locale)	Geofence reference point	String	-	Yes	No
status	Regarding movement, whether it is active or inactive	String	-	Yes	No
adress	Geofence adress	String	-	Yes	No
perimeter (latitude and longitude group)	Regarding the perimeter (latitude and longitude group)	Coordinates (format Array) and latitude/longitude (format decimal)	-	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