Introduction

              
Base Url
https://app.qatchcabs.com/api/

The Qatch API is developed using REST. Our API has pre-built resource-oriented URLs, encoded request forms, returns JSON-encoded responses, and uses appropriate HTTP response codes, authentication and verbs.

You can get started with Qatch API which will not affect your data or system. The API key you use to authenticate the request decides whether the request access is in live mode or taste mode.

The usage of Qatch API may vary as we keep updating our functionalities. Here you can see docs customized to your version of the API with your test key and data.

Authantication

The Qatch API uses Authorisation under Headers to authenticate requests from riders. You can view and manage your API keys in the Qatch Company Panel.

In order to prevent malware, don’t share your API with anyone else, especially on public websites such as GitHub, client-side code, and so on. With the HTTP basic Auth, your API will start to perform. All API requests must contain HTTPS for security, API requests without authentication will fail.

Authorization

The parameter needs to be in the format "Bearer <Auth_Key>". The Auth_Key will be provided by Qatch Admin.

Content-Type

The value of this parameter should be "application/json".

Search & Quote

              
EndPoints
POST /pricing/search
              
Success Response
{ "success": true, "type_list": [ { "total": 282.69, "distance": 124.47, "duration": 86.1, "distance_cost": 282.69, "time_cost": 0, "type_id": "5aa7cf25ee17fd185960d9fc", "service_type": "VAN", "pax": 0, "bags": 0, "description": "VAN", "type_image_url": "https://qatchcabs.s3.eu-central-1.amazonaws.com/service_type_images/5aa7cf25ee17fd185960d9fcqim3.png" }, { "total": 262.14, "distance": 124.47, "duration": 86.1, "distance_cost": 262.14, "time_cost": 0, "type_id": "596f2e1400805a220819cbe2", "service_type": "ELECTRIC", "pax": 0, "bags": 0, "description": "Electric", "type_image_url": "https://qatchcabs.s3.eu-central-1.amazonaws.com/service_type_images/596f2e1400805a220819cbe2dPmF.png" }, { "total": 260.64, "distance": 124.47, "duration": 86.1, "distance_cost": 260.64, "time_cost": 0, "type_id": "5aa7ced6ee17fd185960d9fa", "service_type": "GO", "pax": 0, "bags": 0, "description": "GO", "type_image_url": "https://qatchcabs.s3.eu-central-1.amazonaws.com/service_type_images/5aa7ced6ee17fd185960d9far9oT.png" }, { "total": 163.72, "distance": 124.47, "duration": 86.1, "distance_cost": 163.72, "time_cost": 0, "type_id": "5aa7cf08ee17fd185960d9fb", "service_type": "LUX", "pax": 0, "bags": 0, "description": "Business", "type_image_url": "https://qatchcabs.s3.eu-central-1.amazonaws.com/service_type_images/5aa7cf08ee17fd185960d9fbGNNY.png" } ], "quote_id": "603735c294a6bc3d1e68d1d1" }
              
Failure Response
{ "success": true, "error_code": 991, }

This API returns results with all the different types of vehicles available with its details along with the estimates of the ride.

pickup_latitudeinteger

This parameter requires the latitude from where the passenger needs to be a pickup.

pickup_longitudeinteger

This parameter requires the longitude from where the passenger needs to be a pickup.

destination_latitudeinteger

This parameter requires the latitude of the accurate location where the passenger needs to be a dropped off

destination_longitudeinteger

This parameter requires the longitude from where the passenger needs to be dropped off.

source_addressstring

This parameter requires the address in readable text format so that driver can reach to customer’s pickup point

destination_addressstring

This parameter requires the address in readable text format so that driver can reach to customer’s dropoff point

Create Trip

              
EndPoints
POST /trip/create
              
Success Response
{ "success": true, "trip_id": "6037418bab31e33eb7f495b7", "message": "42" }
              
Failure Response
{ "success": false, "error_code": "997" }

This API returns result with all the information required to enter such as the number of pax, car type, payment mode, with the credentials such as name, email id, and contact details.

typeidinteger

This parameter requires the car type required by the passenger and usually, it can be found from the response of Search API

quote_idinteger

This parameter requires the quotation and it can be found from the response of Search API

accessibilitystring

Accessibility parameters allow you to add special facilities that are required by the passenger in the form of an array. The param accepts you to offer three kinds of values.

schedule_start_timelong

This parameter accepts the difference between the booking time and scheduled pickup time calculated on the basis of milliseconds.

flightstring

This parameter describes customer flight details in case of arrival or departure. This API consists of three values.

payment_modeinteger

This parameter represents a payment made by customers from the listed options. This param consists of four values.

paxinteger

This parameter requires the total number of passengers

bagsinteger

This parameter requires the number of bags carried by passengers

notestring

This parameter requires if the driver asks for any additional requirement or note for the passenger

user

This is a JSON Object consists of basic details of the customer with four params as below

Cancel Trip

              
EndPoints
POST /trip/cancel_trip
              
Success Response
{ "success": true, }
              
Failure Response
{ "success": false, "error_code": "437" }

This API returns results with trip id along with all details required to cancel the trip.

trip_idinteger

This parameter requires the trip ID of the trip to cancel the trip. Trip ID can be obtained from the response of Create Trip API.

Update Trip

              
EndPoints
POST /trip/update_trip
              
Success Response
{ "success": true, }
              
Failure Response
{ "success": false, "error_code": "437" }

This API returns results with the trip id along with its detail.

trip_idinteger

This parameter requires the trip ID of the trip to update the trip. Trip ID can be obtained from the response of Create Trip API.

namestring

This parameter consist of the updated name of the customer

phonelong

This parameter consist of the updated phone of the customer

server_start_timelong

This parameter consist of the updated difference of the booking time & new time of pickup of the customer

accessibility string

Accessibility parameters allow you to add special facilities that are required by the passenger in the form of an array. The param accepts you to offer three kinds of values.