Developers

Call the HTTP API of TYPO3, and add your own actions in an extension. You must know HTTP. For extensions, you must also know PHP and TYPO3.

Quick start: from the installation to the first request
Cookbook: recipes in PHP, JavaScript and TypeScript
Tutorial: build your first action with its own scope
API reference: all endpoints in Swagger UI

Open the cookbook API reference

Illustration of a segment being added to a ring around a hub.

Quick start#

Install the extension

API Hub needs a Composer-based installation of TYPO3 14.3.10 or later and PHP 8.2 or later. The delivery channel is the TYPO3 Suite. Your TYPO3 partner sets up the access to its repository packages.typo3.com.

bash

composer config repositories.typo3-suite composer \
    https://packages.typo3.com
composer require typo3-suite/hub
vendor/bin/typo3 extension:setup --extension=hub

Create an app

Open Administration > Integrations > API Hub, create an app of the type Static token, select the scope content:read and copy the token, see Creating a static token app.

Send the first request

bash

curl -H 'Authorization: Bearer <token>' \
    'https://example.org/typo3/api/v1/records/pages?limit=2'

Response

json

{
    "items": [
        {
            "uid": 3,
            "pid": 0,
            "label": "Congratulations",
            "type": "1",
            "hidden": false,
            "language": 0
        },
        {
            "uid": 85,
            "pid": 3,
            "label": "Home",
            "type": "4",
            "hidden": false,
            "language": 0
        }
    ],
    "next": "WzMsMCw4NV0"
}