What is the AdOpt API?
The AdOpt API allows our customers to connect AdOpt with their internal systems, applications, and workflows.
It was designed to support custom integrations with internal systems, CRMs, ERPs, customer portals, analytics platforms, workflow tools, and other business applications. Depending on your use case, you may also combine APIs, Callbacks, and Webhooks to build automated consent and privacy workflows.
Using the API, you can:
Access AdOpt data;
Automate Processes;
Integrate consent-related information with platforms such as CRMs, ERPs, customer portals, reporting tools, and other business systems.
Combined with Callbacks and Webhooks, the API helps organizations create automated privacy and consent management workflows while maintaining compliance with privacy regulations such as GDPR, LGPD, CCPA, and other supported frameworks.
Who Has Access?
Access to the AdOpt API is available exclusively for customers subscribed to the Enterprise Plan.
Enterprise customers also have access to:
API integrations;
Callbacks;
Webhooks;
SSO (Single Sign-On);
Dedicated Account Manager;
Priority Support SLA.
Checklist
Before starting your integration:
☐ I have an active Enterprise plan
☐ I have access to the documentation
☐ I have valid credentials
☐ I understand which endpoints I need
☐ I have validated the technical requirements with my team
☐ I have identified whether I need APIs, Callbacks, Webhooks, or a combination of them
☐ I have reviewed authentication requirements
☐ I have planned my testing and deployment process
How to Access the Documentation
The complete technical documentation is available at: 🔗 AdOpt API. Ask for the password for your account by talking to us (exclusive for Enterprise clients).
The documentation includes:
Authentication instructions
Available endpoints
Request and response examples
Callback documentation
Webhook documentation
Integration guides
Advanced developer resources
💡 Tip: We recommend reviewing the documentation before starting any implementation.
How to Obtain Your Credentials
Your API credentials use the same authentication credentials as your AdOpt account.
To access the API:
Log in using your AdOpt account credentials.
Review the authentication requirements described in the documentation.
Use your account credentials when required by the API endpoints.
If you do not have access to an Enterprise account, please contact us — we will be more than happy to help you through this process.
If you forgot your password, you can reset it through the following link:
Key Features and Available Resources
The AdOpt API ecosystem includes several resources designed to help you integrate privacy and consent data into your systems.
Available resources include:
Consent information;
Data subject requests;
Cookie banner events;
Consent logs;
User actions;
Organization data;
Website and banner management;
Privacy workflow automation.
Additionally, AdOpt supports integrations with:
Google Tag Manager (GTM);
Google Consent Mode;
TCF (Transparency & Consent Framework);
GPC (Global Privacy Control);
GPP (Global Privacy Platform);
WordPress;
Tray Commerce;
Custom applications and platforms.
APIs vs. Callbacks/Webhooks
Although they are often used together, APIs and Callbacks/Webhooks serve different purposes.
API
The API allows your systems to actively request information from AdOpt whenever needed.
Examples:
Retrieving consent information;
Querying records;
Synchronizing data with internal systems;
Building custom dashboards and reports.
💡 Tip: If your system needs to retrieve information on demand, the API is typically the best choice.
Callbacks
Callbacks notify your website or application when a visitor updates their consent preferences.
This is useful when your front-end needs to immediately react to consent changes, such as:
Enabling or disabling trackers;
Showing specific content;
Updating application behavior.
Webhooks
Webhooks automatically send information from AdOpt to your systems when specific events occur.
Common use cases include:
Data subject requests;
Opt-out requests;
Data download requests;
Workflow automation;
CRM and ticketing integrations.
💡 Tip: If your system needs real-time notifications, Webhooks are usually the best option.
Implementation Best Practices
To ensure a smooth implementation, we recommend:
Reviewing the documentation before development begins;
Identifying the required endpoints and events in advance;
Testing all integrations in a controlled environment before production deployment;
Validating authentication and permission requirements;
Logging API requests and responses during implementation;
Monitoring webhook deliveries and callback execution;
Following your organization's security and data governance policies;
Keeping integration documentation updated internally.
For larger projects, involving both technical and compliance stakeholders early in the process is highly recommended.
Where to Get Technical Support
If you need assistance during implementation:
Review the official documentation.