Configuration
Extension configuration
| Setting | Meaning |
|---|---|
api, api | ProvenExpert API credentials |
cache | how long a response is reused, default 3600 seconds |
timeout | how long to wait for the API, default 5 seconds |
auto | place the rating before </ on every page, default on |
rating | layout of the visible rating, see below |
stroke, fill, font | colour overrides for the stars, exactly like the official PHP script |
Layout
ProvenExpert always returns the layout selected in the account under
Google stars > Display of the rich snippet; its API offers no
parameter for it. The extension therefore builds the visible output itself,
from the rating and review fields of the same API
response – a route ProvenExpert explicitly allows. The JSON-LD block is always
taken over from ProvenExpert unchanged, so the structured data stays
exactly as intended.
rating |
Output |
|---|---|
stars (default) | stars next to "N reviews on ProvenExpert.com" |
stars | stars above the review count |
text | "Company has 4.67 out of 5 stars" above the review count |
text | both in one line, separated by a pipe |
account | untouched markup from ProvenExpert, i.e. whatever the account is set to |
Per site
The same keys can be set per site below settings.,
which takes precedence over the extension configuration:
settings:
bm1_provenexpert:
apiId: '...'
apiKey: '...'
ratingStyle: 'starsInline'
On TYPO3 v13 and above you can add the shipped site set
bm1/, which makes the settings editable in the backend.
Keeping credentials out of the repository
Any string setting may hold a placeholder such as
%env, which is resolved from the server
environment. In site YAML files TYPO3 resolves such placeholders on its own.