SocialBoost API 文档

欢迎使用 SocialBoost API,通过我们的 API,您可以将 SocialBoost 的全部功能无缝集成到您自己的应用程序中。本文档提供了详细的 API 说明、示例代码和最佳实践指南,帮助您快速开始集成。

开始使用 SocialBoost API

要使用我们的 API,您需要先购买 API 访问权限并获取专属 API 密钥

¥150,000 起

API 访问包括企业级技术支持、专属服务器资源和自定义集成方案

立即联系我们

基本信息

SocialBoost API 是一个基于 RESTful 原则设计的 HTTP API。所有请求和响应均使用 JSON 格式,API 端点已针对高性能和低延迟进行了优化。

API 基础 URL

https://api.socialboost.com/v1

API 版本

当前 API 版本为 v1。我们建议在请求 URL 中明确指定 API 版本,以确保向后兼容性。

请求格式

所有 POST 和 PUT 请求的请求体应采用 JSON 格式,并设置相应的 Content-Type 头。

Content-Type: application/json

认证

SocialBoost API 使用 API 密钥进行认证。每个请求都必须包含您的 API 密钥,以便我们验证您的身份并授权访问。

API 密钥

您可以在购买 API 访问权限后,在账户仪表板中获取您的 API 密钥。API 密钥应该通过 HTTP 请求头进行传递:

X-API-Key: your_api_key_here
GET /auth/verify

验证 API 密钥是否有效,并返回相关的账户信息和权限级别。

请求参数

无需请求参数。请在请求头中包含 API 密钥。

响应示例

200 成功
401 未授权
{
  "status": "success",
  "data": {
    "account_id": "acc_12345",
    "email": "company@example.com",
    "plan": "enterprise",
    "rate_limit": 100,
    "permissions": ["read", "write", "admin"],
    "created_at": "2023-01-15T09:30:00Z",
    "expires_at": "2024-01-15T09:30:00Z"
  }
}
{
  "status": "error",
  "code": "unauthorized",
  "message": "Invalid API key provided"
}

速率限制

为了保护 API 不被滥用并确保所有客户的服务质量,我们对 API 请求施加了速率限制。限制取决于您的账户级别:

  • 标准 API 计划:每分钟 60 个请求
  • 高级 API 计划:每分钟 180 个请求
  • 企业 API 计划:每分钟 500 个请求

当超过速率限制时,API 会返回 HTTP 429 状态码(Too Many Requests)。每个响应都包含以下标头,以帮助您跟踪您的限制使用情况:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1623456789