> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.goautolane.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.goautolane.com/_mcp/server.

# Authentication

> How to authenticate with the Autolane APIs

# Authentication

Autolane uses two authentication methods depending on which API you are accessing.

## AV / Ride-Hail Analytics API

Analytics API requests require an API key passed in the `Authorization` header as a Bearer token.

### Creating an API key

1. Log in to the [Autolane Portal](https://portal.goautolane.com)
2. Navigate to **Integrations** > **API Keys** (toggle **dev mode** on first if you want a sandbox key; off for a production key)
3. Click **Create API Key**
4. Enter a name for your key (e.g., "Analytics Integration")
5. Select the **analytics:read** permission
6. Click **Create** and copy the key. It is only shown once.

### Using your API key

```bash
curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.goautolane.com/avrh/v1/analytics/metrics?siteId=YOUR_SITE_ID&period=today"
```

### Finding your Site ID

Your Site ID is a UUID visible in the Autolane Portal URL when viewing a site:

```
https://portal.goautolane.com/sites/87654321-4321-4321-4321-210987654321
                                     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
                                     This is your Site ID
```

## Direct Delivery API

Direct Delivery API requests require an **Autolane API key** in the `Authorization` header plus a per-site `x-retailer-id` header (UUID). Your organization is resolved from the API key; the retailer/site is resolved from the header.

### Creating an API key

1. Log in to the [Autolane Portal](https://portal.goautolane.com)
2. Navigate to **Integrations** > **API Keys** (toggle **dev mode** on first if you want a sandbox key; off for a production key)
3. Click **Create API Key**
4. Enter a name for your key (e.g., "Delivery Integration")
5. Select the permissions your integration needs:

| Permission         | Grants                                                                                                                           |
| ------------------ | -------------------------------------------------------------------------------------------------------------------------------- |
| `deliveries:read`  | List and view deliveries                                                                                                         |
| `deliveries:write` | Request quotes, create deliveries, and update or cancel them. Required for any DSP-aggregator integration that books deliveries. |
| `webhooks:manage`  | Register, update, and delete webhook endpoints                                                                                   |

6. Click **Create** and copy the key. It is only shown once.

You can view and revoke Direct Delivery API keys at any time from the same **API Keys** page.

### Using your API key

```bash
curl -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-retailer-id: a1b2c3d4-e5f6-7890-1234-567890abcdef" \
  "https://api.goautolane.com/dd/v1/deliveries"
```

The `x-retailer-id` value is your store's site UUID, available in the Autolane Portal under your store's settings.

## Reservations API

Reservations API requests require an **Autolane API key** passed in the `Authorization` header as a Bearer token.

Reservations keys work only for organizations enrolled as Autolane fleet partners. Keys from other organizations receive a `403` response even when the key has the right permission. Contact Autolane to enroll as a fleet partner.

### Creating a Reservations API key

1. Log in to the [Autolane Portal](https://portal.goautolane.com)
2. Navigate to **Integrations** > **API Keys** (toggle **dev mode** on first if you want a sandbox key; off for a production key)
3. Click **Create API Key**
4. Enter a name for your key (e.g., "Reservations Integration")
5. In the **Reservations** group, check **Read reservable sites, zones, and retailers**. This grants the `retailers:read` permission.
6. Click **Create** and copy the key. It is only shown once.

The **dev mode** toggle decides which environment the key targets: on creates a sandbox key that works against `https://api-sandbox.goautolane.com`, off creates a production key that works against `https://api.goautolane.com`.

### Using your API key

```bash
curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.goautolane.com/rs/v1/retailers"
```

## Rate limits

Autolane does not publish a hard rate limit for v1 API keys. The platform is monitored, and integrations sending sustained high volume may be reached out to about adjusting client-side request pacing. If you are planning a launch that exceeds a few requests per second per organization, contact your Autolane account team in advance so we can pre-stage capacity for your traffic.

## Key management

You can view and revoke API keys at any time from the **API Keys** page under **Integrations** in the portal. Revoked keys immediately stop working.