Blue Ink Technology

Less Paperwork, More Driving


Unsplashed background img 1

API Docs

Making a Call

BIT offers a RESTful API that only sends its responses back in JSON format. Currently, we only support GET, POST, and PUT call types. The address for these calls are made in the format found below. The first is when a resource is called in general, with option of more specific parameters being applied from there, and the second is there when you're looking for a specific driver or vehicle.

https://blueinktech.com/api/v1/<resource>
https://blueinktech.com/api/v1/<resource>/<id>

Each call must contain the x-api-key header along with the API key generated by the user for authentication purposes. The next section covers obtaining a key.

Authenticating

To make any calls using the BIT API, you'll need to generate an API key to use. This can be done by going to the "My Account" page in the web portal. Once there, click "Request API Key" in the "My API Keys" section of the page. You'll be presented with two sets of options: the carrier that will be using the key, and the second is the type of permissions the key will have (Read-Only or Read/Write). Once you've selected these options, you can click the key to copy it, or click on its type to change its permissions.

When a key is generated, all actions taken while using that key will be performed as if the user that generated the key had performed them. A key can only act within the carrier it was generated for, and may not be used to perform actions for other carriers even if the user generating the key is an admin for those carriers. A carrier is currently allowed up to 200 requests an hour across all keys. If the user that generated a key is removed as an admin for the carrier that the key was generated for, the key will no longer work.

Standard Parameters

The following parameters are standard to nearly every GET call that is made.

Name Type Description
page int This is used for the purposes of pagination. It defaults to 1 if nothing is supplied.
per_page int This is used for the purposes of pagination. It defaults to 25 if nothing is supplied.
timezone string This is used when a call receives or outputs a date/time. The default time that is used is UTC. The following are a list of valid time zones.
  • US/Eastern
  • US/Pacific
  • US/Samoa
  • US/Hawaii
  • US/Alaska
  • US/Central
  • US/Mountain
  • Canada/Atlantic
  • Pacific/Guam
  • US/Arizona
GET Users

This returns a list of users for the carrier. Below are the addresses to access it and a list of parameters that can be supplied. The <id> in the address may be replaced with the id of a specific user.

https://blueinktech.com/api/v1/users/
https://blueinktech.com/api/v1/users/<id>

Name Type Description
duty_status string Search for users with this as their last duty status. Valid duty statuses are:
  • off_duty
  • on_duty
  • sleeper
  • driving
  • yard_move
  • personal_use
user_role string Search for a user of this role. Valid roles are:
  • admin
  • driver
  • user
Example Response
GET Vehicles

This returns a list of vehicles for the carrier. Below are the addresses to access it and a list of parameters that can be supplied. The <id> in the address may be replaced with the id of a specific vehicle.

https://blueinktech.com/api/v1/vehicles/
https://blueinktech.com/api/v1/vehicles/<id>

Name Type Description
driver_ids string Search for vehicles by its last driver. This is a comma delimited list of driver ids.
Example Response
GET Inspections

This returns a list of DVIRs for the carrier. Please note that a date range is required.

https://blueinktech.com/api/v1/inspections

Name Type Description
start_date required
date (YYYY-MM-DD)
Date start
end_date required
date (YYYY-MM-DD)
Date end
driver_ids string A comma delimited list of driver ids that have performed inspections.
vehicle_ids string A comma delimited list of vehicle ids that have had inspections performed on them.
status string Show inspections with or without defects. If no status is specified, vehicles with both defects and no defects will be returned. Valid inputs are:
  • with_defects
  • no_defects
Example Response
GET Logs

This returns a list of a driver's logs. Below are the addresses to access it and a list of parameters that can be supplied. Please note that a date range and driver id are required.

https://blueinktech.com/api/v1/logs

Name Type Description
start_date required
date (YYYY-MM-DD)
Date start
end_date required
date (YYYY-MM-DD)
Date end
driver_id required
int
Search for logs with this driver's user id.
Example Response
GET Vehicle Locations

This returns a list of current locations for vehicles. The <id> in the address may be replaced with the id of a specific vehicle.

https://blueinktech.com/api/v1/vehicle_locations/
https://blueinktech.com/api/v1/vehicle_locations/<id>

Example Response
GET Driver Locations

This returns a list of current driver locations. Below is the address to access it and a list of parameters that can be supplied.

https://blueinktech.com/api/v1/driver_locations

Name Type Description
driver_ids string A list of comma delimited driver ids used for getting their current location.
Example Response
POST User

This starts the creation of a new user and sends an invite to the email address that's listed to finish account creation. The response returns the newly created user id.

https://blueinktech.com/api/v1/users

Name Type Description
email required
string
The user's email. This will be the address the invitation will be sent to as well as their login.
first_name required
string
The user's first name.
last_name required
string
The user's last name.
role required
string
The role the user will occupy. The following is a list of valid values.
  • administrator
  • driver
Example Response
POST Vehicle

This creates a new vehicle. The response that is returned is the newly created vehicle

https://blueinktech.com/api/v1/vehicles

Name Type Description
number required
string
This is the name of the vehicle that will be created.
vin required
string
The VIN of the vehicle.
Example Response
PUT Vehicle

This updates a vehicles name. Names are unique within each carrier.

https://blueinktech.com/api/v1/vehicles

Name Type Description
id required
int
The id of the vehicle to be updated.
number string The new name of the vehicle
Example Response