# 快速开始

使用开放平台控制台中的 API Key，完成你的第一个 Pipispy API 请求。

## 1. 获取 API Key

[打开控制台](/zh/dashboard)，登录或注册账号。确认套餐和剩余数据额度，然后复制 API Key。

请在服务端保管密钥，不要将其写入公开仓库、浏览器代码或移动端应用。

## 2. 选择接口

可以先使用 [Adspy 广告列表接口](/zh/doc/adspy-list)，通过筛选条件和分页参数获取广告数据。

- 请求方法：`POST`
- 请求地址：`https://www.pipispy.com/open-api/v1/data`
- 接口路径：`/v3/api/open/adspy/list`
- 内容类型：`application/json`

请求体包含 `key`、`uri` 和 `params` 三个字段。首次请求可以设置 `current_page: 1`、`page_size: 10`。成功获取数据会按接口说明消耗额度。

## 3. 处理返回结果

同时检查 HTTP 状态码与响应体中的 `code`、`message`。对于此接口，响应体中的 `code: 200` 表示成功。按照[接口响应字段说明](/zh/doc/adspy-list)处理 `data` 内容。

HTTP 成功不一定代表业务操作成功，请在应用中处理参数、鉴权和额度等错误。

## 4. 接入业务流程

按照各接口说明配置分页与筛选条件。不同接口的必填参数和网关可能不同，例如广告监控使用 `/open-api/v1/monitor/data`，图片上传可使用 multipart 请求。

接入前请阅读[鉴权与请求](/zh/doc/authentication)及[用量与错误处理](/zh/doc/usage-and-errors)。下方示例在服务端运行；Python 需要安装 `requests`，JavaScript 需要支持内置 `fetch` 的 Node.js。
