Skip to main content

API Reference and Rate Limiting

Authentication Methods

ORBEXA supports three authentication methods:

API Key Authentication

Used for MCP tool calls and API access:
API keys are automatically generated when a merchant connects, and can also be created and managed manually in the console.

OAuth Authentication

Used for platform integrations such as Shopify, following the standard OAuth 2.0 flow.

Plugin Header Authentication

Used for WordPress plugin integration, requiring the following headers:
  • X-Plugin-Platform — Platform identifier
  • X-Plugin-Version — Plugin version number

Complete Endpoint Catalog

UCP Endpoints

ACP Endpoints — JSON-RPC 2.0

ACP Endpoints — REST

MCP Endpoints

Discovery Endpoints

OTR Endpoints

Shopify Integration

WooCommerce Integration

WordPress Integration

Rate Limiting Policies

ORBEXA enforces tiered rate limiting to ensure fair usage and platform stability: When rate limits are exceeded, the API returns HTTP 429 status codes. Clients should implement exponential backoff retry strategies.

Error Handling

Rate Limit Errors

When a request exceeds the rate limit, the API returns HTTP 429 status code:
The retry_after field indicates the number of seconds the client should wait before retrying.

Authentication Errors

General Errors

Summary

ORBEXA provides a comprehensive API endpoint system covering the three major protocols (UCP/ACP/MCP), OTR trust queries, three platform integrations, and discovery endpoints. The rate limiting system applies tiered policies by endpoint type to ensure fair usage and platform stability.
Next chapter: Merchant Dashboard — KPI monitoring, integration management, data quality, and team permissions