Documentation

Connectors

Configure and manage Connectors in your Organization.

commercetools Connect is only available in Google Cloud and Azure Regions.

The Connect marketplace provides access to Public Connectors and Organization Connectors.

Public Connectors have passed a certification process to ensure their functional completeness, stability, and compatibility. Those are available to all Composable Commerce Projects.

Organization Connectors are Connectors developed by, or for, your own Organization. They can be installed in your own Projects only by default, but they can also become Public Connectors after having completed a certification process.

Access the Connect marketplace

  1. Click the profile icon and select Manage Organizations & Teams.
  2. Select an Organization and click the Connect tab.

Install and manage Connectors

While requirements for installing Connectors vary based on the services they interact with, most require an API Client. For greater security and auditability, we recommend creating a specific API Client for each Connector.

Install a Public Connector

  1. From the Connect marketplace, choose a Public Connector to install and click Learn more.

  2. Read the Connector's documentation, including the prerequisites and installation guide, and click Install.

  3. Select the Region in which you want to install the Connector.

  4. Choose to install the Connector for all Projects, or for specific Projects within your Organization, and click Next.

  5. Enter the values for all fields for each application within the Connector. These fields are specific for each Connector, and more information can be found in the Connector's documentation.

    • If you selected multiple Projects, you must repeat this process for each Project.
    • Connectors that use third-party services may require that you have a commercial contract with the service provider before installing the Connector.

  6. Click Install. The Manage connectors page appears, which displays the installation status.

Install an Organization Connector

You must create and publish an Organization Connector before it can be installed.

  1. From the Connect marketplace, click Manage connectors.

  2. On the Organization connectors tab, select the Connector to install.

  3. If the Connector was published for testing purposes, click Deploy on Preview. If the Connector was published for private use, click Deploy on Production.

  4. Select the Region in which you want to install the Connector.

  5. When deploying on production: Choose to install the Connector for all Projects, or for specific Projects within your Organization, and click Next.

  6. Enter the values for all fields for each application within the Connector.

    If you selected multiple Projects, you must repeat this process for each Project.

  7. Click Install. The Manage connectors page appears, which displays the installation status.

Manage installed Connectors

  1. From the Connect marketplace, click Manage connectors.
  2. Click the Installations tab.
  3. Select one of the Connectors from the list to change its configuration, or view app logs and build details.

View Connector logs

To view the logs of a Connector, go to the App logs tab. You can select to view the logs of a specific application within the Connector, and choose the time and date range of the logs to display.

Redeploy a Connector

If your Connector's installation has failed, go to the Build details tab of the Connector and address the errors, and then click Redeploy.

Uninstall a Connector

To uninstall a Connector, select a Connector and click Uninstall.

Create an Organization Connector

After developing your Connect applications, do the following:

  1. From the Connect marketplace, click Organization connectors.

  2. Click Create connector.

  3. In the Creator Details section, follow these steps:

    • For Contact email, enter the contact email of the creator or maintainer of the Connector.
    • Optional: For Title, enter the title of the contact person.
    • Optional: For Contact name, enter the name of the contact person.
    • Optional: For Company name, enter the name of the company that created and maintains the Connector.
    • Optional: For Number of developers, enter the number of developers within the company.

  4. In the Connector Details section, follow these steps:

    • For Name, enter the display name for the Connector.

    • Optional: For Description, enter a description for the Connector.

    • For Repository URL, enter the SSH URL of the GitHub repository containing your Connect applications.

      If the GitHub repository is private, you must grant read access to the connect-mu machine user.

    • For Repository tag, enter the Git tag of the release to use.

    • Optional: For Connector key, enter an identifier for the Connector.

    • Optional: For Supported regions, select the Regions in which the Connector will be available. If not selected, the Connector will be available in all Regions supported by commercetools Connect.

  5. In the Project Details section, follow these steps:

    • For Primary project, select the primary Project for the Connector.

    To use the Connect API to manage this Connector, your access token must have suitable scopes for the primary Project.

    • For Supported projects, choose to make this Connector available to all or specific Projects within the Organization.

  6. Click Next.

  7. Optional: If you want to publish the Connector, select one of the options. To publish later, click Skip this step.

    • To publish a Connector for testing or debug purposes in your own Projects, click Request Preview.
    • To publish the Connector for use in your own Projects, click Publish for private use.
    • To submit your Connector to the certification process, click List on Marketplace. After the Connector is certified, it will be listed on the Connect marketplace as a Public Connector.

    An unpublished Connector will have a Draft status. To manage an unpublished Connector using the Connect API, use the ConnectorStaged endpoints.

  8. The Manage connectors page appears, which displays your Organization Connectors.

Publish an Organization Connector

Your Organization Connector must be published before it can be installed.

  1. From the Connect marketplace, click Manage connectors.

  2. On the Organization connectors tab, select a Connector from the list and choose one of the following:

    • Request preview: To publish your Connector for testing or debug purposes, click Request preview. After the Previewable status appears as Accepted, the Connector can be installed.

      If the Previewable status appears as Rejected, you can view more information on the Preview Report tab of the Connector.

    • List on Marketplace: To list the Connector as a Public Connector, click List on Marketplace. This will submit your Connector to the certification process. After the Connector status appears as Listed and certified, your Connector will be listed on the Connect marketplace as a Public Connector.

    • Publish for private use: To publish the Connector for use in your own Projects, click Publish for private use. After the Connector status appears as Published, the Connector can be installed.

      If the Connector status appears as Publish failed, you can view more information on the Publish Report tab of the Connector.