> ## 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.

# 介绍

> API 参考文档与集成指南

<Note>
  Clink API 目前正在开发中，可用功能有限。API接口文档仅提供英文版本，如果您是现有商户并需要接入方面的帮助，请直接联系我们的支持团队。
</Note>

## 基础端点

Clink API 遵循 REST 原则，并要求所有请求使用 HTTPS 以确保数据安全性、完整性和隐私性。

不同环境的 API 端点：

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

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

## 身份认证

Clink 在请求头中使用 API 密钥进行安全认证。此外还需要动态时间戳，生产环境要求与平台时间相差不超过 2 分钟（沙盒更宽松）。请在发起请求时取当前时间，不要依赖容差窗口。

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

## 响应状态码

我们使用标准的 HTTP 状态码来表示 API 请求的结果：

2xx 状态码表示请求成功 4xx 状态码表示客户端错误 5xx 状态码表示服务器端问题

| 状态码 | 描述 |
| - | - |
| 200 | 请求成功 |
| 400 | 无效的参数或请求格式 |
| 401 | API 密钥缺失或无效 |
| 403 | 请求资源的权限不足 |
| 404 | 请求的资源未找到 |
| 429 | 请求速率过快 |
| 500 | 服务器内部错误 |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.