v3.0.0

API 文档

集成 Alyachan API 服务的完整指南。通过安全且可扩展的 RESTful 标准访问 AI 端点、媒体下载器和数据工具。

01 — 入门

账户设置

访问 API 端点需要经过验证的账户。我们提供灵活的注册选项（电子邮件、Google、Discord）以加快您的集成过程。

API 密钥管理

登录后，导航到账户仪表板中的 "API KEY" 选项卡。此密钥是您应用程序的秘密凭据。

◦ 要获取您的 API 密钥，请按 "复制" 按钮

切勿在客户端代码或公共存储库中共享您的 API 密钥。

◦ 要更改您的 API 密钥，请按 "生成密钥" 按钮，然后按 "更新密钥" 按钮

IP 白名单订阅计划

安全功能，仅限从注册的服务器 IP 地址访问 API 密钥。在使用 API 密钥之前，您必须设置 IP

静态 IP： 手动注册生产服务器 IP。
允许所有： 如果服务器使用动态 IP，请选中此选项（不建议用于生产环境）。

02 — 集成

库安装

官方 SDK

npm install @alyachan/api

通用 HTTP

npm install axios

使用示例

要获取/搜索端点，请访问 API 参考

主服务器 : https://api.alyachan.dev

备用服务器 :

https://api-v2.alyachan.dev

index.js (SDK)推荐

const AlyaApi = require('@alyachan/api').default
const Api = AlyaApi('https://api.alyachan.dev/api', 'sk_prod_xxxxxxxx')

async function main() {
  try {
    const res = await Api.post('/ai/text2img', {
      'prompt': 'Cyberpunk city',
      'models': 'Japanese'
    })
    console.log(res)
  } catch (e) {
    console.error(e)
  }
}

request.js (Axios) POST

const axios = require('axios')

const config = {
  'method': 'POST',
  'url': 'https://api.alyachan.dev/api/ai/text2img',
  'headers': {
    'Authorization': 'Bearer sk_prod_xxxxxxxx',
    'Content-Type': 'application/json'
  },
  'data': { 'prompt': 'Cyberpunk city', 'models': 'Japanese' }
}

axios(config)
  .then(r => console.log(r.data))
  .catch(e => console.error(e))

标准响应

代码	含义	描述
200	OK	请求成功处理。
400	错误请求	输入参数不正确或缺失。
401	未授权	API 密钥无效或未提供。
429	速率限制	超出每日请求限制。