Skip to main content

iOS SDK Installation

Get started with the DoorstepAI iOS SDK to add intelligent delivery tracking to your application.

Prerequisites

Before you begin, ensure you have:

  • Xcode 12 or later with iOS 14+ deployment target
  • Valid API Key from DoorstepAI
  • Swift Package Manager (recommended) or manual framework integration
Development Environment

We recommend using the latest stable version of Xcode for the best development experience and access to the latest iOS features.

Installation Methods

Add the DoorstepAI iOS SDK using Swift Package Manager:

  1. In Xcode, go to FileAdd Package Dependencies
  2. Enter the repository URL: https://github.com/doorstep-ai/DoorstepDropoffSDKPackage
  3. Select version requirements and click Add Package
  4. Import the SDK in your Swift files:
import DoorstepDropoffSDK

Manual Integration

If you prefer manual integration, contact our support team for framework distribution.

Required Permissions

Update your app's Info.plist file with the following permissions:

Info.plist
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>NSLocationWhenInUseUsageDescription</key>
<string>This app requires access to your location for enhanced delivery intelligence</string>

<key>NSLocationAlwaysAndWhenInUseUsageDescription</key>
<string>This app requires access to your location for enhanced delivery intelligence</string>

<key>NSMotionUsageDescription</key>
<string>This app requires access to motion data for enhanced delivery intelligence</string>

<key>UIBackgroundModes</key>
<array>
<string>location</string>
</array>
</dict>
</plist>

Permission Descriptions

PermissionPurposeRequired
NSLocationWhenInUseUsageDescriptionLocation access during app usageRequired
NSLocationAlwaysAndWhenInUseUsageDescriptionBackground location accessRequired
NSMotionUsageDescriptionMotion and sensor dataRequired
UIBackgroundModes (location)Background location processingRequired

Runtime Permission Requirements

PermissionPurposeRuntime RequiredNotes
Location ServicesLocation access during app usageYesSystem prompts automatically
Location ServicesBackground location accessYesSystem prompts automatically
Motion & FitnessMotion and sensor dataYesSystem prompts automatically
Runtime Permissions

iOS handles permission requests automatically through system prompts. Users will be prompted for location and motion permissions when your app first attempts to access these features. Ensure your app's privacy policy clearly explains how location data is used.

Verification

To verify the installation was successful:

  1. Build your project (Cmd + B)
  2. Check for import errors in files using import DoorstepDropoffSDK
  3. Verify permissions are properly configured in your Info.plist

If you encounter any issues during installation, check our troubleshooting guide or contact our support team.

Next Steps

Now that you have the SDK installed and configured:

  1. 📚 Learn SDK Usage - Initialize and use the SDK
  2. 💡 View Examples - See complete implementation examples
info

Ready to initialize the SDK? Head over to our Usage Guide to get started with SDK initialization and basic implementation.