Immoscout connector for TYPO3-Openimmo

The Immoscout extension for the interface between your website and the Immoscout Rest-API is installed quickly.

Requirements

The extension requires our TYPO3 Openimmo Extension.

Since version 5.0.0:The extension must be installed with composer, as it now uses guzzlehttp/oauth-subscriber instead of ext-oauth to ensure the extension is also ready for use on simple hosting environments.

Before version 5.0.0:Because of a Bug in OAuth-Library, the authorization fails by using PHP 7.3.3:

ERROR_AUTHENTICATION_REQUIRED
Invalid signature for signature method HMAC-SHA1

Installation

1. Install this extension and add the static TypoScript-Template in the root page.
2. Create a container page for the property record.
3. Create a connection of type Immoscout import.
   1. Enter a title and select the container - this is usually the container page itself.
   2. Enter your Immoscout API-Key and API-Secret (see: https://api.immobilienscout24.de/api-docs/authentication/introduction/)
   3. Enter the redirect URI. This is the domain name of your TYPO3 website.
   4. Finally save the record and click the Immoscout authorization button in order to perform the oAuth.
   5. It opens a pop up window/new tab where you have to confirm the access on your Immobilienscout24-Account - confirm that.
   6. Finally it redirects you to your website where you get the message Authorization successful!
4. Now you have to configure a new Scheduler task, which will import your properties from Immoscout.
   1. Open the Scheduler module and click on add task.
   2. Select Extbase CommandController Task in the Class section.
   3. Enter a frequency of execution - for example 3600 for hourly.
   4. Select Immoscout Import: import in the CommandController Command section.

Calling the authorization ends in a 404 error

Calling the authorization results a:

Page Not Found
Reason: Request parameters could not be validated (&cHash empty)

Solution 1.

Open the Installtool and disable pageNotFoundOnCHashError setting: [FE][pageNotFoundOnCHashError] = false

Solution 2.

Exclude the parameters of the request like this (LocalConfigration/settings.php):

'FE' => [
    'cacheHash' => [
        'enforceValidation' => true,
        'excludedParameters' => [
            'connection',
        ],
    ],

Calling the authorization ends in a "No page configured" error

If calling the authorization throws a No page configured for type=1553349669 error, the required static TypoScript template is probably missing.

Running the Importer

When running the importer via the command line, specifying a backend user ID is required. This user is simulated during execution and provides the necessary authorizations.

The command to run the importer via the CLI is as follows:

vendor/bin/typo3 immoscout:import --user=3

Alternatively, in a DDEV environment:

ddev typo3 immoscout:import --user=3

Optionally, a limit of 10 objects per execution can be specified:

vendor/bin/typo3 immoscout:import --user=3 --limit=10

ddev typo3 immoscout:import --user=3 --limit=10

The --force (or -f) option forces the re-creation of imported objects. Objects that already exist locally will be recreated regardless of their modification date:

vendor/bin/typo3 immoscout:import --user=3 --force

ddev typo3 immoscout:import --user=3 --force

The --id (or -i) option allows you to specify a specific object ID for import. All other objects will be skipped during execution:

vendor/bin/typo3 immoscout:import --user=3 --id=161166622

ddev typo3 immoscout:import --user=3 --id=161166622