MODX Revolution
Setup guide · 1.0.0-rc1
This is a release candidate. Before production, validate the package on a staging site with your CMS version, theme and project public token. No marketplace certification is claimed.
Download ZIP — MODX Revolution
Before installation
Create a Vinalfa project, activate Trial or a subscription and allow your site origin for its public widget token. Never put a server Bearer token here.
Installation and placement
- Copy assets/components/vinalfa/Catalog.php. Create VinalfaCatalog from elements/snippet.vinalfa.php without the opening PHP tag.
- Call [[!VinalfaCatalog]] on a dedicated Resource with config_id, public_token, search_url and language parameters. This is snippet source, not a .transport.zip.
Enter CONFIG_ID, public widget token, language and your store HTTPS search URL containing {article}. Set the same URL in the Vinalfa project: project settings may override adapter parameters. Verify OEM/SKU search in your store.
[[!VinalfaCatalog? &config_id=`YOUR_CONFIG_ID` &public_token=`YOUR_PUBLIC_WIDGET_TOKEN` &search_url=`https://YOUR-STORE.example/search/?q={article}` &language=`en`]]After installation
Test VIN/frame → vehicle → diagram → OEM number → your store search, page refresh, access errors and limits. Test the full flow on phones from 320 px. Review cache, CSP and JavaScript optimizers.
Native adapters use hash routing without extra server rules. Theme, builder and React/Vue components use an iframe: the inner catalog position is not retained in the parent page URL.
Integration scope
Catalogs, VIN/frame, diagrams and a link to your store search. Prices, stock, cart and orders stay in the store; product import and price synchronization are not included.
Removal
First remove catalog placements and navigation links. Then disable/uninstall through the CMS or remove only the added files after a backup. Uninstalling the Bitrix module preserves the component and pages; full removal is a separate step.
Build verification
The plugin was tested on WordPress 6.8.3 with SQLite: activation, settings, shortcode and uninstall. Other CMS adapters passed code and isolated scenario checks without full CMS installations. React/Vue components and the installer were tested with a mocked API, using no VIN quota.