Flotiq

beginner

API-first headless CMS with OpenAPI support.

Overview

Flotiq is a SaaS-based headless CMS that prioritizes API-first architecture and automatic OpenAPI 3.0 specification generation. Originally designed as a cloud-native content management platform, Flotiq eliminates the traditional frontend layer and instead provides robust REST APIs for content delivery to any application or framework. The platform automatically generates comprehensive API documentation and SDKs in multiple programming languages including JavaScript, PHP, Python, and others based on your content schema definition. This Docker configuration provides a local development interface for Flotiq, connecting to their cloud infrastructure through API authentication. The setup creates a local proxy environment that mirrors your Flotiq workspace, enabling developers to work with content types, manage API schemas, and test webhook integrations without constantly switching between local development and the Flotiq web interface. The containerized approach ensures consistent API interaction patterns across different development environments. Development teams building modern JAMstack applications, mobile applications, or multi-channel content distribution systems will find this setup particularly valuable. Frontend developers working with React, Vue, Angular, or static site generators like Gatsby and Next.js can leverage the local Flotiq interface for rapid content modeling and API testing. The automatic SDK generation and OpenAPI specification make this stack ideal for teams that need to maintain consistent API contracts across multiple applications or microservices.

Key Features

Automatic OpenAPI 3.0 specification generation based on custom content type definitions
Real-time SDK generation for JavaScript, PHP, Python, and additional programming languages
Webhook system for triggering external integrations when content changes occur
Content Type Designer with visual schema building and field validation rules
Built-in media management with automatic image resizing and CDN distribution
GraphQL query interface alongside traditional REST API endpoints
Role-based access control with granular permissions for different content types
Content scheduling and workflow management for editorial teams

Common Use Cases

1JAMstack websites requiring headless content management with automatic static site regeneration
2Mobile application backends needing structured content delivery with offline sync capabilities
3Multi-brand websites sharing content types but requiring separate content instances
4E-commerce platforms needing product catalog management with inventory tracking APIs
5Corporate intranets requiring content approval workflows and role-based publishing
6Marketing automation platforms consuming content via webhooks for email campaigns
7Digital signage systems pulling dynamic content through scheduled API calls

Prerequisites

Valid Flotiq account with API key from https://editor.flotiq.com
Minimum 512MB RAM allocation for the local development container
Port 3000 available on the host system for the Flotiq development interface
Internet connectivity required as Flotiq operates primarily as a SaaS platform
Basic understanding of REST APIs and content modeling concepts
Docker Engine 20.10+ and Docker Compose 2.0+ for container orchestration

For development & testing. Review security settings, change default credentials, and test thoroughly before production use. See Terms

docker-compose.yml

1services: 
2  flotiq: 
3    image: flotiq/flotiq:latest
4    container_name: flotiq
5    restart: unless-stopped
6    environment: 
7      FLOTIQ_API_KEY: ${API_KEY}
8    ports: 
9      - "3000:3000"
10    networks: 
11      - flotiq-network
12
13networks: 
14  flotiq-network: 
15    driver: bridge

.env Template

.env

1API_KEY=your-api-key

Usage Notes

1Docs: https://flotiq.com/docs/
2Access at http://localhost:3000
3OpenAPI 3.0 spec auto-generated for your schema
4Auto-generated SDKs (JS, PHP, Python, etc.)
5Webhooks for real-time integrations
6Flotiq is primarily SaaS; limited self-host

Quick Start

terminal

1# 1. Create the compose file
2cat > docker-compose.yml << 'EOF'
3services:
4  flotiq:
5    image: flotiq/flotiq:latest
6    container_name: flotiq
7    restart: unless-stopped
8    environment:
9      FLOTIQ_API_KEY: ${API_KEY}
10    ports:
11      - "3000:3000"
12    networks:
13      - flotiq-network
14
15networks:
16  flotiq-network:
17    driver: bridge
18EOF
19
20# 2. Create the .env file
21cat > .env << 'EOF'
22API_KEY=your-api-key
23EOF
24
25# 3. Start the services
26docker compose up -d
27
28# 4. View logs
29docker compose logs -f

One-Liner

Run this command to download and set up the recipe in one step:

terminal

1curl -fsSL https://docker.recipes/api/recipes/flotiq/run | bash

Troubleshooting

Container exits with authentication error: Verify FLOTIQ_API_KEY environment variable contains valid read/write API key from your Flotiq dashboard
Port 3000 connection refused: Check if another service is using port 3000 or modify the port mapping in docker-compose.yml
API requests return 403 forbidden: Ensure API key has sufficient permissions for the content types you're trying to access
Webhook events not triggering: Confirm webhook URLs are publicly accessible and Flotiq can reach your development environment
Content schema changes not reflecting: Restart the container after making significant content type modifications in Flotiq dashboard
SDK generation failing: Verify content types have proper field definitions and required fields are marked correctly

Community Notes

Loading notes...

Download Recipe Kit

Get all files in a ready-to-deploy package

Includes docker-compose.yml, .env template, README, and license

Components

flotiq

Related Recipes

Ad Space

Shortcuts: C CopyF FavoriteD Download