Chauffeur partner REST API and webhook integration documentation

Developer platform

API Integration

REST and webhooks let partners distribute chauffeur supply and demand programmatically.

Chauffeur partner REST API and webhook integration documentation
Overview

Programmatic distribution

Partners poll or receive push ride offers with vehicle class, pricing, and SLA metadata.

Booking creation endpoints accept structured itineraries with airport terminal place IDs.

Webhooks broadcast status transitions — assigned, en-route, completed — to partner endpoints.

  • OAuth client credentials
  • Ride offer endpoints
  • Status webhooks
  • OpenAPI specification
How it works

From sandbox key to production traffic

  • Step 1

    Onboard

    Partners receive sandbox credentials and sample payloads in the portal.

  • Step 2

    Certify

    Joint test scripts verify offer accept, cancel, and webhook signature flows.

  • Step 3

    Scale

    Production keys activate with per-tenant rate limits and monitoring dashboards.

Chauffeur partner REST API and webhook integration documentation
Benefits

Developer outcomes

  • Faster GTM

    OTAs integrate without custom engineering from Red Carpet staff.

  • Event-driven ops

    Webhooks remove polling load and shrink status latency.

  • Version stability

    Semantic versioning protects existing integrations when fields expand.

API Integration security
Security

API security

OAuth client credentials rotate from the partner portal with immediate invalidation.

Webhook signatures use HMAC-SHA256 with timestamp tolerance to block replay.

  • Client credential rotation
  • Webhook HMAC
  • Per-tenant rate limits
  • IP allowlists optional
API Integration integration
Integration

Surface area

OpenAPI documents ride offers, bookings, cancellations, and driver status callbacks.

Postman collections and example NestJS consumers ship with certification packets.

  • OpenAPI 3.1 spec
  • Postman collection
  • Sandbox webhooks
  • Usage metrics dashboard
API Integration business use cases
Use cases

Integration patterns

  • OTA demand

    Marketplaces push offers to regional supply partners for acceptance.

  • Corporate ERP

    Enterprises create approved itineraries from internal travel tools.

  • Hotel PMS

    Properties attach ground transport to room reservations automatically.

Support

API FAQ