See the supported regions and required scopes of Connect.
Hosts
The Connect API has different hosts from Composable Commerce HTTP API
hosts. You can access the Connect API at the following URLs:
| Region | API URL |
|---|
| Europe (Google Cloud, Belgium) | https://connect.europe-west1.gcp.commercetools.com/ |
| Europe (AWS, Frankfurt) | https://connect.eu-central-1.aws.commercetools.com/ |
| North America (Google Cloud, Iowa) | https://connect.us-central1.gcp.commercetools.com/ |
| North America (AWS, Ohio) | https://connect.us-east-2.aws.commercetools.com/ |
| Australia (Google Cloud, Sydney) | https://connect.australia-southeast1.gcp.commercetools.com/ |
If documentation refers to https://connect.{region}.commercetools.com, you should use the respective API URL of the Region that hosts your Project.
Authorization
The Connect API uses tokens from Composable Commerce HTTP API
authorization flows with the following scopes:
manage_project:{projectKey}: grants permission to use all Connect API endpoints in a Project. To access individual API endpoints, use more selective permissions.view_connectors:{projectKey}: grants permission to view Connectors in a Project.manage_connectors:{projectKey}: grants permission to view, create, update, and delete Connectors in a Project.view_connectors_deployments:{projectKey}: grants permission to view Deployments in a Project.manage_connectors_deployments:{projectKey}: grants permission to view, create, update, and delete Deployments in a Project.manage_api_clients:{projectKey}: grants permission to create automatically generated API Client credentials.
Creators typically need the
manage_connectors scope to manage ConnectorStaged and Connectors, while
clients typically need the
manage_connectors_deployments scope to manage Deployments.
Scopes required for automatically generating API credentials are displayed during the deployment step, before the Connector is installed.