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

# 如何订阅 OpenAPI 并在线测试

> 面向买家的教程：如何在 Rock API 订阅 OpenAPI 服务、在线发送测试请求，并判断是否可以进入集成。

# 如何订阅 OpenAPI 并在线测试

Rock API 支持买家先订阅 OpenAPI 服务，再直接在浏览器里在线测试请求。本文对应 RockAPI 视频 [How to use normal openapi?](https://www.youtube.com/watch?v=8qnpQnJTrX8)，帮助你把视频流程转成可检索、可复用的文字步骤。

<iframe width="100%" height="405" src="https://www.youtube.com/embed/8qnpQnJTrX8" title="How to use normal openapi?" frameBorder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowFullScreen />

*最后更新：2026 年 5 月 23 日*

## 这个流程适合谁

如果你想在接入应用前先评估第三方 OpenAPI 服务，可以使用这个流程。在线测试可以让你在写代码前确认认证方式、请求参数、响应字段和错误信息。

| 目标   | 需要确认的内容                 |
| ---- | ----------------------- |
| 安全订阅 | 价格、额度、续费规则和调用限制         |
| 快速测试 | 请求头、请求体、示例参数和响应格式       |
| 准备集成 | Base URL、接口路径、认证方式和错误返回 |

## 第一步：选择 OpenAPI 服务

进入 API 详情页后，先检查生产使用会关心的信息：

* API 解决什么问题，适合哪些使用场景。
* 订阅后可以调用哪些接口。
* 价格、额度和限流规则如何计算。
* 文档是否提供请求和响应示例。
* 订阅后需要使用哪种认证方式。

如果这个 API 未来要进入生产环境，订阅前先把套餐信息保存到你的内部文档里。

## 第二步：订阅 API

选择服务后，在 API 详情页完成订阅。提交前确认套餐、计费规则和使用限制是否符合预期。

订阅生效后，Rock API 才能为这个 API 授权你的在线测试请求和应用请求。建议把订阅和 API Key 绑定到正确的项目或环境，避免测试流量和生产流量混在一起。

## 第三步：打开在线测试控制台

在 API 文档里的在线测试区域发送浏览器请求。建议先选择最简单的接口，等基础请求成功后，再逐步增加可选参数。

发送请求前检查：

* HTTP 方法和接口路径。
* 必填请求头，包括认证信息。
* 必填 query 参数或 JSON body 字段。
* 文档中给出的示例值。

## 第四步：查看响应结果

一次成功的在线测试应该返回与文档一致的状态码和响应体。重点确认你的应用会依赖的字段，例如 ID、状态值、分页字段或结果 URL。

如果测试失败，可以先根据错误信息定位问题：

| 错误信号          | 常见原因                |
| ------------- | ------------------- |
| `401` 或 `403` | 未订阅、API Key 无效或权限不足 |
| `400`         | 缺少必填参数或请求体格式错误      |
| `404`         | 接口路径或资源 ID 不正确      |
| `429`         | 达到限流或额度限制           |
| `5xx`         | 服务商侧错误或临时故障         |

## 第五步：从在线测试迁移到代码

浏览器测试通过后，把已经确认的请求结构复制到你的应用里。保持这些信息一致：

* Base URL 和接口路径。
* HTTP 方法。
* 请求头和认证格式。
* JSON body 字段和数据类型。
* 预期的成功响应和错误响应。

如果需要代码示例，可以查看 [curl](/zh-cn/examples/curl)、[Node.js](/zh-cn/examples/nodejs) 或 [Python](/zh-cn/examples/python)。

## 买家检查清单

* 你已经理解 API 的价格、额度和限流规则。
* 你使用正确账号或项目完成了订阅。
* 在线测试返回了有效响应。
* 你保存了可工作的请求示例，方便开发人员复用。
* 你知道应用需要处理哪些错误。
* 生产使用前已经阅读 [API Key 安全管理](/zh-cn/blog/buyers/secure-api-key-management)。

## 常见问题

### 订阅 OpenAPI 后，最快的测试方式是什么？

最快的方式是在 API 文档中使用在线测试控制台。你可以直接在浏览器里发送请求，并查看状态码、响应体和错误信息。

### 在线测试前必须先写代码吗？

不需要。你可以先用在线测试控制台确认请求可以成功，再把同样的接口、请求头和请求体迁移到 curl、Node.js、Python 或应用代码中。

### 为什么在线测试返回 `401` 或 `403`？

`401` 或 `403` 通常表示请求没有通过授权。请确认订阅已经生效、API Key 有效，并且请求使用了文档要求的认证请求头。

### 上生产前还需要确认什么？

确认价格、限流、响应格式、错误处理、日志和密钥存储方式。生产流量前建议使用 [API 订阅检查清单](/zh-cn/blog/buyers/api-subscription-checklist)。