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	レート制限	1日のリクエスト制限を超えました。