Skip to main content

LiveRamp Clean Room API Configuration

Abstract

This topic explains how to use the Clean Room UI to generate an API key, add the API user to an organization, and add the API user to a clean room.

The Clean Room API enables you to set up and manage clean rooms and create and run clean room queries without going through the UI. This is most useful for performing actions in bulk or for integrating Clean Room API features directly into your own platform.

For more information, see the LiveRamp Clean Room API documentation on the LiveRamp developer portal.

Overall Steps

You can use the Clean Room UI to do the following:

  1. Generate an API key (also known as an "API secret") and create an associated API user service account.

  2. Confirm the API user has been added to the organization.

  3. Add the API user to a clean room.

Generate an API Key

Procedure. To generate an API key:

  1. Go to the organization where you want to enable the API. In the main menu, select Admin → Manage API Key.

  2. Click Generate New Key. A dialog displays the API secret.

    mceclip0.png

  3. Click Copy to Clipboard and securely store the API secret. You need it for later steps, and it will not be shown again. Also, take note of the client ID.

Confirm the API User Has Been Added to the Organization

Procedure. To verify that the API user was added to the organization:

  • Go to Admin → Users. Confirm that a user has been created for the API Key with the API Administrator role.

Add the API User to a Clean Room

Procedure. To add the API user to a clean room:

  1. Go to the clean room where you want to enable the API.

  2. From the Clean Room menu, select Partners & Users.

  3. Click Add New User. The Organization Users dialog appears.

    mceclip1.png

  4. Assign the Admin permission to the API user, and then click Add User.

In this section: