> For the complete documentation index, see [llms.txt](https://docs.iproyal.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.iproyal.com/cn/dai-li/huang-jia-zhu-zhai-dai-li/api.md).

# API

{% hint style="danger" %}
自 2025 年 9 月 15 日起，[旧版 API 已弃用](https://documenter.getpostman.com/view/10917935/Uz5KjZ8k)，不再受支持。请迁移到新版 API，以确保服务不中断。
{% endhint %}

### 基URL

**`https://resi-api.iproyal.com/v1`**

### 授权（Authorization）

身份验证通过 **`Authorization`** header进行管理。为了确保安全访问，所有请求都必须包含此header（标头），后跟您的API令牌，以单词“Bearer”加一个空格作为前缀。格式应为: 

**`Authorization`**`:`**`Bearer <your_api_token>`**

您的API令牌可在仪表板的“API”部分的设置页面中找到。在这里，如果需要，您也可以重置您的令牌。确保其安全，并在重置后使用新令牌更新您的应用程序。


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.iproyal.com/cn/dai-li/huang-jia-zhu-zhai-dai-li/api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.