Flute API Documentation
This is the API documentation for Flute CMS.
⚠️
To use the API, you need to install a separate module Flute CMS API .
Contents
- Base endpoints - basic endpoints and API status information
- Users - user management
- Roles - user role management
- Permissions - permission management
- API Keys - API key management
- Pages - page management
- Servers - server management
- Currencies - currency management
- Payment Gateways - payment gateway management
- Payment Invoices - payment invoice management
- Navigation Items - navigation bar item management
- Social Networks - social network management
Authentication
To access the API, you need to use an API key, which is passed in the X-API-Key
header.
X-API-Key: your-api-key
Each API key has specific permissions that limit access to various API endpoints.
Errors
When errors occur, the API returns the appropriate HTTP response code and a JSON object with an error description.
{
"error": {
"code": "invalid_api_key",
"message": "Invalid API key"
}
}
Versioning
Current API version: 1.0.0
To check the API version, you can use the /api/status
endpoint.