Directory / plugin

Formix Software Rental Quotes

v0.1.6 · by Formix Software

Shows the products from a Formix rental catalog, including catalogs synced from Rentman, on a WordPress website and lets visitors ask for a quote.

View on WordPress.org

About this plugin

Formix Software Rental Quotes connects a WordPress site to a Formix account, the rental catalog and quote service from Formix Software. Rental companies that keep their inventory in Rentman can publish that catalog on WordPress through Formix and collect quote requests on the site. This plugin is not Formix Charter and is not affiliated with that plugin.

After an administrator connects the site, the plugin mirrors that company’s Formix product catalog into products under the Formix menu and adds a quote cart. Visitors can browse synced products and submit a request for quote. There is no checkout and no payment processing.

A Formix account is required. Until an administrator connects the site, the plugin does not call Formix and does not sync the catalog. Catalog analytics stay off until an administrator enables them.

OAuth tokens are stored in WordPress options and encrypted with the site’s AUTH_KEY. Disconnecting from Formix Settings Connection deletes those tokens.

Routes that stay open

These routes are public on purpose. Visitors are not logged in, so each one sets permission_callback to __return_true.

  • GET /wp-json/semble/v1/quote-cart/products — titles and prices for quote-cart lines, read from products already synced into WordPress
  • GET /wp-json/semble/v1/upsells/resolve — upsell suggestions for the quote cart
  • POST /wp-json/semble/v1/quote-submissions — a visitor submits a quote request
  • POST /wp-json/semble/v1/catalog-events — optional catalog analytics beacons. Nothing is sent until an administrator enables catalog analytics

Settings, connect, disconnect, sync, the daily sync switch, and the analytics switch require the manage_options capability. Connecting does not use a public OAuth callback. An administrator starts it from Formix Settings Connection.

Libraries bundled with this plugin

This plugin is licensed under GPL-2.0-or-later, which can be combined with those libraries. It is not GPL-2.0-only. Action Scheduler 4.2 requires WordPress 6.9, so this plugin does too.

External services

This plugin connects to the Formix API, operated by Formix Software.

Formix is the product catalog, upsell rules, and quote inbox for a rental company. The plugin uses it to copy that catalog into WordPress and to deliver quote requests a visitor submits. The production API address is https://api.formix.nl. The site uses that address, or another Formix API address chosen when the administrator connects.

The plugin does not contact Formix until an administrator connects the site.

What is sent, and when:

  • Connection. The administrator signs in to Formix and approves this site. Formix returns a connected-app client id and secret. The plugin exchanges those for an access token and stores the token in WordPress, encrypted with AUTH_KEY.
  • Catalog sync. When an administrator clicks Sync now, the plugin requests this company’s products and categories. Product images are then downloaded by the WordPress server from the image addresses Formix returns (Formix media storage) into the media library. Sync runs only when an administrator starts it, or once each night after an administrator turns on Sync catalog daily under Formix Settings Sync. That setting is off by default; the nightly sync is a scheduled job on this site and sends the same requests as Sync now.
  • Connection status. While connected, opening Formix Settings Connection asks Formix for the connected app’s name and company so the screen can show them. Only administrators see that screen.
  • Upsells. When the quote cart asks for suggestions, the plugin sends the product ids already in the cart. Suggestion images are loaded by the visitor’s browser directly from Formix media storage, so that server sees the visitor’s IP address and browser details, like any image hosted elsewhere.
  • Quote submission. When a visitor submits the quote form, the plugin sends the selected products, quantities, rental dates, delivery choice, and the contact details the visitor entered (name, email, phone, address, company, and notes). To attribute the request to a campaign it also sends the address of the page the form was on, the address of the first page of that visit including any utm_*, gclid, fbclid, msclkid, wbraid, or gbraid parameters, the referring address if the browser provided one, and the random session id described under catalog analytics. The visitor sees the quote form before anything is sent.
  • Catalog analytics, only after an administrator enables them under Formix Settings Advanced. Each event includes an event name, a random session id kept in that browser session, and a device class (desktop, mobile, or tablet). Names, email addresses, and page addresses are not included in these events. While the setting is off, these events are not sent.

Terms of service: https://formix.nl/algemene-voorwaarden
Privacy policy: https://www.formix.nl/privacyverklaring
Data processing agreement: https://www.formix.nl/verwerkersovereenkomst

Plugin tags