Installation

Follow the standard process of a TYPO3 installation (see TYPO3 Upgrade Guide). After TYPO3 is running, we can continue installing the headless extension:

  1. Install and activate the extension with Composer composer require friendsoftypo3/headless (recommended), or using the extension manager with key headless.

  2. Create a new root page: The page will provide our JSON API endpoint.

    Root page for the API endpoint

  3. Create a new root template: Open the backend's menu entry Site Management > TypoScript (before v12: Web > Template). Add "headless" to "Include static (from extensions)". After saving and displaying the page, we can see already the JSON output.

  4. Create a site configuration: The site URL is needed as endpoint URL for the frontend. In TYPO3 v10 an autogenerated site configuration might exist which we can rename and configure to our preferences.

    Important

    We recommend to use an URL like https://api.mydomain.org as endpoint, because it might come to unexpected behaviours with URLs like https://mydomain.org/api. Probably this will be improved in a future version.