使用指南

从入门到精通的完整教程

第一步：创建账户

访问注册页面，填写您的电子邮件地址和密码
验证您的电子邮件地址
完成账户设置，包括公司信息和账单地址
添加付款方式以开始使用服务

提示： 注册后您将获得免费额度，可以立即开始测试我们的服务。

第二步：获取API密钥

API密钥是访问我们服务的凭证，请妥善保管：

登录控制台，进入"账户设置"页面
点击"用户和API密钥"标签
点击"创建新密钥"按钮
为密钥添加描述（例如"生产环境"或"测试环境"）
复制并保存生成的API密钥（密钥只显示一次）

重要： API密钥具有完全访问权限，请不要在公共代码库或客户端代码中暴露它。

第三步：首次API调用

让我们进行第一次API调用来测试连接：

使用curl测试

curl -X POST https://api.aoxsi.com/api/ai/translate \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Hello",
    "sourceLang": "english",
    "targetLang": "chinese"
  }'

预期响应

{
  "success": true,
  "data": {
    "translatedText": "你好",
    "model": "translation-model-v1"
  }
}

提示： 如果收到错误响应，请检查API密钥是否正确，以及请求格式是否符合文档要求。

第四步：集成到应用

Node.js集成示例

// 安装axios
// npm install axios

const axios = require('axios');

const API_KEY = process.env.AOXSI_API_KEY;
const BASE_URL = 'https://api.aoxsi.com';

async function translateText(text, sourceLang, targetLang) {
  try {
    const response = await axios.post(
      `${BASE_URL}/api/ai/translate`,
      {
        text,
        sourceLang,
        targetLang
      },
      {
        headers: {
          'Authorization': `Bearer ${API_KEY}`,
          'Content-Type': 'application/json'
        }
      }
    );
    
    return response.data.data.translatedText;
  } catch (error) {
    console.error('Translation error:', error.response?.data);
    throw error;
  }
}

// 使用示例
translateText('Hello, world!', 'english', 'chinese')
  .then(result => console.log(result))
  .catch(error => console.error(error));

Python集成示例

# 安装requests
# pip install requests

import os
import requests

API_KEY = os.getenv('AOXSI_API_KEY')
BASE_URL = 'https://api.aoxsi.com'

def translate_text(text, source_lang, target_lang):
    url = f'{BASE_URL}/api/ai/translate'
    headers = {
        'Authorization': f'Bearer {API_KEY}',
        'Content-Type': 'application/json'
    }
    data = {
        'text': text,
        'sourceLang': source_lang,
        'targetLang': target_lang
    }
    
    try:
        response = requests.post(url, json=data, headers=headers)
        response.raise_for_status()
        return response.json()['data']['translatedText']
    except requests.exceptions.RequestException as e:
        print(f'Translation error: {e}')
        raise

# 使用示例
result = translate_text('Hello, world!', 'english', 'chinese')
print(result)

第五步：监控使用情况

在控制台中监控您的API使用情况：

访问控制台的"概览"页面查看实时统计
查看API调用次数、成功率和错误率
监控账户余额和本月消费
查看详细的调用日志和错误信息
设置使用量警报，避免超出预算

高级功能

批量处理

对于大量文本的处理，可以使用批量API：

// 批量翻译示例
const texts = [
  "Hello",
  "Good morning",
  "Thank you"
];

const promises = texts.map(text => 
  translateText(text, 'english', 'chinese')
);

const results = await Promise.all(promises);
console.log(results);

错误重试

实现自动重试机制以提高可靠性：

async function translateWithRetry(text, sourceLang, targetLang, maxRetries = 3) {
  for (let i = 0; i < maxRetries; i++) {
    try {
      return await translateText(text, sourceLang, targetLang);
    } catch (error) {
      if (i === maxRetries - 1) throw error;
      
      // 指数退避
      const delay = Math.pow(2, i) * 1000;
      await new Promise(resolve => setTimeout(resolve, delay));
    }
  }
}

缓存策略

对于重复的请求，使用缓存可以节省成本：

const cache = new Map();

async function translateWithCache(text, sourceLang, targetLang) {
  const cacheKey = `${text}:${sourceLang}:${targetLang}`;
  
  if (cache.has(cacheKey)) {
    return cache.get(cacheKey);
  }
  
  const result = await translateText(text, sourceLang, targetLang);
  cache.set(cacheKey, result);
  
  return result;
}

故障排除

常见问题

401 未授权错误

检查API密钥是否正确
确认Authorization头格式为 "Bearer YOUR_API_KEY"
验证API密钥是否已过期或被删除

400 请求错误

检查请求参数是否完整
确认Content-Type为application/json
验证JSON格式是否正确

429 速率限制

实现请求队列和速率限制
考虑升级到更高的计划
使用缓存减少重复请求

503 服务不可用

实现自动重试机制
使用指数退避策略
检查系统状态页面

下一步

现在您已经掌握了基础知识，可以：

查看完整的API文档了解所有可用功能
阅读最佳实践指南优化您的集成
探索高级功能如批量处理和流式响应
加入我们的开发者社区获取支持