Skip to main content

Add Uniform integration

Adding the OrderCloud integration to your Uniform project adds new parameter types that you can add to your Uniform Canvas components.

Get connection settings

In order to configure a connection to OrderCloud, you need to retrieve several values that will enable Uniform to use the OrderCloud API:

  • Marketplace identifier
  • Client ID
  • Client secret

This step guides you through the process of retrieving these values.

Get marketplace identifier

  1. Log into the OrderCloud portal.
  2. Navigate to the API Console.
  3. Connect to your marketplace.
    About this step

    Note whether Sandbox is displayed next to the marketplace name. If it is, you will need the BASE URL value below this when you configure the integration in Uniform.

  4. Under the marketplace name, click Expand.
    About this step

    Note the marketplace identifier value. You will need this when you configure the integration in Uniform.

Create admin user

  1. In the left menu click Admin Users.
  2. Click the hamburger button to see a list of operations.
  3. Click POST Create a new admin user.
  4. Enter the required fields.
    About this step

    Make sure you mark the user active.

  5. Click Send.

Create security profile

  1. In the left menu click Security Profiles.
  2. Click the lightning bolt button to disable the Enhanced UI view.
  3. Click the hamburger button to see a list of operations.
  4. Click POST Create a new security profile.
  5. Enter the following values:
    FieldValue
    ID
    full-access-uniform
    Name
    Full Access Uniform
    Roles
    FullAccess
  6. Click Send.
  7. Click the hamburger button.
  8. Click POST Create or update a security profile assignment.
  9. Enter the following values:
    FieldValue
    Security Profile ID
    full-access-uniform
    User ID
    uniform
  10. Click Send

Create API client

  1. In the left menu click API Clients.
  2. Click Create New API Client.
  3. Enter the following values:
    FieldValue
    Application Name
    Uniform
    Enabled?
    yes
    Allow All Sellers
    yes
  4. Click Generate Random Client Secret.
    About this step

    Note the value that is generated. You will need this when you configure the integration in Uniform.

  5. Click Create New API Client.
  6. Click the new API client to return to its settings.
  7. Find the field Client ID.
    About this step

    Note the value. You will need this when you configure the integration in Uniform.

  8. For the field Default Context User, click the user uniform.
  9. Click Save Changes.

Add integration

This section describes how to add the OrderCloud integration to your Uniform project.

  1. In Uniform, open your project.

  2. Navigate to the Integrations tab.

  3. Scroll to the section Browse Integrations.

  4. Click Sitecore OrderCloud.

    add-integration-to-project
  5. Click Add to project.

    configuration-empty
  6. Enter the required fields.

    FieldDescription
    Client IDThe client ID from the OrderCloud API client.
    Client secretThe client secret from the OrderCloud API client.
  7. Enter the optional fields, if relevant.

    FieldDescription
    Base URLThis setting allows you to override the base URL for API calls to OrderCloud. This is an optional field.
    If you are using a sandbox environment

    This field is required if you are using an OrderCloud sandbox environment. You will need to change the Base URL value to the value in the OrderCloud API Console.

  8. Click Test to ensure the settings you entered are working correctly.

    About this step

    It is important to test the connection because saving the settings doesn't test if the settings work.

  9. Click Save.

Next steps

Explore the new parameter types that are available when you configure components using Uniform Canvas.