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:
  • Request runtime permissions as needed and handle outcomes:
    • Android: prompt for location permission at runtime and verify acceptance before starting tracking; handle denied or limited states. See Runtime Permissions.
    • iOS: trigger the Location + Motion prompts up front before the first delivery. See Initialize SDK.
  • Provide credentials and environment:
    • Set your API key during SDK initialization or mount the provider as required by your platform.
  • Integrate lifecycle methods:
    • Call startDeliveryByX(...) to begin a tracking session, markDropoff(...) on drop-off, and stopDelivery(...) when complete. Exact method names vary by platform; see the "Start Tracking" section of your platform's usage guide.