Jsonapi endpoint setup in typo3 v13.4.11 aimeos 25.4.1

[daan]

Hello,

I am having trouble getting any response from the Aimeos JSON:API endpoint in my current TYPO3 setup. I would appreciate any help or suggestions for further debugging.

Environment:

Aimeos: 25.4.1
TYPO3: 13.4.11
PHHP8.2
T3headless API
Headless Content Blocks
Nginx (custom configuration, but all other TYPO3 routes and endpoints work as expected)

What I have done so far:

Aimeos Extension Installation:
I have installed and activated the Aimeos extension via Composer and the TYPO3 Extension Manager. The extension appears in the backend and is active.

TypoScript Configuration:
I created a TypoScript PAGE object for the JSON:API endpoint as described in the official documentation. My TypoScript looks like this:

jsonapi = PAGE
jsonapi {
typeNum = 170602
config {
disableAllHeaderCode = 1
disableCharsetHeader = 1
disablePrefixComment = 1
additionalHeaders {
10.header = Content-Type: application/json
}
}
10 =< plugin.tx_aimeos
}

This TypoScript is included in the template for the correct page (ID=3).

Cache and Autoload:
I have cleared all TYPO3 caches, flushed PHP opcache, and rebuilt Composer autoload files to ensure there are no stale files.
Endpoint Testing:
I am testing the endpoint using both GET and OPTIONS requests, for example:

curl -X OPTIONS 'http://nginx/index.php?id=3&type=170602'

and

curl -X GET 'http://nginx/index.php?id=3&type=170602'

In both cases, I receive no response —not even an error message or HTTP status, just an empty response.
TypoScript PAGE Object Verification:
To verify that the TypoScript PAGE object is working, I replaced the plugin line with a simple text output:

10 = TEXT
10.value = HELLO

When I do this, I receive the expected "HELLO" response at the endpoint, confirming that the TypoScript PAGE object is being processed and is accessible.

Logs and Error Reporting:
I have enabled full error reporting in TYPO3 and PHP, checked all available logs (TYPO3, PHP, Nginx), but there are no errors or warnings related to this request. Other TYPO3 and T3headless endpoints work without any issues.

Nginx Configuration:
My Nginx configuration works for all other TYPO3 routes, including T3headless API and content blocks. There are no rewrite or proxy issues affecting other endpoints.

Other Checks:
The Aimeos backend module is visible and functional in TYPO3.
The environment matches the compatibility requirements for Aimeos 25.4.1 and TYPO3 13.4.11.
I have not made any custom modifications to the Aimeos extension or the core.

Summary:
Despite following all official steps and confirming that the TypoScript PAGE object is working, I receive no response from the Aimeos JSON:API endpoint when using plugin.tx_aimeos. The environment is otherwise fully functional, and the issue only affects the Aimeos API endpoint. There are no errors in the logs, and the endpoint is accessible when returning static text.

Question:
What could cause the Aimeos JSON:API endpoint to return no response at all, even though the TypoScript PAGE object is working and all other TYPO3 endpoints are functional? Are there any additional debugging steps or configuration checks you would recommend?

Thank you very much for your help!

[aimeos]

Did you import the Aimeos page subtree into your TYPO3 page tree?

Can you try this TypoScript in the setup section of the jsonapi page?

Code: Select all

page = PAGE
page {
    typeNum = 0
    headerData >
    config {
        additionalHeaders.10.header = Content-type:application/json
        disableAllHeaderCode = 1
        disableCharsetHeader = 1
        disablePrefixComment = 1
    }
  10 < tt_content.list.20.aimeos_jsonapi

Make sure that the "Aimeos Shop - JSON REST API" plugin is placed in the "Normal" column and the required settings in the "Plugin" section are filled.

Then, you should get back a response by using e.g.: /jsonapi?ai[resource]=product

[daan]

Hello, thank you for the answer.
It still does not work
Even if I want to build a headless aimeos I have to import the site tree?
I have a multilingual typo3 site. The restapi Ce is in on the shop page - nothig else just that one -, I created a rootlevel typoscript record fort that page, i put the aimeos settings onto it and also added the setup you sent.
The only thing i changed is that i confed it to 170602:
page = PAGE
page {
typeNum = 170602
headerData >
config {
additionalHeaders.10.header = Content-type:application/json
disableAllHeaderCode = 1
disableCharsetHeader = 1
disablePrefixComment = 1
}
10 < tt_content.list.20.aimeos_jsonapi
}
Now I'm still just having empty answers.

This is a complete fresh install with totally clean demo install.

Thank you so much for your help in advance, BR Daniel

[daan]

Solved!

So after spending few days, i found the followings. I leave it here it may help others.

There is no response if you do not set fluid content to the page where the REST API plugin is placed, sadly the api answer is coming in CONTENT so it wasn't quite clear for the first read, and second.... and so on, and so on.

Also I learned that it is a must to use the t3d file. But not the one which is offered in the github repo, you have to get the right one from the distro version.

Finally I have API response

So it would be great if in the documetation it would have more focus.

Cheers, Daniel

[aimeos]

Can you be a bit more precise please what we should change?
You can also create a pull request in the Aimeos docs repository to suggest changes