Elimapi

API 身份验证参考

概述

Elimapi 支持两种身份验证方法。每个 API 请求都必须在请求头中包含身份验证信息。

方法请求头适用场景会话管理
访问令牌 (JWT)Authorization: Bearer <token>有用户界面的应用定期登录，令牌有时效性
API 密钥x-api-key: <key>服务器到服务器的集成无需，密钥与账户绑定

分步指南：对 API 请求进行身份验证

身份验证端点

端点方法描述身份验证
/v1/auth/loginPOST使用邮箱 + 密码登录，返回 access_token 和 refresh_token否
/v1/auth/refreshPOST使用刷新令牌（请求头 authorization）刷新访问令牌是
/v1/auth/change-passwordPOST为当前登录用户修改密码是
/v1/me/plan-statusGET查看套餐状态：有效期、剩余配额、积分余额是

登录请求体：

{
  "email": "[email protected]",
  "password": "password"
}

登录响应： { user, access_token, expires_in, refresh_token } — expires_in 为令牌过期的毫秒时间戳。

必需请求头

请求头值
Content-Typeapplication/json
Acceptapplication/json
Authorization 或 x-api-keyBearer <token> 或 <api_key>

配额与限制 (Quotas & Limits)

  • 订阅套餐 (Subscription)： 如果套餐（Free、Individual、Team、Enterprise）过期，API 请求将被拒绝。
  • 使用配额 (Usage Quota)： 每个成功请求都会从套餐的当月总量中扣减。
  • 积分 (Credits)： 套餐配额用尽后，系统自动从 Credits 余额中扣减（如有）。
  • 速率限制 (Rate Limit)： 限制 API 调用速度，以确保系统稳定。

通过 GET /v1/me/plan-status 或控制台查看当前配额。

常见错误码

错误码含义处理方法
401 Unauthorized令牌或 API 密钥缺失、错误或已过期检查请求头 Authorization 或 x-api-key
403 Forbidden账户被锁定或权限不足在控制台检查账户状态
429 Too Many Requests超过速率限制降低调用频率或升级套餐
400 Bad Request配额用尽且没有剩余积分升级套餐或购买更多积分

相关链接