2025年9月

说明

对一个小白来说，这份教程不用太专业，我只需要教会你如何使用API即可。在编写接口文档页时，本站把接口文档分成了几大板块：

API详情，API请求参数， API输出参数， API输出示例

（其实是借鉴的，因为本站本就不太专业，你会发现糖豆子很多站点几乎都是这样。编写文档的目的是帮助你理解，而不是纷繁和复杂）。

为了让小白学会使用API，我编写了此教程。

API是什么？

对于此教程来说，简洁地解释不能达到你的需求，大费周章地解释会占据大部分篇幅，且与主题不符，这里给出一个优秀的例子，让你知道API是什么。

API到底是什么啊？- 知乎

API应用场景

本站大部分API为QQBot开发而生，当然，你也可以使用本站API进行软件开发和网站开发等。

API详情

此版块包含以下内容：

API链接：不含参数的API链接。
请求方式：最常用的是GET，其次是POST（常用于提交数据，比如注册、登录、发评论），但GET始终是第一，详见

接口请求（get、post、head等）详解 - 知乎。

输出格式：最常用的是JSON，90%及以上的现代API都会采用JSON返回。前面提到，本站大部分API为QQBot开发而生，所以存在部分API返回纯文本或图片等格式，可方便Bot开发。

说到JSON，这里了解一下JSON语法（内含x6语法，你可以忽略）：

JSON语法介绍

使用键值对 key:value 表示对象属性和值。
使用逗号 , 分隔多条数据。
使用花括号 {} 包含对象。
使用方括号 [] 表示数组。

示例：

{"name":"hzk","obj":{"in":"ac"},"arr":[1,2,3]}

{"in":"ac"} 是一个嵌套的JSON对象。
[1,2,3] 是一个数组，可通过 [数组序号] 取值（从0开始）。

这是一个JSON,我们要取得里面的数据,就要用JSON解析

$JSON€(JSON)€[键]€$
$JSON长度€%c%$

这个返回数组的长度,因为是从0开始,所以[1,2,3]的长度为2

JSON解析示例：

a:{"name":"hzk","obj":{"in":"ac"},"arr":[1,2,3]}
$JSON€%a%€[name]$\r
$JSON€%a%€[obj][in]$\r
//上面这个相当于解析了两次
$JSON€%a%€[arr][数组1]$
c:$JSON€%a%€[arr]$
$JSON长度€%c%$

机器人回复：

hzk
ac
2
2

JSON数组类型：

[1,2,3]：数字数组（常见）
["abc","def","ggg"]：字符串数组（常见）
[null,null,null]：空值数组（不常见）
[true,false,true]：布尔数组（不常见）
[{"a":1},{"b":2},{"c":3}]：对象数组（常见）
假如你要储存一个人物信息,你可以这么写：
```
[{"姓名":""}]
```

示例请求

示例请求是给API链接带上参数的一个例子。如何带参数？例如：

?sort=二次元&format=json

? 表示开始提交参数。
sort 是参数名，二次元 是值。
& 用于并列多个参数。
最终得到：?sort=二次元&format=json

如果API返回格式为图片，在x6中可直接使用：

±img=图片API地址±

最后是接口作者和相关信息。本站无偿接受正常API源码投稿，若对本站有价值，站长将收录本API，作者可留下名字和相关信息。若无人投稿，则默认为本站信息。

API请求参数

此板块包含一份表格，含四列：

名称	类型	必填	备注
参数名	参数类型	是/否	参数用途说明

常用参数类型：

字符串（String）：文字类，如名字、手机号。
整数（Int）：无小数点的数，如用户ID、数量。
布尔（Boolean）：true/false，如是否勾选。
数组（Array）：同一类数据的列表，如多个商品ID。
对象（Object）：一组相关信息，如包含ID、名字、年龄的用户信息。

API输出参数

此板块包含一份表格，含三列：

名称	类型	内容
输出参数名	参数类型	参数解释

API输出示例

此板块包含一个代码框，展示API输出示例。请注意：示例不代表最终结果，本站API可能随时改动。有时输出示例（包括请求参数与返回参数表格）并非真实输出，而是其他内容。

API使用教程

说明