---
title: "Installation"
description: "The requirements and the installation of API Hub with Composer, the encryption key and the next steps to the first request."
canonical: installation.html
---

<a id="installation"></a>

<a id="installation-1"></a>

# Installation

- [Requirements](#requirements)
- [Installation with Composer](#installation-with-composer)
- [Next steps](#next-steps)

<a id="installation-requirements"></a>

<a id="requirements"></a>

## Requirements

- TYPO3 14.3.10 or later
- PHP 8.2 or later
- A Composer-based TYPO3 installation
- Access to the [TYPO3 Suite](https://suite.typo3.com/)

<a id="installation-composer"></a>

<a id="installation-with-composer"></a>

## Installation with Composer

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

1. **Add the repository**
   Run this in the Composer root of the TYPO3 installation:

   ```bash
   composer config repositories.typo3-suite composer \
       https://packages.typo3.com
   ```
2. **Require the package**
   ```bash
   composer require typo3-suite/hub
   ```
3. **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.

> [!WARNING]
> 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.

<a id="getting-started-next-steps"></a>

<a id="next-steps"></a>

## Next steps

- Follow the [quick start](../developers.md#developers-quick-start), or the
  [cookbook](../guides/cookbook.md#usage-examples) for complete examples.
- Create an app in the backend module, see [Creating a static token app](../administration/creating-apps.md#administration-static-token)
  or [Creating an OAuth app](../administration/creating-apps.md#administration-oauth).
- Send the first request with its token, see [Authentication](../usage/authentication.md#usage-authentication).
- Browse all endpoints in the [API reference](../api/index.md).