> ## Documentation Index
> Fetch the complete documentation index at: https://developers.lightyshare.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Lightyshare API for client integrations

## Welcome to Lightyshare API

The Lightyshare API allows users to access and manage their products, bundles, and rentals through third-party integrations. This REST API uses Bearer token authentication to secure all endpoints.

<Card title="OpenAPI Specification" icon="code" href="/openapi.yaml">
  View the complete OpenAPI specification
</Card>

## Authentication

All API requests require a user authentication token. You can include it in two ways:

### Option 1: Authorization Header (recommended)

```bash theme={null}
curl -H "Authorization: Bearer lsh_live_abc123..." \
     https://lightyshare.com/api/token-secured/product/123
```

### Option 2: Query Parameter

```bash theme={null}
curl https://lightyshare.com/api/token-secured/product/123?token=lsh_live_abc123...
```

## Versioning

Lightyshare uses a date-based versioning system to maintain backwards compatibility.

### Version Format

API versions use the format `YYYY-MM-DD` (e.g., `2025-08-16`)

### How It Works

1. **Token-based versioning**: Each API token is automatically tied to the latest version available at creation time
2. **Request-level override**: You can specify a different version using the `lighty-version` header
3. **Stable URLs**: API URLs remain stable - versioning is handled via token or header

### Examples

```bash theme={null}
# Uses token's default version
curl -H "Authorization: Bearer lsh_live_abc123..." \
     https://lightyshare.com/api/token-secured/rental/123

# Override with specific version
curl -H "Authorization: Bearer lsh_live_abc123..." \
     -H "lighty-version: 2025-01-15" \
     https://lightyshare.com/api/token-secured/rental/123
```

The API version used is always returned in the `X-API-Version` response header.
