Skip to main content

Rodando Backend API

Build powerful ride-sharing applications with real-time driver matching, trip management, and seamless payment processing.

Key Features

JWT Authentication

Secure authentication with refresh tokens, session management, and multi-device support

Real-Time Matching

Geohash-based driver discovery with intelligent matching algorithms

Trip Lifecycle

Complete trip management from request through completion with state machine validation

WebSocket Events

Real-time updates for drivers, passengers, and admin dashboards

Dynamic Pricing

Multi-tier vehicle classification with flexible pricing policies per zone

Payment Processing

Wallet management, transaction tracking, and cash collection points

Setup Guide

Install dependencies and configure your development environment

Architecture

Understand the system design and core components

Database Setup

Configure PostgreSQL and run migrations

Authentication API

Implement user authentication and session management

Trip Management

Create and manage ride requests

WebSocket Guide

Connect clients to real-time event streams

Core Capabilities

For Passengers

  • Request rides with fare estimates
  • Real-time driver tracking
  • Trip history and receipts
  • Multiple payment methods

For Drivers

  • Real-time trip offers
  • Location-based assignment
  • Earnings and wallet management
  • Availability controls

For Platform Operators

  • Multi-city support with zone-based pricing
  • Vehicle type and service class management
  • Driver onboarding and profile management
  • Transaction monitoring and reporting

API Overview

The Rodando Backend API provides RESTful endpoints for all platform operations plus WebSocket gateways for real-time communication:
POST   /api/auth/login     # Authenticate user
POST   /api/auth/refresh   # Refresh access token
POST   /api/auth/logout    # Revoke session

Technology Stack

Built with modern, production-ready technologies:
  • Framework: NestJS with TypeScript
  • Database: PostgreSQL with TypeORM
  • Real-time: Socket.io for WebSocket communication
  • Authentication: JWT with passport-jwt strategy
  • API Docs: Swagger/OpenAPI integration
  • Geolocation: Geohash-based spatial indexing
All API endpoints are prefixed with /api and support both web and mobile clients with appropriate session handling.

Next Steps

1

Quick Start

Follow the quickstart guide to get a local instance running in minutes
2

Explore Concepts

3

Build with the API

Browse the API Reference and integrate with your application

Build docs developers (and LLMs) love