# RideShare

## Docs

- [Login](https://rideshare.docs.sumit-dhondikar.in/api-reference/auth/login.md): Authenticate with email and password to receive a JWT access token and refresh token.
- [Logout](https://rideshare.docs.sumit-dhondikar.in/api-reference/auth/logout.md): Revoke the current refresh token to end the user's session server-side.
- [Refresh Token](https://rideshare.docs.sumit-dhondikar.in/api-reference/auth/refresh.md): Exchange a valid refresh token for a new access token and a rotated refresh token.
- [Request OTP](https://rideshare.docs.sumit-dhondikar.in/api-reference/auth/request-otp.md): Send a one-time password to an email address before completing signup.
- [Sign Up](https://rideshare.docs.sumit-dhondikar.in/api-reference/auth/signup.md): Create a new account using your email, password, and a verified OTP.
- [Notification History](https://rideshare.docs.sumit-dhondikar.in/api-reference/notifications/history.md): Retrieve all in-app notifications for the authenticated user.
- [Mark Read](https://rideshare.docs.sumit-dhondikar.in/api-reference/notifications/mark-read.md): Mark one or all notifications as read for the authenticated user.
- [Create Order](https://rideshare.docs.sumit-dhondikar.in/api-reference/payments/create-order.md): Create a Razorpay payment order for a ride.
- [Session Status](https://rideshare.docs.sumit-dhondikar.in/api-reference/payments/session.md): Retrieve the status of a payment session by session ID.
- [Verify Payment](https://rideshare.docs.sumit-dhondikar.in/api-reference/payments/verify.md): Verify a Razorpay payment signature after checkout completes.
- [Book Ride](https://rideshare.docs.sumit-dhondikar.in/api-reference/rides/book.md): Create a new ride request for the authenticated rider.
- [Cancel Ride](https://rideshare.docs.sumit-dhondikar.in/api-reference/rides/cancel.md): Cancel an active ride and receive the updated ride record.
- [Estimate Fare](https://rideshare.docs.sumit-dhondikar.in/api-reference/rides/estimate.md): Calculate a fare estimate before booking a ride.
- [Submit Feedback](https://rideshare.docs.sumit-dhondikar.in/api-reference/rides/feedback.md): Rate a completed ride and leave a comment.
- [Ride History](https://rideshare.docs.sumit-dhondikar.in/api-reference/rides/history.md): Retrieve all rides associated with the authenticated user.
- [Predictive Insights](https://rideshare.docs.sumit-dhondikar.in/api-reference/rides/insights.md): Get demand forecast, ETA guidance, surge recommendations, and driver supply analysis.
- [Nearby Drivers](https://rideshare.docs.sumit-dhondikar.in/api-reference/rides/nearby-drivers.md): Find available drivers within a given radius of a location.
- [Ride Status](https://rideshare.docs.sumit-dhondikar.in/api-reference/rides/status.md): Retrieve or update the status of a ride.
- [Get Settings](https://rideshare.docs.sumit-dhondikar.in/api-reference/user-settings/get.md): Retrieve the current settings for the authenticated user.
- [Update Settings](https://rideshare.docs.sumit-dhondikar.in/api-reference/user-settings/update.md): Update one or more settings for the authenticated user.
- [Authentication](https://rideshare.docs.sumit-dhondikar.in/authentication.md): Sign up with OTP verification, log in to receive JWT tokens, and authorize requests using Bearer authentication.
- [Payments](https://rideshare.docs.sumit-dhondikar.in/concepts/payments.md): Learn how to create a payment order, process it with the Razorpay SDK, and verify the result using the RideShare payments API.
- [Ride Lifecycle](https://rideshare.docs.sumit-dhondikar.in/concepts/ride-lifecycle.md): Follow a ride from the initial request through to completion, and learn which endpoints drive each status transition.
- [Roles](https://rideshare.docs.sumit-dhondikar.in/concepts/roles.md): Understand the four user roles in the RideShare API and what each role can do.
- [Book a Ride](https://rideshare.docs.sumit-dhondikar.in/guides/booking-a-ride.md): Request a ride, track its progress, and submit feedback using the RideShare API.
- [Driver Workflow](https://rideshare.docs.sumit-dhondikar.in/guides/driver-workflow.md): Accept rides, verify OTPs, share your live location, and complete trips using the RideShare API.
- [Notifications](https://rideshare.docs.sumit-dhondikar.in/guides/notifications.md): Fetch, read, and manage in-app notifications for ride events using the RideShare API.
- [User Settings](https://rideshare.docs.sumit-dhondikar.in/guides/user-settings.md): Retrieve and update your account preferences, privacy options, and ride defaults using the RideShare API.
- [Introduction](https://rideshare.docs.sumit-dhondikar.in/introduction.md): The RideShare API lets you authenticate users, book rides, estimate fares, process payments, and track drivers through a REST interface.
- [Quick start](https://rideshare.docs.sumit-dhondikar.in/quickstart.md): Sign up, log in, and make your first authenticated request to the RideShare API.

## OpenAPI Specs

- [openapi](https://rideshare.docs.sumit-dhondikar.in/api-reference/openapi.json)