Introduction
API Overview
Overview of the Synoveo REST API
The Synoveo API is organized around REST principles.
Request Format
Headers
Authorization: Bearer <token>
Content-Type: application/json
X-Idempotency-Key: <unique-key> // For POST/PATCHBase URL
https://api.synoveo.com/api/v1Response Format
Success Response
{
"status": "ok",
"data": {
// Response data
}
}Error Response
{
"status": "error",
"error": {
"code": "ERROR_CODE",
"message": "Human readable message",
"details": "Additional context"
}
}HTTP Methods
| Method | Usage |
|---|---|
| GET | Retrieve resources |
| POST | Create resources |
| PATCH | Update resources |
| DELETE | Remove resources |
Authentication
The API supports two authentication methods:
JWT Tokens
For user sessions (dashboard, web apps).
API Keys
For server-to-server communication (WordPress plugin, custom integrations).
Authentication Details
Rate Limiting
Requests are rate limited per plan:
| Plan | Requests/Hour |
|---|---|
| Lite | 100 |
| Solo | 500 |
| Pro | 2000 |
| Business | 10000 |