Connect Releases
Added support for updating a Deployment Connector during redeployment
You can now update a Connector when redeploying a Deployment. By setting the updateConnector
property to true
on the Redeploy update action, you can ensure that the Connector is updated to its latest state.
Added 'IntegrationTypes' field to ConnectorStaged and Connector
The integrationTypes field is now available for ConnectorStaged and Connector. This lets you categorize Connectors based on the type of integration they provide. By adding integrationTypes
to your ConnectorStaged, you can filter the results of queries and searches for ConnectorStaged, Connectors, and Deployments.
Changes:
- [API] Added
integrationTypes
field to ConnectorStagedDraft. - [API] Added
integrationTypes
field to ConnectorStaged. - [API] Added
integrationTypes
field to Connector. - [API] Added Set Integration Types update action to the Connectors Staged API.
- [API] Added query parameter
integrationTypes
to the Query ConnectorStaged endpoint. - [API] Added query parameter
integrationTypes
to the Search Connectors endpoint. - [API] Added query parameter
integrationTypes
to the Query Deployments endpoint.
Announced deprecation of 'version' in ConnectorReference
The version
field of ConnectorReference is now deprecated and will be removed in a future release. Before its removal, it has changed from being required to optional. This change eases the deployment of Connectors because you can now deploy a Connector without needing to specify its version
, as the latest version is used by default.
Changes:
- [API] Made
version
optional on ConnectorReference.
Changed the applicationType for Custom Applications
The applicationType
for Custom Applications in connect.yaml has changed from mc-app
to merchant-center-custom-application
.
Connectors created before this change are unaffected and can still be published, certified, and deployed.
Added support for Custom Applications
You can now create and deploy Custom Applications using commercetools Connect. This allows you to extend the functionality of the Merchant Center without needing to maintain dedicated hosting.
To include a Custom Application in your Connector, set applicationType
to mc-app
in your connect.yaml file. For more information, see Developing a Connect application.
Changes:
- [API] Added
mc-app
to theapplicationType
field on ConnectorConfigurationApplication.
Added default and required fields to Connector configurations
You can now specify required environment variables and their default values for standard configurations and required environment variables for secure configurations in connect.yaml
. By defining environment variables as required, you ensure that those deploying your Connector know what values are required. Including a default value for standard configurations also ensures there is a fallback value.
Changes:
- [API] Added
required
to ConfigurationKeyStandard on ConnectorStaged. - [API] Added
default
to ConfigurationKeyStandard on ConnectorStaged. - [API] Added
required
to ConfigurationKeySecured on ConnectorStaged.
commercetools Connect achieved general availability status
After collecting feedback during the beta phase, we have moved commercetools Connect out of beta. The status of the following has been changed to general availability:
commercetools Connect lets you:
- Create private integrations for use in your own Composable Commerce Projects, or public integrations that other Composable Commerce customers can deploy.
- Deploy publicly available integrations that have been certified to ensure functionality, security, and compatibility with Composable Commerce.
- Deploy integrations without needing to provision infrastructure and runtime environments.
- Manage all aspects of commercetools Connect, from configuration to certification and deployment, using the Connect API.
Support for commercetools Connect is available on the Support Portal.
Improvements to Connector publishing and deployment
The following improvements are now available for publishing and deployment of Connectors:
- When creating a production-ready or previewable Connector, you can now view errors and warnings about the release process using the
publishingReport
andpreviewableReport
fields on ConnectorStaged. - Errors and warnings are now available during the Deployment build process. This provides you with feedback regarding Connector development and highlights any issues that arise during deployment.
- You can now include a link to documentation and support channels within your Connector. By adding these links you can assist clients when they are deploying your Connector.
- You can now publish a private or public Connector to production with the Publish update action. This action replaces the Trigger Certification Process update action and allows that private connectors do not need certification. This improves flexibility for in-house Connector development and deployment.
- You can now deploy Connectors partially. This lets clients choose which Connect applications within a Connector they want to deploy.
Changes:
- [API] Added ConnectorReport to Connectors Staged.
- [API] Added
documentationUrl
field to ConnectorStagedDraft. - [API] Added
documentationUrl
field to ConnectorStaged. - [API] Added
documentationUrl
field to Connector. - [API] Added Set Documentation URL update action to the Connectors Staged API.
- [API] Added
supportUrl
field to Creator. - [API] Added
logoUrl
field to Creator. - [API] Added Set Support URL update action to the Connectors Staged API.
- [API] Added Set Creator Logo update action to the Connectors Staged API.
- [API] Added
noOfContributors
field to Creator. - [API] Removed
noOfDevelopers
field from Creator. - [API] Added Set Number of Contributors update action to the Connectors Staged API.
- [API] Removed Set Number of Developers update action from the Connectors Staged API.
- [API] Added Publish Connector update action to the Connectors Staged API.
- [API] Removed Trigger Certification Process update action from the Connectors Staged API.
- [API] Added DeploymentReport to DeploymentDetailsBuild on Deployment.
- [API] Added the DeploymentApplicationDoNotBelong error code.
- [API] Added the DeploymentApplicationRequired error code.
- [API] Added the DeploymentMustIncludeApplication error code.
Added support for Deployment Logs when deploying previewable Connectors
You can now view the Deployment Logs of Deployments made using Connectors with previewable status. This change allows you to receive important feedback when testing and evaluating in-development Connectors.
Launching commercetools Connect
We are launching commercetools Connect in public beta. With Connect, you gain access to a managed execution environment and infrastructure provided by commercetools for running integrations.
You can develop your own Connect applications, or take advantage of pre-built, certified integrations that simplify processes, reduce operational costs, and minimize implementation time by launching and installing the integration.
Connect provides the following features:
- You can create Connect applications, and they can be restricted to defined Projects or made universally available to all Projects.
- Connect applications are certified to ensure functionality, security, and compatibility with commercetools Composable Commerce.
- Connect provisions the infrastructure and runtime environment for running integrations. You do not need to maintain dedicated cloud infrastructure for hosting integrations.
- From configuration to certification and deployment, all aspects of Connect are managed through the Connect API.
To learn more about Connect, check the following links: