Skip to main content

Welcome to doorstep.ai 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:

Quick Start

  1. Install the SDK for your platform
  2. Initialize the SDK with your API credentials
  3. Configure your app to use the start/stop/event methods
  4. Start tracking deliveries in your app

Support

Integration Checklist

  • Install the Dropoff SDK for your platform:
  • Configure required permissions:
  • Request runtime permissions as needed and handle outcomes:
    • e.g. on Android - prompt for location permission at runtime and verify acceptance before starting tracking; handle denied or limited states.
  • Provide credentials and environment:
    • Set your API key during SDK initialization or mount the provider as required by your platform.
  • Integrate lifecycle methods:
    • Call start(...) to begin a tracking session, emit event(...) updates per SLA, and stop() when complete.