Getting started

API Hub gives external applications access to the functions of TYPO3 through an HTTP API. It uses three concepts:

Actions

An action is a typed operation, for example "get a record" or "update a record". TYPO3 and extensions supply actions. A JSON Schema describes the parameters and the result of each action. TYPO3 uses it to validate requests and responses, and to generate an OpenAPI document of the whole API. Each action has an HTTP endpoint below /typo3/api/.

Scopes

Scopes put actions into groups and give general access to them, for example content:read to read records. A caller can call an action only if it has all scopes of the action.

Apps

An app is the record of an external application in TYPO3. It sets the scopes that the application can use, and how it authenticates: with a static token or with OAuth 2.0. Each request of an app uses a backend user, so all permissions of this user apply.