Referencia de la API

Cada operación, generada desde el registro de operaciones de la propia plataforma.

Versión de la API v1 · Ver como Markdown

Esta página se genera desde el mismo registro contra el que autoriza la puerta de enlace. El alcance, derecho, idempotencia y soporte de sandbox de abajo no son una descripción de la implementación: son los propios metadatos de la implementación.

Cuenta

`GET` `/v1/me/membership`

Próximamente Compatible con sandbox

Si este cliente tiene una membresía Ryde One activa. Consúltalo antes de ofrecer transaccionar, para que el agente explique el requisito en vez de chocar con un 403 a media frase.

Operación	`get_membership_status`
Alcance	`profile.read`
Derecho	Ninguno
Idempotencia	No requerida
Herramienta MCP	`get_membership_status`

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/me/membership' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

Comida

`GET` `/v1/food/merchants`

Próximamente Compatible con sandbox

Encuentra restaurantes, supermercados y tiendas abiertos cerca de un punto.

Operación	`search_restaurants`
Alcance	`food.read`
Derecho	Ninguno
Idempotencia	No requerida
Herramienta MCP	`search_restaurants`

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/food/merchants' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

`GET` `/v1/food/merchants/{merchant_id}/menu`

Próximamente Compatible con sandbox

El catálogo público de un comercio. El costo, el inventario, los códigos de barras y los identificadores de proveedor son asunto del comercio y nunca se devuelven aquí.

Operación	`get_restaurant_menu`
Alcance	`food.read`
Derecho	Ninguno
Idempotencia	No requerida
Herramienta MCP	`get_restaurant_menu`

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/food/merchants/$merchant_id/menu' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

`POST` `/v1/food/orders/quote`

Próximamente Compatible con sandbox

Cotiza una canasta exactamente como lo haría el checkout: artículos, cargos, impuestos, cualquier descuento de miembro y el total. Devuelve el quote_id que requiere place_food_order.

Operación	`quote_food_order`
Alcance	`food.read`
Derecho	Ninguno
Idempotencia	No requerida
Herramienta MCP	`quote_food_order`

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/food/orders/quote' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

`POST` `/v1/food/orders`

Próximamente Requiere Ryde One Compatible con sandbox

Realiza el pedido que el cliente confirmó, a partir de un quote_id que se le mostró.

Operación	`place_food_order`
Alcance	`food.order`
Derecho	Requiere Ryde One
Idempotencia	Obligatoria
Herramienta MCP	`place_food_order`

Requiere una cotización reciente mostrada al cliente, más una Idempotency-Key.

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/food/orders' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

`GET` `/v1/food/orders/{order_id}`

Próximamente Compatible con sandbox

Estado en vivo de un pedido, incluido el avance del mensajero. Deliberadamente SIN restricción de membresía: un pedido que existe sigue siendo rastreable.

Operación	`get_food_order`
Alcance	`food.read`
Derecho	Ninguno
Idempotencia	No requerida
Herramienta MCP	`get_food_order`

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/food/orders/$order_id' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

`GET` `/v1/food/orders`

Próximamente Compatible con sandbox

El historial de pedidos del propio cliente, del más reciente al más antiguo.

Operación	`list_food_orders`
Alcance	`food.read`
Derecho	Ninguno
Idempotencia	No requerida
Herramienta MCP	`list_food_orders`

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/food/orders' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

`POST` `/v1/food/orders/{order_id}/cancel`

Próximamente Compatible con sandbox

Cancela un pedido, cuando su estado actual aún lo permite. Nunca restringido por membresía: SALIR de una transacción no debe requerir un derecho.

Operación	`cancel_food_order`
Alcance	`food.read`
Derecho	Ninguno
Idempotencia	Compatible
Herramienta MCP	`cancel_food_order`

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/food/orders/$order_id/cancel' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

Viajes

`GET` `/v1/rides/products`

Próximamente Compatible con sandbox

Las categorías de vehículo que se pueden solicitar, con la tarifa base de cada una.

Operación	`search_ride_options`
Alcance	`rides.read`
Derecho	Ninguno
Idempotencia	No requerida
Herramienta MCP	`search_ride_options`

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/rides/products' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

`POST` `/v1/rides/quote`

Próximamente Compatible con sandbox

Distancia por carretera, tiempo de conducción y la tarifa final por categoría de vehículo, impuestos incluidos. Devuelve el quote_id que requiere request_ride.

Operación	`quote_ride`
Alcance	`rides.read`
Derecho	Ninguno
Idempotencia	No requerida
Herramienta MCP	`quote_ride`

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/rides/quote' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

`POST` `/v1/rides`

Próximamente Requiere Ryde One Compatible con sandbox

Solicita el viaje que el cliente confirmó, a partir de un quote_id que se le mostró.

Operación	`request_ride`
Alcance	`rides.request`
Derecho	Requiere Ryde One
Idempotencia	Obligatoria
Herramienta MCP	`request_ride`

