Why API Hub
Content does not stay in one system. Translation services, monitoring, workflow tools and assistants need it. Other systems send data to TYPO3. API Hub gives all of them one documented REST API with access control. An integration is then not a separate software project.
The access control, the log and your responsibilities.
When to use API Hub, and the type of access for each case.
The available functions, the integration into TYPO3 Core and the steps of an adoption.
The commercial delivery channel of API Hub, with the offer and the prices.
The access control, the log and your responsibilities.
When to use API Hub, and the type of access for each case.
The available functions, the integration into TYPO3 Core and the steps of an adoption.
Status and adoption
The available functions, the integration into TYPO3 Core and the steps of an adoption.
The commercial delivery channel of API Hub, with the offer and the prices.
What changes#
| Question | With a separate solution per integration | With API Hub |
|---|---|---|
| What does a new integration cost? | You must build, test and maintain an extension or endpoints for each integration. | The API gives access to records and files. You add custom functions once, and all applications can use them. |
| Who controls access? | Each integration has its own keys and rules. Often, only its developers know them. | Administrators manage all applications in one backend module. They can remove access at any time. |
| What may an application see? | The data that its developers made available. | Never more than its backend user can see, and never more than an administrator selected. |
| Is the documentation correct? | People write it by hand. Each change can make it incorrect. | TYPO3 generates it from the code. It describes the content model of your installation. |
| Can a supplier connect without custom development? | Usually, you must first specify an individual interface. | The API uses OAuth 2.0, OpenAPI 3.1 and JSON Schema. Many tools and client libraries support them. |
The benefits#
You do not have to develop in TYPO3 to read and change records and files. Teams work on the integration, not on the interface.
Page, table, field and file permissions and workspaces apply to API requests as in the backend. You do not maintain a second set of rules.
One backend module lists all applications with access. If you disable an application, its next request fails.
The API has standard protocols and generated documentation. New team members and suppliers get the same complete description.
For the TYPO3 Suite, the TYPO3 Company is the manufacturer under the EU Cyber Resilience Act.
Each Suite version gets up to 7 years of support. The TYPO3 Company submitted this feature for integration in TYPO3 v15, and it will likely be part of it. See Status and adoption.
You do not have to develop in TYPO3 to read and change records and files. Teams work on the integration, not on the interface.
You do not have to develop in TYPO3 to read and change records and files. Teams work on the integration, not on the interface.
Page, table, field and file permissions and workspaces apply to API requests as in the backend. You do not maintain a second set of rules.
Page, table, field and file permissions and workspaces apply to API requests as in the backend. You do not maintain a second set of rules.
One backend module lists all applications with access. If you disable an application, its next request fails.
One backend module lists all applications with access. If you disable an application, its next request fails.
The API has standard protocols and generated documentation. New team members and suppliers get the same complete description.
The API has standard protocols and generated documentation. New team members and suppliers get the same complete description.
For the TYPO3 Suite, the TYPO3 Company is the manufacturer under the EU Cyber Resilience Act.
For the TYPO3 Suite, the TYPO3 Company is the manufacturer under the EU Cyber Resilience Act.
Each Suite version gets up to 7 years of support. The TYPO3 Company submitted this feature for integration in TYPO3 v15, and it will likely be part of it. See Status and adoption.
Each Suite version gets up to 7 years of support. The TYPO3 Company submitted this feature for integration in TYPO3 v15, and it will likely be part of it. See Status and adoption.
When to use API Hub#
- several systems exchange content or files with TYPO3
- you want one maintained API to replace custom interfaces
- editors use external tools with their own permissions
- suppliers need a documented interface to your installation
- you need clear manufacturer responsibility and long-term support
- anonymous website visitors must get content from a public API with a cache: each request uses a backend user
- a browser must call the API directly: the HTTP API sends no CORS headers, so the application needs its own server
- you use a TYPO3 version below 14.3 and cannot update
- several systems exchange content or files with TYPO3
- you want one maintained API to replace custom interfaces
- editors use external tools with their own permissions
- suppliers need a documented interface to your installation
- you need clear manufacturer responsibility and long-term support
- several systems exchange content or files with TYPO3
- you want one maintained API to replace custom interfaces
- editors use external tools with their own permissions
- suppliers need a documented interface to your installation
- you need clear manufacturer responsibility and long-term support
- anonymous website visitors must get content from a public API with a cache: each request uses a backend user
- a browser must call the API directly: the HTTP API sends no CORS headers, so the application needs its own server
- you use a TYPO3 version below 14.3 and cannot update
- anonymous website visitors must get content from a public API with a cache: each request uses a backend user
- a browser must call the API directly: the HTTP API sends no CORS headers, so the application needs its own server
- you use a TYPO3 version below 14.3 and cannot update