公開情報モジュール¶

機能説明

インターフェースのプレフィックスは http(s)://<your-domain> に統一されています。

本番環境では認証トークンを保護するために HTTPS を使用する必要があります。HTTP は開発環境でのみ推奨されます。

認証不要または低権限でアクセス可能なシステム情報（モデルリスト、価格設定情報、お知らせ内容など）を提供します。多言語表示と動的設定をサポートしています。フロントエンドのホームページやモデル広場は、主にこれらのインターフェースに依存して表示データを取得します。

🔐 認証不要¶

お知らせ内容の取得¶

インターフェース名：お知らせ内容の取得
HTTP メソッド：GET
パス：/api/notice
認証要件：公開
機能概要：システムのお知らせ内容を取得します（Markdown形式をサポート）。

💡 リクエスト例：

const response = await fetch('/api/notice', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json'  
  }  
});  
const data = await response.json();

✅ 成功応答例：

{  
  "success": true,  
  "message": "",  
  "data": "# 系统公告\n\n欢迎使用New API系统！"  
}

❗ 失敗応答例：

{  
  "success": false,  
  "message": "获取公告失败"  
}

🧾 フィールド説明：

data （文字列）: お知らせ内容（Markdown形式をサポート）

アバウトページ情報¶

インターフェース名：アバウトページ情報
HTTP メソッド：GET
パス：/api/about
認証要件：公開
機能概要：アバウトページのカスタムコンテンツを取得します。

💡 リクエスト例：

const response = await fetch('/api/about', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json'  
  }  
});  
const data = await response.json();

✅ 成功応答例：

{  
  "success": true,  
  "message": "",  
  "data": "# 关于我们\n\nNew API是一个强大的AI网关系统..."  
}

❗ 失敗応答例：

{  
  "success": false,  
  "message": "获取关于信息失败"  
}

🧾 フィールド説明：

data （文字列）: アバウトページの内容（Markdown形式またはURLリンクをサポート）

ホームページのカスタムコンテンツ¶

インターフェース名：ホームページのカスタムコンテンツ
HTTP メソッド：GET
パス：/api/home_page_content
認証要件：公開
機能概要：ホームページのカスタムコンテンツを取得します（Markdownテキストまたは iframe URL のいずれか）。

💡 リクエスト例：

const response = await fetch('/api/home_page_content', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json'  
  }  
});  
const data = await response.json();

✅ 成功応答例：

{  
  "success": true,  
  "message": "",  
  "data": "# 欢迎使用New API\n\n这是一个功能强大的AI网关系统..."  
}

❗ 失敗応答例：

{  
  "success": false,  
  "message": "获取首页内容失败"  
}

🧾 フィールド説明：

data （文字列）: ホームページの内容（Markdownテキスト、または"https://"で始まるURLリンクのいずれか）

モデル倍率設定¶

インターフェース名：モデル倍率設定
HTTP メソッド：GET
パス：/api/ratio_config
認証要件：公開
機能概要：公開されているモデルの倍率設定情報を取得します（アップストリームシステムとの同期に使用）。

💡 リクエスト例：

const response = await fetch('/api/ratio_config', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json'  
  }  
});  
const data = await response.json();

✅ 成功応答例：

{  
  "success": true,  
  "data": {  
    "model_ratio": {  
      "gpt-3.5-turbo": 1.0,  
      "gpt-4": 15.0,  
      "claude-3-sonnet": 3.0  
    },  
    "completion_ratio": {  
      "gpt-3.5-turbo": 1.0,  
      "gpt-4": 1.0  
    },  
    "model_price": {  
      "gpt-3.5-turbo-instruct": 0.002  
    }  
  }  
}

❗ 失敗応答例：

{  
  "success": false,  
  "message": "获取倍率配置失败"  
}

🧾 フィールド説明：

data （オブジェクト）: 倍率設定情報

