Multiple rider sign in/out vendor integration booking document

Created by Moveinsync Help, Modified on Tue, 13 Oct at 5:32 AM by Moveinsync Help

Multiple rider sign in/out vendor integration booking document


Booking Lifecycle & Operational APIs

This document defines the complete set of APIs required for integration between the vendor platform and the MoveInSync Rentlz platform. It covers the complete booking lifecycle flow  from booking creation to trip completion and invoicing.

End-to-End Booking Lifecycle Flow

The following sequence defines the recommended order in which APIs should be triggered during the lifecycle of a booking.

Step

API Name

Description

1

Booking Creation

Booking details are sent to the vendor once a vendor is assigned.

2

Booking Edit

Any booking modification is communicated to the vendor.

3

Booking Cancellation

Vendor is informed when a booking is cancelled.

4

Vendor Acceptance

Vendor accepts or rejects the booking request.

5

OTP Submission

Vendor shares trip sign-in and sign-out OTPs.

6

Cab Driver Allocation

Vendor shares assigned cab and driver details.

7

Duty/Trip Events

Vendor shares start/end duty and trip events.

8

Tracking

Real-time GPS tracking data is shared throughout the trip.

9

Raw Invoice Data

Vendor shares final trip and billing data after trip completion.





Note: Select the appropriate base URL (.com or .in) based on the customer's site URL.

Scenario 1: If the customer site URL is https://abcd.moveinsync.com/IND/login, use the following base URL: https://api.moveinsync.com

Scenario 2: If the customer site URL is https://efgh.moveinsync.in/IND/login, use the following base URL: https://api.moveinsync.in

? Base URL

1)  https://api.moveinsync.com

2)  https://api.moveinsync.in


? Authentication

All APIs require Bearer Token authentication.

Header:

Authorization: Bearer <access_token>

Content-Type: application/json


 1. POST OTP API

Endpoint

https://api.moveinsync.com/integration/{client-id}/rentlz/booking/v2/otp
or
https://api.moveinsync.in/integration/{client-id}/rentlz/booking/v2/otp


Description

This API is used to submit OTPs associated with a booking to verify check-in (Sign-In) and check-out (Sign-Out) events.

  • Both signInOtp and signOutOtp must be provided.

  • If the same OTP is used for both events, pass the same value in both fields.

  • OTP must be sent separately for each rider.


Field Details

Field

Description

bookingId

Unique identifier for the booking in the MoveInSync system

signInOtp

OTP used to verify the start of the trip

signOutOtp

OTP used to verify the end of the trip

uniqueRiderEmail

Unique identifier for each rider (OTP must be sent per rider)

client

Unique identifier of the customer (e.g., gs2-UAT, pwcindia-PWCINDIA)


Request Body

[

  {

    "bookingId": "BLR-XXXX-XXXX-XOBB",

    "signInOtp": "1234",

    "signOutOtp": "6789",

    "uniqueRiderEmail": "rider1@gmail.com",

    "client": "pwcindia-PWCINDIA"

  },

  {

    "bookingId": "BLR-XXXX-XXXX-XO1BB",

    "signInOtp": "1234",

    "signOutOtp": "5678",

    "uniqueRiderEmail": "rider2@gmail.com",

    "client": "gs2-UAT"

  }

]


Sample Curl

POST
 'https://api.moveinsync.com/integration/{client-id}/rentlz/booking/v2/otp '
or
 'https://api.moveinsync.in/integration/{client-id}/rentlz/booking/v2/otp '


--header 'Authorization: Bearer <Your token>'

--header 'Content-Type: application/json'


--body '[

  {

    "bookingId": "BLR-XXXX-XXXX-XOBB",

    "signInOtp": "1234",

    "signOutOtp": "6789",

    "uniqueRiderEmail": "rider1@gmail.com",

    "client": "gs2-UAT"

  }

]'



Notes

  • Same OTP can be reused for both fields if applicable.

  • Each rider must have a separate entry.


? 2. POST Duty-Trip Details API

Endpoint

https://api.moveinsync.com/integration/{client-id}/rentlz/booking/start-end
or
https://api.moveinsync.in/integration/{client-id}/rentlz/booking/start-end


Description

This API is used to log driver-related events such as duty start/end and trip start/end for a given booking.

Each event includes:

  • Location coordinates

  • Timestamp

  • Event type


Field Details

Field

Description

bookingId

Unique identifier for the booking

lat

Latitude where the event was recorded

lang

Longitude where the event was recorded

time

Timestamp in epoch milliseconds

