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

# How to Get Started

> Step-by-step guide to begin using the Turris API

To begin using the Turris API, follow these steps:

## 1. Create an Upstream Entity Account

If you don't already have one, you'll need to reach out to Turris support to invite you onto the Turris platform.

<Note>
  You will need **two separate invitations** - one for the sandbox environment and another one for the live production environment.
</Note>

Contact [support@turrisfi.com](mailto:support@turrisfi.com) to request access.

## 2. Generate API Credentials

<Steps>
  <Step title="Log into the web app">
    Access your Turris dashboard at the appropriate environment URL.
  </Step>

  <Step title="Navigate to API Settings">
    Go to **Settings > API** in the navigation menu.
  </Step>

  <Step title="Create your credentials">
    Create your API credentials of choice. We highly recommend the OAuth flow.
  </Step>

  <Step title="Store credentials securely">
    Store the credentials before closing the modals.
  </Step>
</Steps>

<Warning>
  **Important:** Sensitive secrets and tokens are not known to Turris, are stored as hashed strings, and cannot be retrieved again at a later time. If you lose them, you will have to delete the issued credentials and create new ones.
</Warning>

## 3. Environment Setup

Choose the appropriate environment for your use case:

| Use Case              | Environment | Base URL                                  |
| --------------------- | ----------- | ----------------------------------------- |
| Development & Testing | Sandbox     | `https://public.api.sandbox.turrisfi.com` |
| Production            | Live        | `https://public.api.live.turrisfi.com`    |

## 4. Make Your First API Call

Once you have your credentials, authenticate and make your first request:

<CodeGroup>
  ```bash Get OAuth Token theme={null}
  curl -X POST "https://public.api.sandbox.turrisfi.com/v1/auth/token" \
    -H "Content-Type: application/json" \
    -d '{
      "clientId": "your-client-id",
      "clientSecret": "your-client-secret"
    }'
  ```

  ```bash List Downstream Entities theme={null}
  curl -X GET "https://public.api.sandbox.turrisfi.com/v1/downstream-entity-associations" \
    -H "Authorization: Bearer <your-jwt-token>"
  ```
</CodeGroup>

## Next Steps

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/authentication">
    Learn about OAuth and Restricted Access Token authentication
  </Card>

  <Card title="Entity Definitions" icon="sitemap" href="/guides/entity-definitions">
    Understand the core entities and their relationships
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/v1/downstream-entity-associations/list-associations">
    Explore all available endpoints
  </Card>

  <Card title="Error Handling" icon="triangle-exclamation" href="/guides/error-handling">
    Learn how to handle API errors
  </Card>
</CardGroup>