Requiere una cotización reciente mostrada al cliente, más una Idempotency-Key.

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/rides' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

`GET` `/v1/rides/{ride_id}`

Próximamente Compatible con sandbox

Estado en vivo de un viaje: avance del despacho, el conductor y vehículo asignados, y el tiempo estimado de llegada. Nunca restringido por membresía: un viaje en curso sigue siendo rastreable.

Operación	`get_ride`
Alcance	`rides.read`
Derecho	Ninguno
Idempotencia	No requerida
Herramienta MCP	`get_ride`

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/rides/$ride_id' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

`GET` `/v1/rides`

Próximamente Compatible con sandbox

El historial de viajes del propio cliente, del más reciente al más antiguo.

Operación	`list_rides`
Alcance	`rides.read`
Derecho	Ninguno
Idempotencia	No requerida
Herramienta MCP	`list_rides`

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/rides' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

`POST` `/v1/rides/{ride_id}/cancel`

Próximamente Compatible con sandbox

Cancela un viaje que no ha comenzado. Nunca restringido por membresía, por la misma razón que cancelar un pedido.

Operación	`cancel_ride`
Alcance	`rides.read`
Derecho	Ninguno
Idempotencia	Compatible
Herramienta MCP	`cancel_ride`

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/rides/$ride_id/cancel' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

Entregas

`POST` `/v1/deliveries/quote`

Próximamente Compatible con sandbox

Cotiza un envío de mensajería entre dos puntos. Usa la misma ruta de precios que la solicitud, así que la cotización es el cobro.

Operación	`quote_delivery`
Alcance	`delivery.read`
Derecho	Ninguno
Idempotencia	No requerida
Herramienta MCP	`quote_delivery`

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/deliveries/quote' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

`POST` `/v1/deliveries`

Próximamente Requiere Ryde One Compatible con sandbox

Despacha un mensajero para mover un paquete, a partir de un quote_id que se mostró al cliente.

Operación	`request_delivery`
Alcance	`delivery.request`
Derecho	Requiere Ryde One
Idempotencia	Obligatoria
Herramienta MCP	`request_delivery`

Requiere una cotización reciente mostrada al cliente, más una Idempotency-Key.

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/deliveries' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

`GET` `/v1/deliveries/{delivery_id}`

Próximamente Compatible con sandbox

Estado en vivo de una entrega, incluido el avance del mensajero y la prueba de entrega una vez recogida.

Operación	`get_delivery`
Alcance	`delivery.read`
Derecho	Ninguno
Idempotencia	No requerida
Herramienta MCP	`get_delivery`

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/deliveries/$delivery_id' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

Servicios

`GET` `/v1/services/providers`

Próximamente Compatible con sandbox

Encuentra proveedores que se desplazan al cliente, con su disponibilidad en vivo. La disponibilidad se deriva por solicitud y el cliente nunca debe guardarla en caché.

Operación	`search_service_providers`
Alcance	`services.read`
Derecho	Ninguno
Idempotencia	No requerida
Herramienta MCP	`search_service_providers`

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/services/providers' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

`GET` `/v1/services/providers/{provider_id}/slots`

Próximamente Compatible con sandbox

Franjas de cita libres en una fecha, para un trabajo de cierta duración. A un trabajo largo solo se le ofrece un inicio cuyas franjas consecutivas estén todas libres.

Operación	`get_provider_availability`
Alcance	`services.read`
Derecho	Ninguno
Idempotencia	No requerida
Herramienta MCP	`get_provider_availability`

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/services/providers/$provider_id/slots' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

`POST` `/v1/services/bookings/quote`

Próximamente Compatible con sandbox

Cotiza una reserva de servicio antes de comprometer una franja.

Operación	`quote_service`
Alcance	`services.read`
Derecho	Ninguno
Idempotencia	No requerida
Herramienta MCP	`quote_service`

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/services/bookings/quote' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

`POST` `/v1/services/bookings`

Próximamente Requiere Ryde One Compatible con sandbox

Reserva un proveedor, opcionalmente en una franja concreta. La competencia por una franja la resuelve la plataforma: una reserva perdedora se rechaza, nunca se duplica.

Operación	`book_service`
Alcance	`services.book`
Derecho	Requiere Ryde One
Idempotencia	Obligatoria
Herramienta MCP	`book_service`

Requiere una cotización reciente mostrada al cliente, más una Idempotency-Key.

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/services/bookings' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

`GET` `/v1/services/bookings/{booking_id}`

Próximamente Compatible con sandbox

Estado en vivo de una reserva, desde la llegada hasta el inicio y la finalización.

Operación	`get_service_booking`
Alcance	`services.read`
Derecho	Ninguno
Idempotencia	No requerida
Herramienta MCP	`get_service_booking`

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/services/bookings/$booking_id' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

Tareas

