API Integrations

DataGuard CPM is built on an API-first architecture, meaning that every action within the platform can be performed programmatically through the API. This approach provides flexibility and control, enabling you to integrate DataGuard CPM seamlessly into your existing systems and workflows.

For detailed API documentation, please visit our API Documentation.

Authentication

There are two options for authenticating API requests:

• API Keys: A straightforward method for authenticating your API calls.
• OAuth 2.0: A more secure, token-based authentication method.

For more details on setting up authentication, see the API Authentication page.

Customer-Facing Integrations

For integrations that involve customer-facing applications, the Consent State endpoints are specially designed to support fetching and submitting data for custom consent capture points. These endpoints make it easy to integrate consent management directly into your user interfaces.

• How-To Guide: Learn how to set up a custom consent capture point using the Consent State endpoints in our How-to Guide.
• Postman Collection: Get started quickly by using our Postman Collection for the Consent State endpoints.

Backend Integrations

For integrating DataGuard CPM with other backend systems, the Webhook functionality is highly beneficial. Webhooks allow you to receive live updates on all Citizen changes, ensuring your systems stay in sync with the latest consent data.

• Webhook Documentation: Explore how to set up and use webhooks in our Webhook Documentation.

Importing Existing State

If you need to import existing consent and preference data into DataGuard CPM, this can be done both through the UI and automated over the API. This capability is essential for migrating data from other systems or setting up new environments.

• Import Documentation: Learn how to import data through the API by visiting our Import Documentation.

Exporting Current State

You can also export the current state of Citizens using the export job file functionality. Like importing, this can be managed through the UI or automated via the API, allowing you to easily back up or transfer data.

• Export Documentation: Find out how to automate data exports in our Export Documentation.

Summary

DataGuard CPM's API-first approach empowers you to fully integrate consent management into your existing systems, whether for customer-facing applications or backend processes. With comprehensive support for authentication, customer-facing integrations, webhook-based updates, and data import/export capabilities, you have the tools you need to create a robust and compliant consent management solution.