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

# Introduction

> Vantio API documentation

## Welcome

The Vantio API provides programmatic access to manage your referral programs, track ambassadors, and monitor earnings. This API uses [OpenAPI 3.0](https://mintlify.com/docs/api-playground/openapi/setup) specification.

<Card title="Vantio API" icon="api" href="https://github.com/your-org/vantio/blob/main/docs/api-reference/openapi.json">
  View the OpenAPI specification file
</Card>

## Base URL

The API base URL is:

```
http://localhost:3000
```

For production, replace with your production server URL.

## Authentication

All API endpoints require authentication using a Bearer token. Include your secret API key in the `Authorization` header:

```
Authorization: Bearer sk_...
```

The API key format is `sk_` followed by your secret key. You can find your API keys in your dashboard settings.

<Warning>
  Keep your API keys secure and never expose them in client-side code or public repositories.
</Warning>

## API Resources

The API is organized into the following resource groups:

* **Users** - Student directory within your programs
* **Referrals** - Signups and conversions
* **Posters** - Ambassador posters and placements
* **Impressions** - QR scans and related activity
* **Earnings** - Earnings from referrals

## Rate Limits

API rate limits apply to prevent abuse. Check response headers for rate limit information.

## Error Handling

The API uses standard HTTP status codes:

* `200` - Success
* `400` - Bad Request (invalid parameters)
* `401` - Unauthorized (invalid or missing API key)
* `404` - Not Found (resource doesn't exist)