# 开发者指南

从第一次 API 调用到 MCP 与 AI 接入，按任务找到可执行的步骤和排查方法。

## 核心步骤

- 选择直接 API 或 MCP 接入。
- 确认所需产品权限与运行环境。
- 完成一次调用并验证实际响应。

## 从你的任务开始

如果你正在把数据接入网站、应用或内部系统，从 [API 快速开始](https://www.gugudata.com/developers/getting-started) 入手。如果你希望让 AI 客户端发现并调用账号已有能力，先阅读 [Remote MCP 接入总览](https://www.gugudata.com/developers/mcp)。两种方式共用业务权益，但凭据和客户端配置不同。

| 你要完成的任务 | 建议阅读 | 完成后应得到什么 |
| --- | --- | --- |
| 后端调用一个接口 | [快速开始](https://www.gugudata.com/developers/getting-started) | 可复现的请求和经校验的响应 |
| 管理调用凭据 | [鉴权与 AppKey](https://www.gugudata.com/developers/authentication) | 不暴露密钥的调用链路 |
| 规划调用频率与扩展容量 | [QPS 与升级](https://www.gugudata.com/developers/qps-and-upgrades) | 有节奏的调用策略与清晰的扩展流程 |
| 定位调用失败 | [错误与重试](https://www.gugudata.com/developers/errors-and-retries) | 错误分类与有限重试策略 |
| 在 AI 客户端使用工具 | [MCP 客户端配置](https://www.gugudata.com/developers/mcp/clients) | 完成授权的客户端连接 |
| 用工具验证接口 | [OpenAPI 与调试工具](https://www.gugudata.com/developers/openapi-and-tools) | 可共享但不含凭据的测试配置 |
| 让 AI 帮你完成接入 | [AI 接入实践](https://www.gugudata.com/developers/ai-integration) | 有契约依据、有测试的实现 |

## 使用开发者中心

接口开通后，可以通过开发者中心管理权限、查看购买记录和排查调用情况。按当前任务选择以下指南，具体操作需登录账号后完成。

| 你要完成的任务 | 建议阅读 |
| --- | --- |
| 查找 AppKey 并确认接口有效期 | [AppKey 与接口权限](https://www.gugudata.com/developers/portal/appkeys) |
| 查询订单、续费或升级年付 | [订单与续费管理](https://www.gugudata.com/developers/portal/orders) |
| 分析流量、耗时和失败请求 | [请求分析与日志](https://www.gugudata.com/developers/portal/monitoring) |
| 设置通知邮箱、检查安全记录或管理下载密钥 | [账号设置与安全](https://www.gugudata.com/developers/portal/account-security) |

## 开始前准备什么

准备能够访问公网 HTTPS 的后端环境，确认目标接口的请求方式、必填参数和产品权限。示例中的环境变量需要由你自行配置；不要把真实凭据发给 AI 或粘贴到公开问题中。

::: note
接口的准确路径、字段、业务状态码和当前价格以对应 API 详情页为准。指南解释如何完成任务，不替代接口契约。
:::

## 如何使用这组指南

先阅读适用场景，再按核心步骤运行最小示例。记录 HTTP 状态、业务状态和是否得到所需字段；遇到失败时先分类，不要连续点击或无限重试。可以复制整篇 Markdown 交给 Coding Agent，也可以只复制一段代码。

指南中的代码是接入示例，不自动执行请求或购买服务。正式环境上线前，还需要根据业务请求频率、敏感信息范围和接口特性补充测试。

## 接口、Skill 和指南各自负责什么

[API 详情页](https://www.gugudata.com/api/all/9/0/9/0/all/1) 提供准确契约；[MCP 页面](https://www.gugudata.com/mcp) 提供当前服务能力；[Skill 目录](https://www.gugudata.com/skills) 说明多接口的业务组合。本指南负责操作步骤和排错路径。已知接口名称时，直接到详情页核对字段，不必先通读所有指南。

需要参考具体业务流程时，可查看 [产品案例](https://engineering.gugudata.com/products/)；网站巡检场景可参考 [网站 SEO 可见性 Skill](https://www.gugudata.com/skills/website-seo-visibility)。