API Documentation
General Information
This documentation describes the API for interacting with a CMS system that allows you to work with collections and pages.
The API is versioned, with v1 being the current and only version available.
API Version
All endpoints include version information in the path. Currently, only v1 is available.
Authentication
All API requests require authentication using an API key, with one exception: image delivery is public, because an <img src> cannot carry credentials.
Headers
| Name | Example | Required | Description |
|---|---|---|---|
| Authorization | ApiKey 90fe18da335cdfeb9a3a0a5fc07435f40d4542c7d157154e66550802d79bf200 | Conditional | Required on every request except image delivery, which is public. Format: ApiKey YOUR_API_KEY |
Common URL Parameters
| Name | Example | Possible values | Description |
|---|---|---|---|
| version | v1 | v1 | The API version. Currently, only v1 is available. |
| cmsName | main | main | The system is designed to support multiple CMS instances for each customer, but in the current implementation, there is 1 deployment - 1 CMS: "main". In the admin panel URL: front/{cmsName}/collections/books |
| typeModel | pages | collections/pages | Specifies what type of data we want to retrieve. Use "pages" for page data or "collections" for collection data. In the admin panel URL: front/main/{typeModel}/books |
| model | books | - | The name of the model in the database. In the admin panel URL: front/main/collections/{model} |
Swagger Documentation
For interactive work with the API, Swagger documentation is available:
- General API documentation:
https://flexim.io/api/v1/{spaceName}/docs
The Swagger interface allows you to:
- Explore all available endpoints
- Test requests with various parameters
- See current data structures for your specific CMS