API FOR DEVELOPERS

Alternate Text

YDriv Limited is now providing its partners a distinctive solution to ease up all the CabOffice Operators. It is designed to facilitate our Partner cab operators to get and complete jobs easily and successfully. These API's give partners full coverage to display all the unconfirmed, confirmed, completed and cancelled bookings in your own Dispatch Software. This API also gives the power to accept and complete a job from your own software without having the need to login into the YDriv Limited Portal.

Get_Bookings

Display all the bookings from your YDriv Limited Partner Portal on your own distinct solution without any hassle.

Get_Bookings is a GET request API which we request data in HTTP protocol and gets the response in JSON format which will make it very easy and simiplied to use the obtained data without the hassle to login into YDriv Limited Partner Portal.

Name Type Description
BookingID String Booking ID for the Job.
RecordID String Record ID is used to process booking on the POST API requests.
Date & Time String Date and Time of the booking.
Account String Cash or Card.
Partner Fare Double Your Share for the Job.
Customer Fare Double Actual fare for the Job.
Extra Items String Extra Items the passenger is carrying.
Comment String Comments / Extra information for the Booking.
Driver Name String Driver Name will be shown if a driver has been allocated for that specific job.
Customer Details String Customer Name, Email and telephone number will only be shown after a job has been marked as confirmed.
Booking State String Booking State to Differentiate between Unconfirmed,Confirmed,JobDone or Cancelled Bookings.
Journey Data Array Journey Data contains an Array of objects which contain data about the journey like Address, Doorno, Postcode, Latitude & Longitude.
The First object of JourneyData will be the Customer origin and the Last object will always be the Destination where customer wants to reach. The objects in middle will be the Vias.
GET

Request

Get_Bookings just need your Unique APIKEY Generated from your YDriv Partner Portal to get authorized and brings you the tailored response according to your account.


 https://ydriv.com/api/API/Get_Bookings?key=YOURUNIQUEAPIKEY
                                 

Response

{
    "Bookings": [
        {
            "BookingID": "TNWxxxxxx",
            "RecordID": "xxx123456xxx79872",
            "Date": "27-06-21",
            "Time": "01:30",
            "Account": "CASH",
            "PartnerFare": 26,
            "CustomerFare": 27,
            "ExtraItems": "1x Cabin",
            "Comment": "Make Sure the Cab is sanitized",
            "VehicleName": "Saloon",
            "DriverName": "",
            "CustomerName": "",
            "CustomerEmail": "",
            "CustomerNumber": "",
            "BookingState": "unconfirmed",
            "JourneyData": [
                {
                    "address": "KT9 HOOK ROAD",
                    "doorno": "",
                    "postcode": "KT9 1AH",
                    "latitude": "51.36933",
                    "longitude": "-0.30624"
                },
                {
                    "address": "BRACKEN CLOSE",
                    "doorno": "",
                    "postcode": "TW2 7EW",
                    "latitude": "51.45197",
                    "longitude": "-0.37244"
                }
            ]
        },
        {20 items},
        {20 items},
        {20 items}
    ],
    "Status": "Success"
}
}

ConfirmNewBooking

Confirm a single booking whose record ID would be provided in the object of the POST request.

ConfirmNewBooking is a POST request API we send an object containing APIKey and Record Id for the Uncomfirmed Job which is needed to be confirmed. API gives the success or failure response in JSON format.

Name Type Description
Message String Success or Failure Message / Reason.
Status String Success or Fail.
POST

Request

ConfirmNewBooking POST request requires an object containing your Uniquely Generated API key and Record Id for the Job.

https://ydriv.com/api/API/ConfirmNewBooking
Body
{
    "key": "YOURUNIQUEAPIKEY",
    "id": "JOB RECORD ID"    }

Response

{ 
"Message": "Response",
"Status": "Success / Fail"    }

CompleteBooking

Complete a single confirmed booking whose record ID would be provided in the object of the POST request.

CompleteBooking is a POST request API you will send an object containing APIKey and Record Id for the Confirmed and Allocated Job in order to complete the Job. API gives the success or failure response in JSON format.

Name Type Description
Message String Success or Failure Message / Reason.
Status String Success or Fail.
POST

Request

CompleteBooking POST request requires an object containing your Uniquely Generated API key and Record Id for the Job.

https://ydriv.com/api/API/CompleteBooking
Body
{
    "key": "YOURUNIQUEAPIKEY",
    "id": "JOB RECORD ID"    }

Response

{ 
"Message": "Response",
"Status": "Success / Fail"    }
API Version: 1.32. Last Updated: 26-11-2021.