Skip to Content
API ReferenceFlute API Documentation

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

  1. Base endpoints - basic endpoints and API status information
  2. Users - user management
  3. Roles - user role management
  4. Permissions - permission management
  5. API Keys - API key management
  6. Pages - page management
  7. Servers - server management
  8. Currencies - currency management
  9. Payment Gateways - payment gateway management
  10. Payment Invoices - payment invoice management
  11. Navigation Items - navigation bar item management
  12. 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.