快速开始

欢迎使用 SteamData Connect API！本指南将帮助您在几分钟内开始使用我们的 API。

前置条件

在开始之前，您需要：

  • 一个 SteamData 账号
  • 创建一个团队
  • 生成 API 密钥

第一步：创建 API 密钥

  1. 登录到您的 Dashboard
  2. 选择或创建一个团队
  3. 进入团队管理页面，点击 "Connect API" 标签
  4. 点击 "创建密钥" 按钮
  5. 为密钥设置一个易于识别的名称（如 "生产环境" 或 "测试环境"）
  6. 创建后，立即复制并保存您的 API 密钥（密钥仅显示一次）

重要提示：请妥善保管您的 API 密钥，不要将其提交到代码仓库或公开分享。

第二步：发送您的第一个请求

使用您的 API 密钥，您可以开始调用我们的 API。以下是一个简单的示例：

获取游戏详情

curl -X GET "https://endpoint.steamdata.ai/api/v1/apps/1938090" \
  -H "X-API-Key: your_api_key_here"

响应示例

{
  "app_id": 1938090,
  "name": "Call of Duty®: Black Ops 6",
  "type": "game",
  "release_date": "2024-10-25",
  "publishers": ["Activision"],
  "developers": ["Treyarch"],
  "categories": ["Multi-player", "Single-player"],
  "genres": ["Action", "Adventure"]
}

第三步：身份认证

所有 API 请求都需要在请求头中包含您的 API 密钥：

X-API-Key: your_api_key_here

认证示例

cURL:

curl -H "X-API-Key: your_api_key_here" \
  https://endpoint.steamdata.ai/api/v1/apps/1938090

Python:

import requests

headers = {
    'X-API-Key': 'your_api_key_here'
}

response = requests.get(
    'https://endpoint.steamdata.ai/api/v1/apps/1938090',
    headers=headers
)

print(response.json())

JavaScript (Node.js):

const axios = require('axios');

const headers = {
  'X-API-Key': 'your_api_key_here'
};

axios.get('https://endpoint.steamdata.ai/api/v1/apps/1938090', { headers })
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.error('Error:', error);
  });

API 配额

每个 API 密钥都有使用配额限制：

  • 免费套餐：每月 10,000 次请求
  • 标准套餐：每月 100,000 次请求
  • 企业套餐：自定义配额

您可以在 Dashboard 的 "Connect API" 页面查看当前的配额使用情况。

错误处理

API 使用标准的 HTTP 状态码来指示请求结果：

状态码说明
200请求成功
400请求参数错误
401API 密钥无效或未提供
403权限不足或配额已用尽
404资源不存在
429请求过于频繁（速率限制）
500服务器内部错误

错误响应示例

{
  "error": {
    "code": "invalid_api_key",
    "message": "The provided API key is invalid",
    "status": 401
  }
}

速率限制

为了保证服务质量，API 实施了速率限制：

  • 每秒最多 10 个请求
  • 超出限制时返回 429 状态码
  • 请求头中包含速率限制信息：
    • X-RateLimit-Limit: 速率限制总数
    • X-RateLimit-Remaining: 剩余请求数
    • X-RateLimit-Reset: 限制重置时间戳

语言参数

许多 API 端点支持 language 参数来获取不同语言的数据。我们支持三种格式：

  • 标准名称：如 English, Chinese (Simplified), Japanese（推荐）
  • BCP 47 语言码：如 en-US, zh-CN, ja-JP
  • Steam API 码：如 english, schinese, japanese

示例：获取简体中文游戏信息

curl -X GET "https://endpoint.steamdata.ai/api/v1/apps/1938090/localized?language=Chinese%20(Simplified)" \
  -H "X-API-Key: your_api_key_here"

详细说明： 查看语言参数规范了解完整的语言映射表和使用说明。

下一步

现在您已经了解了基础知识，可以继续探索：

获取帮助

如果您在使用过程中遇到问题，可以：

祝您使用愉快！🚀