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

# MiyaIP API 接入概览：鉴权、代理生成与接口参考

> 接入 MiyaIP 登录、代理生成、账户用量与代理资产接口，区分 Token 和产品密钥鉴权，并在浏览器中调试真实请求。

你可以通过 MiyaIP API 生成代理连接信息，读取账户用量和已购代理资产。本参考与[官方开发者中心](https://miyaip.com/zh/developer-center)的八个接口对应。

基础地址为 `https://miyaip.com`。参数名称区分大小写。查询参数放在请求 URL 中，JSON 请求体参数放在请求体中。

## 选择接口

| 分组 | 接口 | 方法与路径 | 鉴权 |
| - | - | - | - |
| 身份认证 | [登录](/zh/api-reference/login) | `POST /api/SysLogin/Login` | 无需鉴权 |
| 代理生成 | [生成动态代理](/zh/api-reference/dynamic-generate) | `GET /api/ProxyLogic/Generate` | 查询凭据 |
| 代理生成 | [生成短效住宅代理](/zh/api-reference/short-generate) | `POST /api/UserShort/GenerateIps` | Bearer Token |
| 代理生成 | [生成不限量住宅代理](/zh/api-reference/unlimited-generate) | `GET /api/ProxyLogic/UnlimitedGenerate` | 查询凭据 |
| 账户与用量 | [获取用户信息](/zh/api-reference/user-info) | `GET /api/SysLogin/GetUserInfo` | Bearer Token |
| 账户与用量 | [读取流量用量](/zh/api-reference/bandwidth-analysis) | `GET /api/ProxyLogic/BandwidthAnalysis` | Bearer Token |
| 代理资产 | [查询住宅代理资产](/zh/api-reference/isp-list) | `GET /api/UserIsps/PageList` | Bearer Token |
| 代理资产 | [查询数据中心代理资产](/zh/api-reference/datacenter-list) | `GET /api/DatacenterIps/PageList` | Bearer Token |

## 准备凭据

这些接口采用三种鉴权方式：

* **无需鉴权**：使用邮箱与密码或验证码登录，登录响应会返回访问 Token。
* **Bearer Token**：复制登录得到的 Token，在对应接口页填写。请求通过 `Authorization: Bearer <token>` 发送。页面之间不会自动共享 Token。
* **查询凭据**：动态和不限量生成接口需要 `Crc`、`KeyName`。请从 [MiyaIP 后台](https://miyaip.com/dashboard)取得对应产品的凭据。访问 Token 不能替代这组查询凭据。

生成动态住宅代理时使用住宅产品凭据。移动代理复用动态生成接口，使用移动产品凭据，并设置 `mealType=mobile`。不限量住宅代理使用该产品自己的凭据。发送前核对凭据与产品是否对应。

用户信息响应示例包含住宅和移动密钥，示例未列出不限量密钥。请从后台取得不限量产品凭据。

## 读取响应

动态和不限量生成接口成功时返回 `text/plain` 代理列表。复制连接信息到客户端时，保留你选择的输出格式。其他接口展示 JSON 响应。

HTTP 状态与 JSON 中的业务 `code`、`message` 需要分别检查。HTTP 200 本身不代表业务成功。来源中的错误示例使用 HTTP 400，但 JSON 业务 `code` 为 500，两者不是同一个值。超时或浏览器网络错误可能没有 HTTP 响应。

每篇接口页提供响应示例，以及 cURL、JavaScript、Python 示例。在本地替换示例占位凭据，不要把真实凭据写入共享代码或日志。

## 使用在线调试

点击接口页的**发送请求**后，表单会从你的浏览器直接向 `https://miyaip.com` 发送真实请求，不复用主站登录 Cookie。短效代理生成会消耗短效 IP 额度，发送前请核对数量。

凭据与响应仅保存在当前页面内存中。刷新、离开页面或切换语言后清空。请求预览会脱敏，敏感响应默认遮蔽。需要时，你可以主动显示或复制登录 Token。

调试器的客户端超时为 30 秒，最多展示 200 KiB 响应。请求期间禁止重复发送，不会自动重试。取消请求会停止浏览器等待，不保证服务端已取消操作。生成请求中断后，先核对账户状态，再决定是否重发。

## 来源边界与相关教程

标为公开界面限制的表单范围来自当前开发者中心。来源未说明 Token 有效期与刷新方式、限流、流量单位、正数 `SessionTime` 的单位，以及完整国家或入口线路枚举。请以当前后台和服务端响应为准。

取得连接字段后，继续阅读[静态代理核验教程](/zh/developers/static-proxy)、[网页采集教程](/zh/developers/web-scraping)或 [AI Agent 浏览器接入教程](/zh/developers/ai-agents)。异步抓取任务见独立的 [Crawler API 教程](/zh/developers/crawler-api)。


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