API Developer Guide

Overview

Welcome to the API Developer Guide. Please use the sandbox URL for testing purposes. When using the production version, ensure you have the production key and access. If you would like to opt into the program, please contact info@coachhire.com.

Authentication

To access the API, you must first log in using your credentials. The login URL is:

POST /api/auth/login

Request

URL: /api/auth/login

Method: POST

Content-Type: application/json

Body Parameters:

username (string): Your username.
password (string): Your password.

Example Request

{
  "username": "your_username",
  "password": "your_password"
}

Successful Response:

{
  "token": "your_token_here"
}

Example Response:

{
  "token": "abc123xyz456"
}

Using the Token

Once you have the token, you need to include it in the header of your API requests. Use the following format:

Authorization: Bearer your_token_here

Example of an Authenticated Request

GET /api/your_endpoint
Host: api.yourdomain.com
Authorization: Bearer abc123xyz456

Make sure to replace abc123xyz456 with the actual token received from the login endpoint.

Fetching Booking Price

To get the booking price, you need to send a request to the /api/booking/price endpoint. This request requires authentication with the token, an AccessKey, and the following body parameters.

Request

URL: /api/booking/price

Method: POST

Content-Type: application/json

Headers:

Authorization: Bearer your_token_here
AccessKey: your_secret_key_here

Body Parameters:

pickupDateTime (string): The date and time for pickup (format: "YYYY-MM-DD HH:MM:SS").
pickupAddress (string): The pickup address.
pickupLat (string): The latitude of the pickup location.
pickupLng (string): The longitude of the pickup location.
dropoffAddress (string): The dropoff address.
dropoffLat (string): The latitude of the dropoff location.
dropoffLng (string): The longitude of the dropoff location.
NumberOfPassenger (string): The number of passengers.
LuggageType (string): The type of luggage.
VehicleType (string): The type of vehicle.
JourneyType (string): The type of journey.
returnTrip (boolean): Indicates if it is a return trip.
returnDateTime (string): The date and time for the return trip (format: "YYYY-MM-DD HH:MM:SS").

Example Request for Booking Price

{
  "pickupDateTime": "2024-05-12 15:00:00",
  "pickupAddress": "Tower of London",
  "pickupLat": "51.5085985",
  "pickupLng": "-0.07633",
  "dropoffAddress": "London Bridge",
  "dropoffLat": "51.5059213",
  "dropoffLng": "-0.0874807",
  "NumberOfPassenger": "11",
  "LuggageType": "Hand luggage only.",
  "VehicleType": "9-13 Seat Premium Mini Bus",
  "JourneyType": "Business Travel",
  "returnTrip": true,
  "returnDateTime": "2024-05-13 07:00:00"
}

Example Response for Booking Price

{
  "vehiclePrice": 1530.66,
  "vehiclePriceTotal": 1684,
  "vat": "10.00",
  "status": 1,
  "message": "journey price found"
}

Summary

Log in using your credentials at /api/auth/login.
Receive a token if the login is successful.
Include the token and AccessKey in the header of subsequent requests to authenticate them.
Send a request to /api/booking/price with the required parameters to get the booking price.

Error Messages

Missing required field: Ensure that all required fields are included in your request.
Vehicle type is required: Please check our booking form for the available vehicle types and include the appropriate type in your request.
Luggage type is required: Please check our booking form for the available luggage types and include the appropriate type in your request.
Vehicle size not matching with your journey info: Ensure that the selected vehicle size is appropriate for the number of passengers and luggage specified in your request.