Skip to main content

Dropoff SDK Documentation

Welcome to the official documentation for doorstep.ai's Dropoff SDK. Our SDK enables delivery tracking for your applications across multiple platforms.

Getting Started​

Choose your platform to get started:

  • React Native - Cross-platform React Native
  • Flutter - Cross-platform Flutter
  • Capacitor - Cross-platform Capacitor (Angular, React, Vue, Next.js, and other supported frameworks)
  • iOS - Native iOS integration
  • Android - Native Android integration

Support​

Integration Checklist​

  • Install the Dropoff SDK for your platform:
  • Configure required permissions:
    • Add the iOS usage descriptions, background mode, and Android manifest declarations in your platform's installation guide.
  • Implement the staged runtime-permission flow and handle all detailed states:
    • iOS • Android • React Native • Flutter • Capacitor
    • Request foreground location first. Explain the background need, then request background/Always location separately. Treat whenInUseOnly as foreground-only, not granted.
  • Provide credentials and environment:
    • Set your API key during SDK initialization or mount the provider as required by your platform.
  • Integrate lifecycle methods:
    • Initialize once at launch, call the matching startDelivery… method on geofence ENTER, markDropoff(...) when the driver completes the stop, and stopDelivery(...) on geofence EXIT.
    • If the SDK owns route geofencing, provide the full stop list and resume persisted monitoring on app relaunch. Reliable route monitoring requires background/Always location.