# Welcome

> Fery Rides APIs for Delhi Metro (DMRC / Momentum) ride booking

# Fery × DMRC Integration

This documentation describes the APIs provided by **Fery Rides** for ride booking integration with DMRC / Momentum.

Supported service types: `scooty` and `cab`.

## APIs you call

| Method | Endpoint              | Description                  |
| ------ | --------------------- | ---------------------------- |
| `GET`  | `/health`             | Service and API status check |
| `POST` | `/ride/fare-estimate` | Get fare quotes and ETA      |
| `POST` | `/ride/create-order`  | Create a ride order          |
| `POST` | `/ride/cancel`        | Cancel an active ride        |
| `POST` | `/ride/feedback`      | Submit post-ride feedback    |

Detailed request and response schemas are in the **API Reference**.

## Webhooks Fery sends

On create order, send your `webhookURL`. Fery saves it on the ride and uses **the same URL** for:

| Case             | `status`                                                                                                  | Description              |
| ---------------- | --------------------------------------------------------------------------------------------------------- | ------------------------ |
| Status updates   | `accepted`, `arrived`, `started`, `dropped`, `customer_cancelled`, `rydr_cancelled`, `expired`, `aborted` | Ride lifecycle events    |
| Location updates | `location_updated`                                                                                        | Partner location updates |

See [Webhooks](./webhooks).

## Integration responsibilities

| DMRC                                         | Fery                                                        |
| -------------------------------------------- | ----------------------------------------------------------- |
| Call fare, create, cancel, and feedback APIs | Fulfil the ride and notify via webhooks                     |
| Host a webhook endpoint                      | Send status and location events to your `webhookURL`        |
| Send rider details on create order           | Create or update the rider from that payload                |
| Display OTP and trip updates in your app     | Provide OTP, fare, and captain details via API and webhooks |

## Getting started

1. [Authentication](./authentication)
2. [Endpoints](./endpoints)
3. [Integration flow](./integration-flow)
4. [Webhooks](./webhooks)
5. [Errors & codes](./errors)
6. **API Reference**

## Environment

| Environment | Base URL                           |
| ----------- | ---------------------------------- |
| UAT         | `https://uat.feryrides.co.in/dmrc` |

Production base URL, API key, and webhook `secretkey` are shared by Fery separately.

> Fery Rides APIs for Delhi Metro (DMRC / Momentum) ride booking

## Instructions for AI Agents

- For clean Markdown of any page, append `.md` to the page URL
- For section-specific indexes, append `/llms.txt` to any section URL
- For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.feryrides.co.in/_mcp/server

## Docs

- [Welcome](https://docs.feryrides.co.in/welcome.md): Fery Rides APIs for Delhi Metro (DMRC / Momentum) ride booking
- [Authentication](https://docs.feryrides.co.in/guides/authentication.md): Authenticate requests to Fery APIs
- [Endpoints](https://docs.feryrides.co.in/guides/endpoints.md): DMRC-facing Fery API endpoints
- [Integration flow](https://docs.feryrides.co.in/guides/integration-flow.md): End-to-end booking flow between DMRC and Fery
- [Webhooks](https://docs.feryrides.co.in/guides/webhooks.md): Status and location events Fery sends to your webhookURL
- [Errors & codes](https://docs.feryrides.co.in/guides/errors-codes.md): HTTP statuses and response codes returned by Fery

## API Docs

- API Reference > Health [Health and API status check](https://docs.feryrides.co.in/api-reference/health/check.md)
- API Reference > Fare [Get fare estimate](https://docs.feryrides.co.in/api-reference/fare/estimate.md)
- API Reference > Orders [Create ride order](https://docs.feryrides.co.in/api-reference/orders/create-order.md)
- API Reference > Orders [Cancel ride order](https://docs.feryrides.co.in/api-reference/orders/cancel-order.md)
- API Reference > Feedback [Submit ride feedback](https://docs.feryrides.co.in/api-reference/feedback/submit-feedback.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://docs.feryrides.co.in/openapi.json)
- [OpenAPI YAML](https://docs.feryrides.co.in/openapi.yaml)