model_ratio （オブジェクト）: モデル倍率マッピング（キーはモデル名、値は倍率の数値）
completion_ratio （オブジェクト）: 補完倍率マッピング
model_price （オブジェクト）: モデル価格マッピング（キーはモデル名、値は価格（米ドル））

価格とプラン情報¶

インターフェース名：価格とプラン情報
HTTP メソッド：GET
パス：/api/pricing
認証要件：匿名/ユーザー可能
機能概要：モデルの価格設定情報、グループ倍率、および利用可能なグループを取得します。

💡 リクエスト例：

const response = await fetch('/api/pricing', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_token', // 可选，登录用户可获得更详细信息
    'New-Api-User': 'your_user_id' // 可选
  }  
});  
const data = await response.json();

✅ 成功応答例：

{  
  "success": true,  
  "data": [  
    {  
      "model_name": "gpt-3.5-turbo",  
      "enable_group": ["default", "vip"],  
      "model_ratio": 1.0,  
      "completion_ratio": 1.0,  
      "model_price": 0.002,  
      "quota_type": 1,  
      "description": "GPT-3.5 Turbo模型",  
      "vendor_id": 1,  
      "supported_endpoint_types": [1, 2]  
    }  
  ],  
  "vendors": [  
    {  
      "id": 1,  
      "name": "OpenAI",  
      "description": "OpenAI官方模型",  
      "icon": "openai.png"  
    }  
  ],  
  "group_ratio": {  
    "default": 1.0,  
    "vip": 0.8  
  },  
  "usable_group": {  
    "default": "默认分组",  
    "vip": "VIP分组"  
  },  
  "supported_endpoint": {  
    "1": {"method": "POST", "path": "/v1/chat/completions"},  
    "2": {"method": "POST", "path": "/v1/embeddings"}  
  },  
  "auto_groups": ["default"]  
}

❗ 失敗応答例：

{  
  "success": false,  
  "message": "获取定价信息失败"  
}

🧾 フィールド説明：

data （配列）: モデル価格設定情報リスト
- model_name （文字列）: モデル名
- enable_group （配列）: 利用可能グループのリスト
- model_ratio （数値）: モデル倍率
- completion_ratio （数値）: 補完倍率
- model_price （数値）: モデル価格（米ドル）
- quota_type （数値）: 課金タイプ。0=倍率課金、1=価格課金
- description （文字列）: モデルの説明
- vendor_id （数値）: ベンダー ID
- supported_endpoint_types （配列）: サポートされているエンドポイントタイプ
- vendors （配列）: ベンダー情報リスト
- id （数値）: ベンダー ID
- name （文字列）: ベンダー名
- description （文字列）: ベンダーの説明
- icon （文字列）: ベンダーアイコン
- group_ratio （オブジェクト）: グループ倍率マッピング
- usable_group （オブジェクト）: 利用可能グループマッピング
- supported_endpoint （オブジェクト）: サポートされているエンドポイント情報
- auto_groups （配列）: 自動グループリスト

🔐 ユーザー認証¶

フロントエンドで利用可能なモデルリストの取得¶

インターフェース名：フロントエンドで利用可能なモデルリストの取得
HTTP メソッド：GET
パス：/api/models
認証要件：ユーザー
機能概要：現在のユーザーがアクセス可能な AI モデルのリストを取得します（フロントエンドのダッシュボード表示に使用）。

💡 リクエスト例：

const response = await fetch('/api/models', {  
  method: 'GET',  
  headers: {  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'your_user_id'
  }  
});  
const data = await response.json();

✅ 成功応答例：

{  
  "success": true,  
  "data": {  
    "1": ["gpt-3.5-turbo", "gpt-4"],  
    "2": ["claude-3-sonnet", "claude-3-haiku"]  
  }  
}

❗ 失敗応答例：

{  
  "success": false,  
  "message": "未授权访问"  
}

🧾 フィールド説明：

data （オブジェクト）: チャネル ID からモデルリストへのマッピング

キー（文字列）: チャネル ID
値（配列）: 当該チャネルがサポートするモデル名のリスト