Custom URLs

FxFactory recognizes and handles custom URLs with the fxfactory scheme, e.g.

fxfactory://app/store

Launch FxFactory

The first component of the URL, app, simply indicates that the URL is meant to be interpreted by the FxFactory application. This document describes how to pick subsequent parameters of the URL in order to create links on your website that can trigger actions in the FxFactory application.

Actions on Products

The link given earlier in this page also contains the store path component, which designates actions that affect products managed by FxFactory. To do something more interesting, pass additional parameters. For example, the following URL will launch the FxFactory application and display information on Photo Montage:

fxfactory://app/store?product=photomontage&show

Open Photo Montage

The part of the URL that follows the question mark is called the query. The first parameter of the query tells the FxFactory application which product we are interested in manipulating:

product=photomontage

Notice that we are simply providing the text photomontage to indicate the Photo Montage product. How does FxFactory know that the two are unequivocally the same? FxFactory will match the photomontage tag with the Product ID specified in the product.

A product can also be identified by its UUID, e.g.

product=92665E8D-0AAE-4D85-9AC6-0199BA9D3E80

To create a link that shows the product in FxFactory and brings up the order form, simply add a &buy component to the URL:

fxfactory://app/store?product=photomontage&show&buy

Buy Photo Montage

If the product referred by the URL is not installed on the system, FxFactory will download and install the product first. For example, this is a bogus URL for a product named "Great Product":

fxfactory://app/store?product=greatproduct&name=Great%20Product&show&buy

Notice that spaces cannot appear anywhere in the URL. The name parameter uses the escape sequence %20 to encode "Great Product" as Great%20Product.

The last example covers a common request we receive on tech support: reinstalling any given product. Add the reinstall parameter to the query, for example:

fxfactory://app/store?product=photomontage&reinstall

Reinstall Photo Montage

Conclusion

Custom URLs are used extensively in our online store to create links between our website and our application. FxFactory recognizes additional URLs not discussed in this document, but they have limited use for external websites.