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

# Introduction

> Welcome to the taap.it API documentation

## What is taap.it API?

The taap.it API provides programmatic access to taap.it's link management and analytics platform. With our API, you can create, manage, and track deeplinks, analyze performance data, and integrate taap.it's capabilities directly into your applications.

## Key Features

<CardGroup cols={2}>
  <Card title="Link Management" icon="link">
    Create, update, and delete deeplinks with custom domains and advanced features
  </Card>

  <Card title="Analytics & Insights" icon="chart-line">
    Track clicks, unique visitors, geographic data, and device analytics
  </Card>

  <Card title="Custom Domains" icon="globe">
    Create branded deeplinks with your own custom domains
  </Card>

  <Card title="Project Management" icon="folder">
    Group related links and track performance across projects
  </Card>
</CardGroup>

## Getting Started

<Steps>
  <Step title="Create an API Key">
    Log into your taap.it dashboard and navigate to your user settings to create an API key.

    <Warning>
      Keep your API key secure and never share it publicly. API keys provide full access to your account.
    </Warning>
  </Step>

  <Step title="Make Your First Request">
    Use your API key to authenticate requests to the taap.it API.

    ```bash cURL theme={null}
    curl -X GET 'https://api.taap.it/v1/links' \
      -H 'Authorization: Bearer taapit_your_api_key_here'
    ```
  </Step>

  <Step title="Start Building">
    Explore our endpoints for domains, links, projects, and stats to build powerful integrations.
  </Step>
</Steps>

## Authentication

All API requests require authentication using an API key. Include your API key in the Authorization header using the Bearer token format:

```bash theme={null}
Authorization: Bearer taapit_your_api_key_here
```

<Info>
  API keys are prefixed with `taapit_` and can be created through the web application dashboard.
</Info>

## Base URL

All API requests should be made to:

```
https://api.taap.it/v1
```

## Rate Limits

The taap.it API implements rate limiting to ensure fair usage and optimal performance:

* **Plan-based Rate Limits**: Rate limits vary based on your subscription plan
* **Per-user enforcement**: Limits are applied per user account
* **Future endpoint-specific limits**: May be implemented for specific endpoints in the future

Rate limit headers are included in all responses:

```http theme={null}
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200
```

## Response Format

All API responses are returned in JSON format with the following structure:

<CodeGroup>
  ```json Success Response theme={null}
  {
    "data": { ... },
    "message": "Success"
  }
  ```

  ```json Error Response theme={null}
  {
    "detail": "Error message describing what went wrong"
  }
  ```
</CodeGroup>

## Status Codes

The API uses standard HTTP status codes:

* `200` - Success
* `201` - Created
* `400` - Bad Request
* `401` - Unauthorized
* `403` - Forbidden
* `404` - Not Found
* `409` - Conflict
* `429` - Too Many Requests
* `500` - Internal Server Error

## Support

Need help? We're here to assist:

* **Email**: [support@taap.it](mailto:support@taap.it)
* **Documentation**: This documentation site
* **Status Page**: status.taap.it

<Card title="Ready to get started?" icon="rocket" href="/quickstart">
  Jump into our quickstart guide to make your first API call in under 5 minutes.
</Card>