Getting Started

Welcome to the Redacto Consent Management Platform (CMP) developer documentation. This guide covers everything you need to integrate Redacto CMP into your systems using our SDKs and APIs.

Server Variables

To set up the integration, you will need the following values from the Redacto Console:

Variable	Description
`organisation_uuid`	Your organisation's unique identifier
`workspace_uuid`	The workspace where consent notices are configured
`CMS API Key`	Secret key for backend-to-Redacto authentication
`notice_uuid`	The specific consent notice you want to display

Important: The CMS API Key is a secret and should never be exposed to the frontend. Store it securely in your backend environment variables.

Authentication

Redacto CMP uses two authentication methods for different scenarios:

CMS API Key

The CMS API Key authenticates your backend servers when communicating with Redacto APIs. This is used for:

Generating JWT tokens for users
Refreshing JWT tokens
Managing consent users
Accessing user management APIs

Header Format:

X-CMS-API-KEY: your-cms-api-key-here

How to obtain:

Log in to the Redacto Console
Navigate to your workspace settings
Generate a new API key
Store it securely in your backend environment variables

JWT Auth

JWT (JSON Web Token) authentication is used by the Redacto frontend SDK to check and collect user consent. The flow works as follows:

Your backend generates a JWT token using the CMS API Key
Your frontend receives the token
The SDK uses this token to authenticate API calls

Header Format:

Authorization: Bearer <jwt-token>

Note: Token generation does not create consent users. Consent users are created when consent is submitted through the SDK, or when you explicitly create them via the User Management API.