接入指南
开始接入
选择公开查询、个人令牌、开放平台或机器人事件,完成第一次请求。
NexusMC 提供公开内容、个人 API 与开放平台映射,并提供机器人事件、精简资源 v1 和 Webhook 管理参考。先按使用场景选择,再查看每个操作的参数和响应。
| 你要做什么 | 从哪里开始 |
|---|---|
| 读取公开资源和帖子 | 公开内容 API,无需令牌 |
| 为自己的脚本读写内容 | 个人令牌指南与个人 API |
| 接收机器人私信和房间指令 | 机器人账号接入与事件消费指南 |
| 让其他用户授权你的应用 | 开放平台指南与OAuth API |
本地独立 API 的默认地址是 http://127.0.0.1:4520。部署时以接口参考中的服务器地址为准。示例请求从公开内容开始:
curl --get 'http://127.0.0.1:4520/v1/site/search' \
--data-urlencode 'q=性能' \
--data-urlencode 'entity=resource' \
--data-urlencode 'loader=fabric' \
--data-urlencode 'mc=1.20.1' \
--data-urlencode 'limit=10'
同一个查询在 TypeScript 中使用内置 fetch,不需要安装 SDK:
type SearchResult = {
hits: { entityType: string; entityId: string; title: string; slug: string }[]
nextCursor: string | null
hasMore: boolean
scanBudgetExhausted: boolean
}
const url = new URL('/v1/site/search', 'http://127.0.0.1:4520')
url.search = new URLSearchParams({
q: '性能', entity: 'resource', loader: 'fabric', mc: '1.20.1', limit: '10',
}).toString()
const response = await fetch(url)
if (!response.ok) throw new Error(`查询失败:${response.status} ${await response.text()}`)
const result = await response.json() as SearchResult
console.log(result.hits)
// 有 nextCursor 时,将它作为 cursor 参数继续请求;保持其他条件一致。
打开具体接口后,可在请求示例中选择语言与 HTTP 客户端。默认 Fetch 示例可用于 TypeScript;切换到 Shell/Curl 可复制命令行请求。点击“测试请求”可打开调试工具,填写参数后手动发送。这些示例直接使用标准 HTTP API,无需安装客户端库。
搜索服务暂不可用时会返回 503;示例数据与 ID 只说明响应结构,不代表你的部署已经有这些内容。
公开查询只代表这份参考中列出的匿名接口。其他站点路由不会因为公开查询可用,就自动接受机器 Bearer 凭据。