Help Center

Menu

Set up Matrix API Identifiers in the DXP Console

You set up the Matrix API Identifier in the DXP Console. This identifier is used to enable Content API access to the DXP Console, which in turn will be used inside the Component Service.

You have the opportunity to set the "friendliest" base URL for your Matrix CMS sites, that the Component Service will use to connect.

Before you start

  • Complete the Set up a Content API token in Matrix CMS topic.

  • If the target Matrix system has multiple base URLs, select the most appropriate ("friendliest") one for rendering URLs:

    • The base URL affects the algorithm that determines the URL to render when a site has multiple URLs applied.

    • For example, if your Matrix CMS instance has the URLs http://example.matrix.squiz.cloud/ and http://example.com/, selecting http://example.com/ would be considered the "friendliest" base URL on that Matrix CMS instance.

Steps

  1. Select Component Service in the DXP Console Dashboard for your organization.

  2. Select Matrix API Identifiers.

    This image shows the Component Service menu as displayed on the left-hand side of the DXP

  3. Select Add Matrix API Identifiers.

    add matrix api identifier

  4. In the Identifier name field, type a meaningful name for the identifier that represents the site or group of sites that the identifier will be set against. For example, Site-A_Group-1.

    You can use letters, numbers, underscores, and hyphens, but not spaces.

    add matrix api identifier panel

  5. In the API key field, paste the key from the Content API token you configured.

  6. In the API URL field, paste the friencliest base URL of the Matrix system you are using.

    Any links resolved using this API Identifier will resolve with the specified domain.

  7. Select Create to add the Matrix API identifier.