Zurück zur Übersicht
API für Entwickler
Verbinden Sie externe Tools, Apps und KI-Agenten über die REST-API mit Ihrem CMS.
Was ist die Optimocms-API?
Die Optimocms-API ermöglicht es Ihnen, Ihr CMS von externen Tools und Systemen aus zu steuern. Zum Beispiel:
• Ein eigenes Dashboard, das Daten aller Ihrer Websites anzeigt
• Ein externes System, das automatisch Produkte oder Inhalte aktualisiert
• KI-Tools wie Lovable, Cursor oder Claude, die Seiten erstellen und veröffentlichen
• Integrationen mit Zapier, Make oder n8n zur Automatisierung
Die API verwendet Standard-HTTP-Anfragen (GET, POST, PUT, DELETE) und gibt JSON zurück.
Die vollständige technische Dokumentation finden Sie auf developers.optimocms.com.
API-Schlüssel erstellen
Gehen Sie zu Einstellungen → API-Schlüssel und folgen Sie diesen Schritten:
1. Klicken Sie auf 'Neuer API-Schlüssel'
2. Geben Sie dem Schlüssel einen erkennbaren Namen (z.B. 'Lovable-Integration')
3. Wählen Sie die Berechtigungen: nur Lesen, Schreiben, KI-Funktionen, Veröffentlichen
4. Optional: Beschränken Sie den Schlüssel auf bestimmte Websites
5. Klicken Sie auf 'Erstellen'
Der API-Schlüssel wird nur einmal angezeigt. Kopieren und speichern Sie ihn sicher — Sie können ihn nicht erneut ansehen.
Tipps
- Erstellen Sie für jede Integration einen separaten Schlüssel, damit Sie sie einzeln widerrufen können.
- Speichern Sie API-Schlüssel niemals in öffentlichem Code oder Repositories.
Hinweis
- Wenn Sie einen API-Schlüssel verlieren, erstellen Sie einen neuen und widerrufen Sie den alten.
Authentifizierung
Fügen Sie bei jeder Anfrage Ihren API-Schlüssel als Header hinzu:
X-Api-Key: omc_ihr_api_schlüssel
Ohne gültigen Schlüssel erhalten Sie einen 401-Fehler.
Limits
Die API hat planabhängige Limits für faire Nutzung:
• Starter (€39): 1.000 API-Aufrufe/Monat, 500 MCP-Aufrufe, 10 Anf./Min.
• Professional (€79): 5.000 API-Aufrufe/Monat, 2.500 MCP-Aufrufe, 20 Anf./Min., 100K KI-Tokens
• Agency (€199): 50.000 API-Aufrufe/Monat, 25.000 MCP-Aufrufe, 60 Anf./Min., 500K KI-Tokens
KI-Funktionen (generieren, übersetzen): maximal 2 pro Minute.
Veröffentlichen: 5-Minuten-Cooldown pro Website.
Bei Überschreitung erhalten Sie einen 429-Fehler mit einem Retry-After-Header.
Tipps
- Sehen Sie Ihre API-Nutzung unter Einstellungen → API-Schlüssel ein.
- Während der Testphase (Trial) ist der API-Zugang nicht verfügbar.
Verfügbare Endpoints
Die API bietet Zugang zu:
• Websites — Liste, Details, Veröffentlichen
• Seiten — Lesen, Erstellen, Aktualisieren
• Medien — Dateien abrufen und durchsuchen
• KI — Seiten generieren, übersetzen, Inhalte verbessern
• Buchungen — Verfügbarkeit, Reservierungen
• Shop — Produkte, Bestellungen, Rabattcodes
• Treue — Punkte, Prämien, Mitglieder
• Analysen — Besucherstatistiken
Sehen Sie die vollständige API-Referenz mit Request/Response-Beispielen für jeden Endpoint.
Beispiele
Alle Seiten einer Website abrufen:
GET /v1/sites/{siteId}/pages
X-Api-Key: omc_ihr_schlüssel
Eine neue Seite erstellen:
POST /v1/sites/{siteId}/pages
X-Api-Key: omc_ihr_schlüssel
Content-Type: application/json
{"title": "Kontakt", "slug": "kontakt"}
Eine Seite ins Deutsche übersetzen:
POST /v1/sites/{siteId}/ai/translate
X-Api-Key: omc_ihr_schlüssel
{"pageId": "page_abc", "targetLanguage": "de"}
Versionierung & Deprecation-Richtlinie
Die Optimocms-API folgt einer klaren Versionierungsrichtlinie, um Breaking Changes vorhersehbar zu machen.
• Versionen: Die API wird über den URL-Pfad versioniert (z.B. /v1/). Breaking Changes werden nur in einer neuen Hauptversion eingeführt (z.B. /v2/).
• Nicht-breaking Ergänzungen (neue Felder, neue Endpoints) werden der bestehenden Version hinzugefügt.
• Deprecation: Wenn ein Endpoint veraltet ist, erhalten Sie zwei Standard-HTTP-Header:
– Sunset: das Datum, an dem der Endpoint entfernt wird.
– Deprecation: true — zeigt an, dass der Endpoint veraltet ist.
– Link: verweist auf die Migrationsdokumentation.
• Mindestankündigungsfrist: Sie haben immer mindestens 90 Tage Zeit, um zum Ersatz-Endpoint zu migrieren.
Überprüfen Sie regelmäßig, ob Ihre Antworten Sunset-Header enthalten, damit Sie rechtzeitig migrieren können.
Tipps
- Bauen Sie eine Prüfung in Ihre Integration ein, die bei einem Sunset-Header warnt, damit Sie nie überrascht werden.
- Nicht-breaking Änderungen (neue Felder in Antworten) erfordern keine Aktion Ihrerseits.
API-Änderungsprotokoll
Alle Änderungen an der API werden hier verfolgt.
26. Mai 2026 — v1 (aktuelle Version)
• Erste öffentliche Veröffentlichung der REST-API
• Endpoints: Websites, Seiten, Medien, KI, Buchungen, Shop, Treue, Analysen
• Authentifizierung über X-Api-Key-Header
• Rate-Limiting pro Plan
• Sunset- und Deprecation-Header für zukünftige Abkündigungen eingeführt
Das vollständige API-Änderungsprotokoll finden Sie in den Developer Docs für die aktuellste Übersicht.