Getting StartedQuickstart

Quickstart Guide

Get your first route planned in 5 minutes.

Prerequisites

  • SALLY account (sign up at sally.appshore.in)
  • Staging API key (we’ll generate one in step 1)

Step 1: Get Your API Key

  1. Sign in to your SALLY dashboard
  2. Navigate to Dashboard → API Keys
  3. Click “Generate API Key”
  4. Give it a name (e.g., “Test Key”)
  5. Copy your key - it starts with sk_staging_
⚠️

Important: Save your API key securely. You won’t be able to see it again.

Step 2: Make Your First Request

Let’s plan a simple route from Los Angeles to Phoenix:

curl -X POST https://sally-api.apps.appshore.in/api/v1/routes/plan \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "driverId": "DRV001",
    "vehicleId": "VEH001",
    "stops": [
      {
        "location": "Los Angeles, CA",
        "type": "origin",
        "appointmentTime": "2026-02-06T08:00:00Z"
      },
      {
        "location": "Phoenix, AZ",
        "type": "delivery",
        "appointmentTime": "2026-02-06T16:00:00Z"
      }
    ]
  }'

Replace YOUR_API_KEY with your actual key.

Step 3: Review the Route Plan

The API returns an optimized route with:

{
  "planId": "plan_abc123",
  "status": "optimized",
  "segments": [
    {
      "type": "drive",
      "from": "Los Angeles, CA",
      "to": "Phoenix, AZ",
      "distanceMiles": 373,
      "durationHours": 5.5
    }
  ],
  "totalDistanceMiles": 373,
  "totalDurationHours": 5.5,
  "hosCompliant": true,
  "feasibility": {
    "isFeasible": true,
    "violations": []
  }
}

✅ HOS-compliant segments ✅ Rest stops automatically inserted (if needed) ✅ Fuel stops optimized for price ✅ Compliance validation passed

Step 4: Test in the API Playground

Visit our API Reference to test endpoints interactively in your browser.

What’s Next?

Need Help?