TYPO3 Extension "TCA API" 28. Oktober 2026
Veranstaltungen, Ansprechpartner*innen oder Stellenangebote: Viele Inhalte werden in TYPO3 gepflegt, aber an mehreren Stellen gebraucht. Oft werden Daten dafür kopiert oder über eigene Schnittstellen bereitgestellt. Das kostet Zeit und macht die Pflege unnötig kompliziert.
Die TYPO3 Extension „TCA API“ geht einen anderen Weg. Sie stellt TYPO3-Daten über eine Schnittstelle bereit, sodass Websites, Apps und andere Systeme darauf zugreifen können. Die Daten bleiben dort, wo sie hingehören: im TYPO3-Backend. Eine eigene API mit individuellen Controllern und Datenmodellen muss dafür nicht entwickelt werden.
Daten einmal pflegen, überall nutzen
In vielen TYPO3-Projekten werden dieselben Informationen an mehreren Stellen benötigt. Ein Veranstaltungskalender soll beispielsweise auf der Startseite erscheinen, in einem Verzeichnis durchsuchbar sein und zusätzlich eine App versorgen. Oft werden Daten dafür kopiert oder eigens für andere Systeme aufbereitet. Das kostet Zeit und macht die Pflege unnötig kompliziert.
Die TCA API setzt genau hier an. Sie stellt vorhandene TYPO3-Daten über eine REST-API bereit, sodass andere Anwendungen sie direkt abrufen und weiterverarbeiten können. Für die Redaktion ändert sich dabei wenig: Die Inhalte werden weiterhin im gewohnten TYPO3-Backend gepflegt.
Technisch nutzt die Extension die Table Configuration Array (TCA), also die Datenstruktur, die TYPO3 bereits für die Verwaltung seiner Inhalte verwendet. Daraus lassen sich API-Ressourcen ableiten, ohne eigene Controller oder Datenmodelle entwickeln zu müssen. Die Daten werden im Format JSON-LD ausgegeben, die passende OpenAPI-Dokumentation wird automatisch erzeugt.
Die TCA API unterstützt TYPO3 13.4 LTS und TYPO3 14.
Funktionen der TCA API
- Die TCA API übernimmt viele Aufgaben, die beim Aufbau einer Schnittstelle sonst individuell entwickelt werden müssten.
- Schnell eingerichtet: Eine kurze Konfigurationsdatei reicht aus, um eine Tabelle als API-Ressource bereitzustellen. Listen, Detailansichten, Seitenaufteilung und Dokumentation sind bereits vorgesehen.
- Verknüpfte Daten inklusive: Kategorien, Schlagwörter oder Abteilungen können direkt mitgeliefert werden. Zusätzliche Abfragen sind dafür nicht immer nötig.
- Suchen und filtern: Datensätze lassen sich nach verschiedenen Kriterien durchsuchen und filtern, auch anhand verknüpfter Daten.
- Bilder direkt verwenden: Die im Backend festgelegten Bildausschnitte (Crop Variants) werden verarbeitet und als WebP bereitgestellt.
- URLs automatisch erzeugen: Verweise und Detail-URLs werden über den Router der Website erstellt.
- Formulare und Datei-Uploads: Daten und Dateien können über eine Anfrage übermittelt werden. Die Extension unterstützt dabei die Prüfung der Eingaben und verständliche Fehlermeldungen.
- Mehrsprachigkeit und Zugriffsschutz: Mehrsprachige Inhalte, Berechtigungen pro Aktion und Caching werden unterstützt.
- Dokumentation inklusive: Die API-Dokumentation wird automatisch erzeugt. Über Swagger UI lassen sich Anfragen direkt im TYPO3-Backend ausprobieren.
Anwendung am Beispiel
Wie das Ganze in der Praxis aussehen kann, zeigt ein Beispielprojekt für die fiktiven Stadtwerke Lindental.
Die Redaktion pflegt Veranstaltungen und Ansprechpartner*innen wie gewohnt im TYPO3-Backend. Das Verzeichnis greift über die TCA API auf diese Daten zu und stellt sie übersichtlich dar.
Das Beispiel bietet unter anderem:
- Stichwortsuche: Auch Themen und Schlagwörter werden berücksichtigt.
- Filter für Veranstaltungen: Die Einträge lassen sich nach Thema und Monat eingrenzen.
- Filter für Ansprechpartner*innen: Die Abteilung hilft dabei, die passenden Kontakte zu finden.
- Responsive Bilder: Die im Backend gewählten Bildausschnitte werden direkt verwendet.
Werden Einträge in TYPO3 geändert oder neu angelegt, kann das Verzeichnis die aktualisierten Daten über die API abrufen. Eine zweite Datenquelle muss dafür nicht separat gepflegt werden.
Zusätzlich zeigt das Beispiel unterhalb des Verzeichnisses die Antwortzeit der jeweiligen Abfrage. So lässt sich direkt nachvollziehen, wie schnell die Schnittstelle reagiert.
Dokumentation im Backend
Eine API ist nur dann hilfreich, wenn sich auch nachvollziehen lässt, welche Daten sie liefert und wie man sie abfragen kann. Deshalb erzeugt die TCA API zu jeder Ressource automatisch eine passende Dokumentation.
Im TYPO3-Backend ist sie unter „Verwaltung › Integrationen“ erreichbar. Dort lassen sich Anfragen direkt ausprobieren: Suchbegriff eingeben, Anfrage abschicken und die Antwort ansehen.
Das ist nicht nur für Entwickler*innen praktisch. Auch Redaktion und Projektleitung bekommen dadurch einen besseren Eindruck davon, welche Daten über die Schnittstelle verfügbar sind und wie sie sich verwenden lassen.
Neu: Geschützter Zugriff mit Schlüssel
Nicht alle Daten sollen öffentlich zugänglich sein. Während Veranstaltungen auf einer Website für alle sichtbar sein können, benötigen andere Anwendungsfälle einen geschützten Zugriff. Dazu gehören beispielsweise der automatische Datenaustausch mit einem Veranstaltungssystem, Importe durch externe Partner oder interne Inhalte für ein Intranet.
Für solche Aufgaben gibt es jetzt die Unterstützung für API-Keys. Statt sich bei jeder Anfrage über ein Login-Formular anzumelden, weist sich ein System mit einem Schlüssel aus. Das ist besonders praktisch für Skripte, geplante Aufgaben und automatisierte Abläufe.
Die wichtigsten Vorteile:
- Keine Browser-Anmeldung nötig: Der Schlüssel wird bei jeder Anfrage mitgeschickt. Eine Sitzung oder Cookies sind dafür nicht erforderlich.
- Berechtigungen gezielt vergeben: Ein Schlüssel kann beispielsweise nur lesenden Zugriff auf Veranstaltungen erlauben oder für Schreibzugriffe freigeschaltet werden. Er lässt sich außerdem an ein Benutzerkonto binden.
- Zeitlich und technisch begrenzen: Schlüssel können mit einem Ablaufdatum versehen, auf bestimmte IP-Adressen oder Websites eingeschränkt und bei Bedarf gesperrt werden.
- Geschützte Speicherung: Der Schlüssel wird bei der Erstellung einmal angezeigt. Gespeichert wird anschließend nur sein Fingerabdruck, nicht der auslesbare Schlüssel selbst.
- Fehler leichter erkennen: Ungültige Schlüssel werden abgewiesen. Fehlende Berechtigungen lassen sich von einer ungültigen Authentifizierung unterscheiden.
- Direkt ausprobieren: In der API-Dokumentation im Backend gibt es die Funktion „Authorize“. Dort kann ein Schlüssel hinterlegt werden, um geschützte Anfragen zu testen.
Die Schlüsselverwaltung übernimmt die separate Extension api_key. Sie kann auch unabhängig von der TCA API verwendet werden. Ist sie installiert, erkennt die TCA API sie automatisch und kann die Authentifizierung darüber nutzen.
Entwickler*innen können Schlüssel per Kommandozeile anlegen, auflisten und sperren. Weitere Informationen dazu gibt es im Kapitel „Authentication“ in der Dokumentation.
Schnell, auch wenn der Cache leer ist
Wie schnell eine API ist, zeigt sich besonders dann, wenn noch keine zwischengespeicherten Ergebnisse vorliegen. Das passiert beispielsweise nach Änderungen im Backend oder nach einem Deployment. Die erste Anfrage muss die benötigten Daten dann neu laden.
Für die TCA API wurde ein Benchmark mit TYPO3 14.3.8 im Production-Modus durchgeführt. Verglichen wurde jeweils der Median aus drei Läufen.
Bei 100 Datensätzen lag die Antwortzeit der TCA API bei 57 Millisekunden. Die anderen getesteten Lösungen benötigten zwischen 107 und 716 Millisekunden. Bei 1.000 Datensätzen waren es 140 Millisekunden gegenüber 1,5 bis 6 Sekunden bei den Vergleichslösungen.
Ein Grund dafür liegt in der Verarbeitung verknüpfter Daten. Die TCA API lädt sie gebündelt, statt für einzelne Datensätze immer wieder neue Abfragen auszuführen. Im Benchmark waren dafür fünf Datenbankabfragen nötig, während die Vergleichslösungen auf 216 bis 307 Abfragen kamen.
Auch der Entwicklungsaufwand fällt geringer aus: Für die Einrichtung werden rund 30 Zeilen Konfiguration benötigt. Bei den verglichenen Alternativen waren es etwa 180 bis 280 Zeilen Code.
Die Ergebnisse beziehen sich auf den konkreten Benchmark und dessen Testbedingungen. Wer die Details nachvollziehen möchte, findet die Messwerte und den Quellcode hier:
Benchmark auf GitHub · Folien zum Vortrag „TCA rein, JSON-LD raus“
Installation und Anforderungen
Die Installation erfolgt über Composer:
composer require maikschneider/tca-api
Alternativ steht die Extension im TYPO3 Extension Repository zur Verfügung.
Nach der Installation wird das mitgelieferte Site Set eingebunden. Anschließend legen Entwickler*innen für jede Tabelle, die über die API bereitgestellt werden soll, eine passende Ressourcen-Konfiguration an.
Die einzelnen Schritte sind in der Dokumentation beschrieben.
Systemanforderungen:
- TYPO3 13.4 LTS oder TYPO3 14.3
- PHP 8.2 oder höher
Erweiterung und Anpassungen
Nicht jedes Projekt benötigt dieselben Felder, Filter oder Berechtigungen. Deshalb lässt sich für jede Ressource festlegen, welche Daten über die API verfügbar sind und wer darauf zugreifen darf.
Auch eigene Filter, Aktionen und Prüfungen können ergänzt werden. Über entsprechende Ereignisse können Entwickler*innen außerdem in den Ablauf eingreifen und die Verarbeitung an die Anforderungen des jeweiligen Projekts anpassen.
Für geschützte Schnittstellen lässt sich die Unterstützung für API-Keys nutzen. Wer verschiedene Möglichkeiten zur Konfiguration und Erweiterung kennenlernen möchte, findet im TYPO3 Petstore auf GitHub eine Demo mit zahlreichen Beispielen.
Open Source
Die TCA API ist kostenlos und steht unter der Lizenz GPL-2.0-or-later.
Wer die Extension einsetzt, einen Fehler entdeckt oder eine Idee für eine weitere Funktion hat, kann sich gerne beteiligen. Feedback, Vorschläge und Beiträge sind auf GitHub willkommen.
Fazit
Wer TYPO3-Daten an mehreren Stellen nutzen möchte, muss dafür nicht zwangsläufig eine eigene Schnittstelle entwickeln. Die TCA API übernimmt viele der dafür nötigen Aufgaben und baut auf der vorhandenen Datenstruktur von TYPO3 auf.
Das spart Entwicklungsaufwand und erleichtert die Pflege: Die Redaktion arbeitet weiterhin im gewohnten Backend, während Websites, Apps und andere Systeme auf die bereitgestellten Daten zugreifen können.
Mit der automatischen Dokumentation, den Filtermöglichkeiten und der Unterstützung für geschützte Zugriffe eignet sich die Extension für unterschiedliche Einsatzbereiche. Wer es genauer wissen möchte, kann Konfiguration, Benchmark und Quellcode öffentlich nachvollziehen.
Dokumentation · GitHub · Extension Repository
Erstveröffentlichung: 28. Oktober 2026 von Christoph Traser