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

# Introduction

> Superlink provides a REST API to interact with our backend for our various products.

### Prerequisites

Before you begin, ensure you have:

* **Completed the Superlink Partner Onboarding**: You must be a Superlink partner to use our SDK. If you aren't onboarded yet, please [reach out to us](https://superlink-staging.me/book-a-call).
* **Received an API Key**: You must have an API key to authenticate your requests. You will receive an API key when you onboard as a partner.

### Explore our API endpoints

<CardGroup>
  <Card title="Free Subdomains" icon="code" href="/api-reference/free-subdomains" />

  <Card title="Headless Marketplace" icon="code" href="/api-reference/headless-marketplace" />

  <Card title="Universal Resolution Service" icon="code" href="/api-reference/resolution" />

  <Card title="Partner API" icon="code" href="/api-reference/partner" />
</CardGroup>

## Authentication

API endpoints are authenticated using Bearer tokens. [Reach out](https://superlink-staging.me/book-a-call) to us to become a partner and receive your API key.

You can pass the token in the `Authorization` header of the request, and remember to prefix the token with `Bearer` and a space.

## OpenAPI Specification

Superlink provides an OpenAPI specification file for our API. You can use this file to generate client libraries, documentation, and more.

<Card title="Superlink API Specification" icon="code" href="https://api.superlink.me/v1/docs/doc.json">
  View the OpenAPI specification file
</Card>

## Client SDK

Superlink also provides an [SDK to interact with our API](/sdk-reference/client-sdk). The SDK is available in Javascript, Go and Python.
