Getting started

Getting started
Quotes
Bookings
Trip updates
Settlements
Testing

Between the Karhoo Platform and DMS's are two distinct types of API endpoints:

Karhoo endpoints
These are hosted by Karhoo and used by DMS's to push asynchronous updates to Karhoo
DMS endpoints
These are hosted by the Supply Partner for Karhoo to use to request vehicle availability, quotes and bookings.

Security

Authentication is handled differently for these two classes of endpoints

Authentication

The Karhoo Supply API is authenticated using the same mechanism as all Karhoo Platform APIs. See How to authenticate for details.

Secure communications

For DMS endpoints Karhoo signs messages using a HMAC hash of the Supply Partner's shared secret and the payload of the API request. The HMAC is sent as the x-karhoo-request-signature HTTP header and should be used to validate all requests from Karhoo.

Contact the Karhoo team for help with the above.

API endpoints

Supply API

Name	Purpose	Location	API Reference
Availability	Stream fleet wide vehicle availability to Karhoo	POST `/availability`	Availability
Trip Status	Send trip updates to Karhoo in real-time.	POST `/trip/status`	Trip Status

DMS Integration API

Name	Purpose	Location	API Reference
Receive New Trips	DMS hosted API endpoint for receiving Karhoo trip bookings	POST `/trip`	Receive New Trips
Provide Trip Details	DMS Hosted endpoint to respond to Karhoo Trip Detail requests	GET `/trip`	Provide Trip Details
Cancel Trip	DMS Hosted endpoint to respond to Karhoo Trip Cancellation requests	DELETE `/trip`	Cancel Trip
Update Trip	DMS Hosted API endpoint to respond to Karhoo Trip Update requests to your DMS platform.	PUT `/trip`	Update Trip
Quote Request	DMS hosted API endpoint for responding to quote requests	POST `/quote`	Quote Request
ETA Request	DMS hosted API endpoint for responding to ETA requests	POST `/eta`	ETA Request
Availability Request	Karhoo Availability Request to DMS	POST `/availability`	Availability