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.
Run this in the Composer root of the TYPO3 installation:
composer config repositories.typo3-suite composer \
https://packages.typo3.comcomposer require typo3-suite/hubThis creates the database tables for apps (sys_app) and OAuth
tokens (sys_oauth_access_token, sys_oauth_refresh_token):
vendor/bin/typo3 extension:setup --extension=hubAlternatively, use System > Maintenance > Analyze Database Structure to create the tables.
Run this in the Composer root of the TYPO3 installation:
composer config repositories.typo3-suite composer \
https://packages.typo3.comAdd the repository
Run this in the Composer root of the TYPO3 installation:
composer config repositories.typo3-suite composer \
https://packages.typo3.comcomposer config repositories.typo3-suite composer \
https://packages.typo3.com
composer require typo3-suite/hubRequire the package
composer require typo3-suite/hubcomposer require typo3-suite/hub
This creates the database tables for apps (sys_app) and OAuth
tokens (sys_oauth_access_token, sys_oauth_refresh_token):
vendor/bin/typo3 extension:setup --extension=hubAlternatively, use System > Maintenance > Analyze Database Structure to create the tables.
Set up the extension
This creates the database tables for apps (sys_app) and OAuth
tokens (sys_oauth_access_token, sys_oauth_refresh_token):
vendor/bin/typo3 extension:setup --extension=hubvendor/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.
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#
- Follow the quick start, or the cookbook for complete examples.
- Create an app in the backend module, see Creating a static token app or Creating an OAuth app.
- Send the first request with its token, see Authentication.
- Browse all endpoints in the API reference.