Defining an integration in the Commerce Admin establishes the location of OAuth credentials and redirect URL for third-party integrations, and identifies the available API resources that are needed for the integration. For more detailed information about the integration registration process, see OAuth-based authentication in the Commerce developer documentation.


Onboarding workflow

  1. Authorize the integration - Go to the System > Extensions > Integrations page, find the relevant integration, and authorize.
  2. Verify and establish login - When prompted, accept the access requested. If redirected to a third-party, log in to the system, or create an account. After a successful login, you return to the integration page.
  3. Receive confirmation of authorized integration - The system sends notification that the integration has been authorized successfully. After setting up an integration and receiving the credentials, it is no longer necessary to make calls to access or request tokens.

Add an integration

  1. On the Admin sidebar, go to System > Extensions > Integrations.

    New integration {width="600" modal="regular"}

  2. Enter the following integration information:

    • Enter the Name of the integration and the contact Email address.

    • Enter the Callback URL where OAuth credentials can be sent when using OAuth for token exchange. Using https:// is strongly recommended.

    • Enter the Identity Link URL to redirect the users to a third-party account with these Adobe Commerce or Magento Open Source integration credentials.

    note note
    The Integration not secure warning label is displayed near each integration name on the Integrations grid as a reminder, until HTTPS URLs are saved into Callback URL and Identity Link URL fields.
    • When prompted, enter your password to confirm your identity.
  3. In the left panel, choose API and do the following:

    • Set Resource Access to one of the following:

      • All
      • Custom
    • For custom access, select the checkbox of each resource that is needed.

      Integrations - available API {width="600" modal="regular"}

  4. When complete, click Save.

Activate an integration

By default, a saved integration appears on the grid with an Inactive status. To activate it, complete the following steps:

  1. On the Admin sidebar, go to System > Extensions > Integrations.

  2. Find the newly created integration and click the Activate link.

  3. In the upper-right corner, click Allow.

    This action displays the Integration Tokens for Extensions. Copy this information to a secure, encrypted location for use with your integration.

    Integration Tokens for Extensions {width="600" modal="regular"}

  4. In the upper-right corner, click Done.

Reauthorize an integration

To generate a new Integration Access Token and Access Token Secret, reauthorized the integration from the Admin:

  1. On the Admin sidebar, go to System > Extensions > Integrations.

  2. Find the integration with the Active status.

  3. In Activate column, click the Reauthorize.

  4. Click Reauthorize to approve access to the API resources.

  5. Save the new integration tokens for extensions and click Done.

Change the API guest access security setting

By default, the system does not permit anonymous guest access to CMS, catalog, and other store resources. If you must change the setting, do the following:

  1. On the Admin sidebar, go to Stores > Settings > Configuration.

  2. In the left panel, expand Services and choose Magento Web API.

  3. Expand Expansion selector the Web API Security Setting section.

    Services configuration - web API security settings {width="600" modal="regular"}

  4. Set Allow Anonymous Guest Access to Yes.

  5. When complete, click Save Config.

For additional information, see Restricting access to anonymous web APIs in the Commerce developer documentation.

Delete an integration

  1. On the Admin sidebar, go to System > Extensions > Integrations.

  2. Find the existing integration and click the icon ( trashcan icon ) in the Delete column.

  3. To confirm your action, click OK.