`GET` `/v1/tasks/types`

Próximamente Compatible con sandbox

Los tipos de tarea que este mercado puede ejecutar realmente, con la evidencia que recoge cada uno. Solo se listan los tipos que Ryde puede cubrir con personal.

Operación	`list_task_types`
Alcance	`tasks.read`
Derecho	Ninguno
Idempotencia	No requerida
Herramienta MCP	`list_task_types`

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/tasks/types' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

`POST` `/v1/tasks/quote`

Próximamente Compatible con sandbox

Cotiza una tarea y confirma que podría encontrarse un proveedor calificado antes de comprometerse.

Operación	`quote_task`
Alcance	`tasks.read`
Derecho	Ninguno
Idempotencia	No requerida
Herramienta MCP	`quote_task`

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/tasks/quote' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

`POST` `/v1/tasks`

Próximamente Requiere Ryde One Compatible con sandbox

Despacha trabajo del mundo real con requisitos estructurados y reglas de evidencia.

Operación	`create_task`
Alcance	`tasks.create`
Derecho	Requiere Ryde One
Idempotencia	Obligatoria
Herramienta MCP	`create_task`

Requiere una cotización reciente mostrada al cliente, más una Idempotency-Key.

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/tasks' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

`GET` `/v1/tasks/{task_id}`

Próximamente Compatible con sandbox

Estado de la tarea, el proveedor asignado y la evidencia recogida hasta el momento.

Operación	`get_task`
Alcance	`tasks.read`
Derecho	Ninguno
Idempotencia	No requerida
Herramienta MCP	`get_task`

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/tasks/$task_id' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

`GET` `/v1/tasks/{task_id}/evidence`

Próximamente Compatible con sandbox

La evidencia recogida para una tarea: fotos con sus hashes de contenido, GPS de captura, marcas de tiempo del dispositivo y las respuestas de cualquier lista de verificación.

Operación	`get_task_evidence`
Alcance	`tasks.read`
Derecho	Ninguno
Idempotencia	No requerida
Herramienta MCP	`get_task_evidence`

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/tasks/$task_id/evidence' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

`POST` `/v1/tasks/{task_id}/cancel`

Próximamente Compatible con sandbox

Cancela una tarea que no ha comenzado.

Operación	`cancel_task`
Alcance	`tasks.read`
Derecho	Ninguno
Idempotencia	Compatible
Herramienta MCP	`cancel_task`

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/tasks/$task_id/cancel' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

Referencia de la API

Cuenta

GET /v1/me/membership

Comida

GET /v1/food/merchants

GET /v1/food/merchants/{merchant_id}/menu

POST /v1/food/orders/quote

POST /v1/food/orders

GET /v1/food/orders/{order_id}

GET /v1/food/orders

POST /v1/food/orders/{order_id}/cancel

Viajes

GET /v1/rides/products

POST /v1/rides/quote

POST /v1/rides

GET /v1/rides/{ride_id}

GET /v1/rides

POST /v1/rides/{ride_id}/cancel

Entregas

POST /v1/deliveries/quote

POST /v1/deliveries

GET /v1/deliveries/{delivery_id}

Servicios

GET /v1/services/providers

GET /v1/services/providers/{provider_id}/slots

POST /v1/services/bookings/quote

POST /v1/services/bookings

GET /v1/services/bookings/{booking_id}

Tareas

GET /v1/tasks/types

POST /v1/tasks/quote

POST /v1/tasks

GET /v1/tasks/{task_id}

GET /v1/tasks/{task_id}/evidence

POST /v1/tasks/{task_id}/cancel

`GET` `/v1/me/membership`

`GET` `/v1/food/merchants`

`GET` `/v1/food/merchants/{merchant_id}/menu`

`POST` `/v1/food/orders/quote`

`POST` `/v1/food/orders`

`GET` `/v1/food/orders/{order_id}`

`GET` `/v1/food/orders`

`POST` `/v1/food/orders/{order_id}/cancel`

`GET` `/v1/rides/products`

`POST` `/v1/rides/quote`

`POST` `/v1/rides`

`GET` `/v1/rides/{ride_id}`

`GET` `/v1/rides`

`POST` `/v1/rides/{ride_id}/cancel`

`POST` `/v1/deliveries/quote`

`POST` `/v1/deliveries`

`GET` `/v1/deliveries/{delivery_id}`

`GET` `/v1/services/providers`

`GET` `/v1/services/providers/{provider_id}/slots`

`POST` `/v1/services/bookings/quote`

`POST` `/v1/services/bookings`

`GET` `/v1/services/bookings/{booking_id}`

`GET` `/v1/tasks/types`

`POST` `/v1/tasks/quote`

`POST` `/v1/tasks`

`GET` `/v1/tasks/{task_id}`

`GET` `/v1/tasks/{task_id}/evidence`

`POST` `/v1/tasks/{task_id}/cancel`