基于 Misskey 平台的周边生态开发 #

限制与使用规约 #

我们开放 API 的使用权限，允许本站注册用户在遵守合理使用规约的情况下适度使用本站的 API ，以进一步提升使用体验。

出于对整个联邦宇宙的资源合理利用原则，您不应当使用自动化程式高频执行任何意义上的操作，包括但不仅限于关注与取消关注、发送贴文、发送消息、搜索、获取数据等。站点使用 CloudFlare 进行保护，Misskey 本身也自带一套 API 速率限制的设置，请避免行为因请求过于频繁而遭到系统的保护性限制。

另外，出于提高辨识度的考虑，如果是只用于 bot 功能的账号，推荐您开启账号中的 bot 标记。

无论出于何种原因，如果您的账号出现了违反服务条款的行为，您都需要承担相应的责任。

Misskey 的授权模式 #

请参见 Misskey 的授权模式

使用 API Token #

以获取当前用户信息为例，使用的 API 地址为 /api/i 。

该接口为使用 POST 方式提交 json 数据，请注意设置请求头中的 Content-Type 为 application/json ，以避免 HTTP 415 错误。

该接口需要传入的请求体为：

{
  "i": "API Token"
}

返回结果的格式也是 JSON 。

当 API Token 正确时，会返回一个包含用户信息的 Object 。

文档与 SDK #

Misskey 有内置的文档系统，可以在 /api-doc 访问得到，不过请注意不同版本的请求接口可能会有些许变更，当之前的代码不再可用时您可以先尝试排查是否是由站点的版本升级导致。

Misskey 官方提供了 JavaScript / TypeScript 使用的 SDK misskey.js ，您可以直接使用。

另外，本站有时也会有一些我们开发的工具代码（如用于周边服务账号管理的 bot 程式），您可以在 GitHub/nyaone 得到参考。