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

# Introduction

> API Reference and Integration Guide

<Note>
  The Clink API is currently in development, and available features are limited.
</Note>

## Base Endpoints

The Clink API follows REST principles and requires HTTPS for all requests to ensure data security, integrity, and privacy.

API endpoints for different environments:

<AccordionGroup>
  <Accordion icon="code" title="Test Environment">
    ```http theme={null}
    https://uat-api.clinkbill.com
    ```
  </Accordion>

  <Accordion icon="code" title="Production Environment">
    ```http theme={null}
    https://api.clinkbill.com
    ```
  </Accordion>
</AccordionGroup>

## Authentication

Clink uses API keys in request headers for security. Additionally, a dynamic timestamp within a two-minute window is required.

```json theme={null}
{
  "headers": {
    "X-API-Key": "sk_test_*********************",
    "X-Timestamp": "${millisecondsTimestamp}"
  }
}
```

## Response codes

We use standard HTTP status codes to indicate the outcome of API requests:

2xx codes indicate successful requests
4xx codes indicate client-side errors
5xx codes indicate server-side issues

| Status | Description                                     |
| ------ | ----------------------------------------------- |
| 200    | Request successful                              |
| 400    | Invalid parameters or request format            |
| 401    | Missing or invalid API key                      |
| 403    | Insufficient permissions for requested resource |
| 404    | Requested resource not found                    |
| 429    | Rate limit exceeded                             |
| 500    | Internal server error                           |