Skip to main content

API参考与限速

认证方式

ORBEXA支持三种认证方式:

API密钥认证

适用于MCP工具调用和API访问:
API密钥在商家接入时自动生成,也可在控制台手动创建和管理。

OAuth认证

适用于Shopify等平台集成,遵循标准OAuth 2.0流程。

插件Header认证

适用于WordPress插件接入,需要携带必需Header:
  • X-Plugin-Platform — 平台标识
  • X-Plugin-Version — 插件版本号

完整端点清单

UCP端点

ACP端点 — JSON-RPC 2.0

ACP端点 — REST

MCP端点

发现端点

OTR端点

Shopify集成

WooCommerce集成

WordPress集成

限速策略

ORBEXA对所有端点实施分层限速,确保公平使用和平台稳定性: 超过限速后,API返回HTTP 429状态码。客户端应实现指数退避重试策略。

错误处理

限速错误

当请求超过限速时,API返回HTTP 429状态码:
retry_after字段指示客户端应等待的秒数。

认证错误

通用错误

小结

ORBEXA提供完整的API端点体系,覆盖UCP/ACP/MCP三大协议、OTR信任查询、三种平台集成和发现端点。限速系统按端点类型分级保护,确保公平使用和平台稳定性。
下一章:商家控制台 — KPI监控、集成管理、数据质量和团队权限