---
title: "Why API Hub"
description: "The business case for API Hub: the changes for an organization that uses TYPO3, and when to use API Hub."
canonical: index.html
navigation-title: "Decision makers"
---

<a id="overview"></a>

<a id="why-api-hub"></a>

# 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.

[Security and governance](security.md)

[Status and adoption](status.md)

![Illustration of steps leading up to a central hub.](../_images/audience-decision.webp)

**[Security and governance](security.md)**
The access control, the log and your responsibilities.

**[Use cases](use-cases.md)**
When to use API Hub, and the type of access for each case.

**[Status and adoption](status.md)**
The available functions, the integration into TYPO3 Core and the steps
of an adoption.

**[TYPO3 Suite](https://suite.typo3.com/)**
The commercial delivery channel of API Hub, with the offer and the
prices.

<a id="overview-change"></a>

<a id="what-changes"></a>

## What changes

```diagram
flow canvas=940
  columns 1,1.1,1
  gap 80,16
title "Many applications use one controlled API"
description "Scripts, third-party services and applications for editors are outside the TYPO3 installation. They connect to API Hub, which is in the installation. API Hub checks each request and sends it to the records and files in TYPO3. The permissions of a backend user apply."

group apps "Your applications"
  scripts "Scripts and automation"
    at 0,0
  services "Third-party services"
    at 0,1
  tools "Applications for editors"
    at 0,2

group install "Your TYPO3 installation"
  emphasis
  hub "API Hub"
    at 1,0
    rows 3
    strong
    item "One REST API"
    item "One access model"
    item "Generated documentation"
  content "Records and files"
    at 2,0
    rows 3
    store

scripts -> hub
services -> hub
tools -> hub
hub -> content
```

*All integrations use the same API, the same login, the same permissions and the same documentation.*

| 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. |

<a id="overview-benefits"></a>

<a id="the-benefits"></a>

## 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](status.md#overview-status).

<a id="overview-fit"></a>

<a id="when-to-use-api-hub"></a>

## 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

[Security and governance](security.md)

[Status and adoption](status.md)