⚡ Android & Flutter App Integration

RiderSaathi Mobile App REST APIs

Use these production-ready endpoints to connect the RiderSaathi Android APK with your live backend for authentication, 10 free trial rides counter, active subscription verification, filter rules sync, and OTA updates.

Base URL: /api/app (e.g. https://ridersaathi.onrender.com/api/app)

POST/api/app/auth

Driver Login or Registration. Automatically assigns 10 Free Trial Rides on new sign up, checks existing subscription, and returns auth token with driver filter rules.

Request Body (JSON)

{
  "phone": "9876543210",
  "name": "Raju Captain",
  "deviceId": "android-uuid-99a12c",
  "deviceModel": "Xiaomi Redmi Note 12",
  "appVersion": "5.28.1"
}

Response (200 OK)

{
  "success": true,
  "message": "Authenticated successfully",
  "token": "token_17300000_abc123",
  "driver": {
    "id": "DRV-1730000001",
    "phone": "9876543210",
    "name": "Raju Captain",
    "status": "active"
  },
  "access": {
    "accessGranted": true,
    "reason": "trial_active",
    "message": "Free trial active: 10 rides remaining",
    "trial": { "total": 10, "used": 0, "remaining": 10 },
    "subscription": { "isActive": false, "daysLeft": 0 }
  },
  "filterRules": {
    "minFare": 50,
    "maxPickupDistanceKm": 2.5,
    "minFarePerKm": 12,
    "platforms": { "rapido": true, "uber": true, "porter": true },
    "autoAccept": true
  }
}

GET/api/app/status

Verify if the driver is currently allowed to filter rides. Returns trial status or days left in active paid subscription.

Headers

Authorization: Bearer <token>
// OR Query param: ?phone=9876543210

Response (200 OK)

{
  "success": true,
  "accessGranted": true,
  "reason": "active_subscription",
  "subscription": {
    "isActive": true,
    "planName": "1 Week Pass",
    "expiresAt": "2026-10-28T12:00:00.000Z",
    "daysLeft": 7
  },
  "trial": { "total": 10, "used": 10, "remaining": 0 },
  "serverTime": "2026-10-21T16:40:00.000Z"
}

POST/api/app/ride/record

Triggered when RiderSaathi accessibility service accepts or filters a matching ride. Deducts 1 ride from the 10 free trial rides (if in trial mode) and updates driver stats.

Request Body (JSON)

{
  "token": "token_17300000_abc123",
  "platform": "rapido",
  "fare": 95,
  "pickupDistanceKm": 1.4,
  "tripDistanceKm": 6.8
}

Response (200 OK)

{
  "success": true,
  "message": "Ride recorded successfully",
  "access": {
    "accessGranted": true,
    "reason": "trial_active",
    "trial": { "total": 10, "used": 1, "remaining": 9 }
  }
}

POST/api/app/rules/sync

Saves the driver's custom filter settings (Min Fare, Max Pickup, Platforms) to cloud so settings are never lost on phone restart.

Request Body (JSON)

{
  "token": "token_17300000_abc123",
  "filterRules": {
    "minFare": 60,
    "maxPickupDistanceKm": 2.0,
    "minFarePerKm": 14,
    "platforms": { "rapido": true, "uber": true, "porter": false },
    "passengers": true,
    "parcels": false,
    "autoAccept": true,
    "voiceAlert": true
  }
}

GET/api/app/check-update?version=5.28.1

Checks if a newer APK is released. Prompts the driver to download update.

Response (200 OK)

{
  "hasUpdate": false,
  "latestVersion": "5.28.1",
  "apkUrl": "https://ridersaathi.onrender.com/downloads/RiderSaathi-v5.28.1.apk",
  "apkFileSize": "11.1 MB",
  "releaseNotes": "Faster Rapido & Uber filter response with Android 14 support",
  "isForceUpdate": false
}

POST/api/app/order/create

Initiate plan subscription directly inside the mobile app. Returns UPI payment intent string and QR details.

Request Body (JSON)

{
  "planId": "week1",
  "phone": "9876543210"
}

Response (200 OK)

{
  "success": true,
  "orderId": "ORD-17300000-ABC",
  "planName": "1 Week",
  "amount": 68,
  "upiString": "upi://pay?pa=ridersaathi@upi&pn=RiderSaathi&am=68&tn=RiderSaathi_week1",
  "upiId": "ridersaathi@upi"
}