code711/code711-api

An API for accessing TYPO3 data

1.0.6 2023-04-05 09:48 UTC

Requires

• b13/slimphp-bridge: ^0.5
• firebase/php-jwt: ^6.4
• helhum/dotenv-connector: ^3.0
• typo3/cms-core: ^11.5

MIT

• Patricia Ottmar

README

We published an extension to retrieve the current TYPO3 release of a remote project with a simple link like http://example.com/api/v1/version.

The extension implements a simple REST API using the micro framework slim. Thanks to B13 and extension b13/slimphp-bridge.

1. Get the extension: https://packagist.org/packages/code711/code711-api

2. Add config: In sites/[site]/config.yaml add:

imports:
- resource: EXT:code711_api/Configuration/Routes/Api.yaml

1. Add credentials: We use basic authentication to prevent open access to the current release for security reasons. The credentials could be stored in .env file in project root.

REST_API_USER=XXX
REST_API_PW=XXX

1. Flush cache

2. Test For testing REST API you can use the Postman REST Client: https://www.postman.com/product/rest-client/

Special Environments

Some environments (e.g. Mittwald) need additional configuration to work with the REST API behind a basic authentication. When using CGI/FastCGI mode, it can happen that the Authorization header is not passed to PHP by default.

Therefore, you need to add the following line to your .htaccess file:

SetEnvIf Authorization .+ HTTP_AUTHORIZATION=$0