API in TYPO3 – Glossary

TYPO3 API

TYPO3 has a powerful API that helps developers to extend and customize the CMS. This API allows you to connect TYPO3 with other services and applications. Whether you want to add new features or integrate third-party tools, TYPO3's API makes this easy and flexible. This means you can tailor your TYPO3 website to specific needs and create a more powerful and versatile website.

The TYPO3 API consists of classes, interfaces and conventions that let developers extend the system without changing the core. This includes database queries via the QueryBuilder, the file system with the File Abstraction Layer, caching, logging, events and the configuration of forms or backend modules.

A stable contract matters: the officially documented programming interface is changed through deprecation notices during updates, not abruptly. Developers can thus plan for changes in time. The documentation and changelogs show which functions are removed and which alternatives are available.

Besides the PHP API, TYPO3 offers ways to provide data via REST or JSON endpoints. This is the basis for headless projects, mobile apps or connections to other systems. You should consider authentication, caching and versioning of the interface.

Anyone developing extensions is best off sticking to the documented interfaces and avoiding interference with internal classes. This makes later upgrades much easier.

A practical tip for teams: decide which parts of the API you use in your own projects and encapsulate them in a few classes. If an interface changes, you then only have to adjust one place instead of searching the entire code. Together with automated tests and the hints from the deprecation logs, this results in a project that can be maintained reliably across several major versions and does not turn into a large project with every update.