eventName

Event type (see below)


Allowed eventName Values

  • startDuty

  • startTrip

  • endTrip

  • endDuty


Request Body (Sample)

{

  "bookingId": "BLR-XXXX-XXXX-XOBB",

  "lat": "22.6211559",

  "lang": "88.4324648",

  "time": 1713703420000,

  "eventName": "startTrip"

}



Notes

  • eventName must match one of the allowed values.

  • time must be in epoch milliseconds format.


3. POST Attendance API

Endpoint

https://api.moveinsync.com/integration/{client-id}/rentlz/booking/attendance
or
https://api.moveinsync.in/integration/{client-id}/rentlz/booking/attendance


Description

This API is used to log employee events such as:

  • SIGNIN

  • SIGNOUT

  • NOSHOW

Each request includes booking details, rider details, location, and timestamp.


Field Details

Field

Description

bookingId

Unique identifier for the booking

lat

Latitude

lang

Longitude

time

Timestamp in epoch milliseconds

eventName

Event type

uniqueRiderEmail

Rider identifier

client

Client identifier


Allowed eventName Values

  • SIGNIN

  • SIGNOUT

  • NOSHOW


Request Body (Sample)

{

  "bookingId": "BLR-XXXX-XXXX-XOBB",

  "lat": "22.6211559",

  "lang": "88.4324648",

  "time": 1774806186000,

  "eventName": "SIGNIN",

  "uniqueRiderEmail": "rider1@gmail.com",

  "client": "gs2-UAT"

}


Sample Curl

POST 'https://api.moveinsync.com/integration/{client-id}/rentlz/booking/attendance'
or
'https://api.moveinsync.in/integration/{client-id}/rentlz/booking/attendance'


--header 'Authorization: Bearer <your token>'

--header 'Content-Type: application/json'


--body '{

  "bookingId": "BLR-XXXX-XXXX-XO1B",

  "lat": "22.6211559",

  "lang": "88.4324648",

  "time": 1774806186000,

  "eventName": "SIGNIN",

  "uniqueRiderEmail": "rider1@gmail.com",

  "client": "gs2-UAT"

}'





? End-to-End API Chronology (Booking Lifecycle Flow)

This section defines the sequence in which APIs should be called during the lifecycle of a booking, from vendor acceptance to trip completion.


? Step 1: Vendor Acceptance

API

POST 
https://api.moveinsync.com/integration/{client-id}/rentlz/booking/status
or
https://api.moveinsync.in/integration/{client-id}/rentlz/booking/status

Description
This API is used by the vendor to accept the booking.


? Step 2: Cab & Driver Allocation

API

POST 
https://api.moveinsync.com/integration/{Client-id}/rentlz/booking/assign/cab-driver
or
https://api.moveinsync.in/integration/{Client-id}/rentlz/booking/assign/cab-driver

Description
This API is used to assign the cab and driver details to the booking.


? Step 3: OTP Submission (Trip Verification Setup)

API

POST 
https://api.moveinsync.com/integration/{client-id}/rentlz/booking/v2/otp 
or
https://api.moveinsync.in/integration/{client-id}/rentlz/booking/v2/otp 

Description
This API is used to submit OTPs for trip start (Sign-In) and trip end (Sign-Out) verification.


? Step 4: Duty Start & Trip Start

API

POST https://api.moveinsync.com/integration/{client-id}/rentlz/booking/start-end
or
https://api.moveinsync.in/integration/{client-id}/rentlz/booking/start-end

Event Sequence

startDuty

startTrip

Description
This API is used to mark:

  • Driver duty start

  • Trip start


? Step 5: Attendance Events (During Trip)

API

POST https://api.moveinsync.com/integration/{client-id}/rentlz/booking/attendance
or
https://api.moveinsync.in/integration/{client-id}/rentlz/booking/attendance

Event Types

SIGNIN

SIGNOUT

NOSHOW

Description
This API captures employee attendance events during the trip lifecycle.


? Step 6: Trip End & Duty End

API

POST https://api.moveinsync.com/integration/{client-id}/rentlz/booking/start-end
or
https://api.moveinsync.com/integration/{client-id}/rentlz/booking/start-end

Event Sequence

endTrip

endDuty

Description
This API is used to mark:

  • Trip completion

  • Driver duty end


Flow Summary (Quick View)

1. Vendor Acceptance

2. Cab & Driver Allocation

3. OTP Submission

4. startDuty → startTrip

5. SIGNIN / SIGNOUT / NOSHOW

6. endTrip → endDuty




Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article