About the Companion Apps API

The Companion Apps API lets you retrieve the companion app coupled to the current Wix site, or create and install it if it doesn't already exist. Use it when you need the site to use app-provided features that customize that site.

With the Companion Apps API, you can:

• Get the companion app coupled to the current site.
• Create and install the companion app if the current site doesn't already have one.
• Check whether the companion app is ready to use.

Before you begin

It's important to note the following points before starting to code:

• Each companion app is coupled to one Wix site only. Calls must be made in a site context so the current site can be identified.

• When you call Get Or Create Companion App and the current site doesn't have a companion app, the Companion Apps API creates the app entity and installs it on the current site. If installation fails, the method returns an error but keeps the new companion app. Call the method again to retry installation.

• The status field tells you what to do next:

  • READY: The companion app is ready to use.
  • CLONING: The companion app is still being prepared during site duplication.
  • CLONE_FAILED: The companion app couldn't be prepared during site duplication.

Use cases

• Prepare a site to use app-provided customization features.

Terminology

• Companion app: An app coupled to one Wix site only, which lets the site use app-provided features to customize itself.
• Current site: The Wix site identified by the request context.

See also

• App Installation API.