Skip to content
TYPO3API Hub

Installation

Requirements#

  • TYPO3 14.3.10 or later
  • PHP 8.2 or later
  • A Composer-based TYPO3 installation
  • Access to the TYPO3 Suite

Installation with Composer#

API Hub is available from the Composer repository of the TYPO3 Suite. Your TYPO3 partner sets up your access to it.

Add the repository

Run this in the Composer root of the TYPO3 installation:

bash
composer config repositories.typo3-suite composer \
    https://packages.typo3.com

Require the package

bash
composer require typo3-suite/hub

Set up the extension

This creates the database tables for apps (sys_app) and OAuth tokens (sys_oauth_access_token, sys_oauth_refresh_token):

bash
vendor/bin/typo3 extension:setup --extension=hub

Alternatively, use System > Maintenance > Analyze Database Structure to create the tables.

API Hub signs all tokens with a key from the TYPO3 encryption key ($GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey']). If you change the encryption key, all issued tokens become invalid.

Next steps#