About Hoppa APIs

Hoppa provides a set of APIs designed to integrate with partner systems for ride booking, management, and related services.

API Endpoint Allocation

API endpoints are provided per partner and per API, allowing Hoppa to manage computational resources based on each partner’s volume and specific implementation requirements.

Sandbox Environment

A sandbox environment is provisioned for each partner to support development and testing before production deployment. Sandbox endpoints will be shared during the development phase.

Available APIs

The following RESTful APIs are available to support ride booking and management:

• OAuth API

API allows users to retrieve a bearer token which can be used as a mode of authentication for the subsequent APIs.

• Ride Quote API API allows users to retrieve pricing information for potential rides. By utilizing this feature, users can quickly obtain quotes for partner rides, facilitating cost estimation and informed decision-making in transportation planning.
• Reservation API

The Reservation API is applicable only for train as the vehicle class. Reserves a train ticket for the given quote_id . Returns the total price of the ride with breakup.

• Ride Order Creation API API allows users to schedule transportation services for one-way, round-trips and hourly rides by providing essential details such as pickup and drop-off locations, passenger information, and vehicle class. API Creates a booking.
• Ride Order update API The Ride Update API allows updating all details of an existing ride booking, including, Pickup and drop-off locations, date and time, vehicle type, flight information etc
• Ride Cancellation API Allows cancellation of a scheduled ride.
• Ride Order Status API Retrieves the current status of an existing booking.
• Update Passenger API Updates passenger information, including contact details and luggage specifications.
• Trip Status Allows adding of special instructions to the Ride order.
• Ride Detail Allows to retrieve all the details of the ride