O que é a API da AdOpt?
A API da AdOpt permite que nossos clientes conectem a AdOpt aos seus sistemas internos, aplicações e fluxos de trabalho.
Ela foi desenvolvida para oferecer suporte a integrações personalizadas com sistemas internos, CRMs, ERPs, portais de clientes, plataformas de análise, ferramentas de automação de processos e outras aplicações corporativas.
Dependendo do seu caso de uso, você também pode combinar APIs, Callbacks e Webhooks para criar fluxos automatizados de gestão de consentimento e privacidade.
Com a API, você pode:
Acessar dados da AdOpt;
Automatizar processos;
Integrar informações relacionadas ao consentimento com plataformas como CRMs, ERPs, portais de clientes, ferramentas de relatórios e outros sistemas corporativos.
Quando utilizada em conjunto com Callbacks e Webhooks, a API permite criar fluxos automatizados de privacidade e gerenciamento de consentimento, mantendo a conformidade com regulamentações como GDPR, LGPD, CCPA e outros frameworks de privacidade suportados.
Quem tem acesso?
O acesso à API da AdOpt está disponível exclusivamente para clientes do Plano Enterprise.
Os clientes Enterprise também têm acesso a:
Integrações via API;
Callbacks;
Webhooks;
SSO (Single Sign-On);
Gerente de Conta dedicado;
SLA de Suporte Prioritário.
Checklist
Antes de iniciar sua integração, verifique se:
☐ Possuo um plano Enterprise ativo;
☐ Tenho acesso à documentação técnica;
☐ Possuo credenciais válidas;
☐ Sei quais endpoints serão utilizados;
☐ Validei os requisitos técnicos com minha equipe;
☐ Identifiquei se preciso utilizar APIs, Callbacks, Webhooks ou uma combinação entre eles;
☐ Revisei os requisitos de autenticação;
☐ Planejei o processo de testes e implantação.
Como acessar a documentação
A documentação técnica completa está disponível em:
Solicite a senha de acesso entrando em contato com nossa equipe (acesso exclusivo para clientes Enterprise).
A documentação inclui:
Instruções de autenticação;
Endpoints disponíveis;
Exemplos de requisições e respostas;
Documentação de Callbacks;
Documentação de Webhooks;
Guias de integração;
Recursos avançados para desenvolvedores.
💡 Dica: Recomendamos revisar toda a documentação antes de iniciar qualquer implementação.
Como obter suas credenciais
As credenciais utilizadas para autenticação na API são as mesmas da sua conta AdOpt.
Para acessar a API:
Faça login utilizando as credenciais da sua conta AdOpt;
Revise os requisitos de autenticação descritos na documentação;
Utilize as credenciais da sua conta sempre que solicitado pelos endpoints da API.
Caso você ainda não possua acesso a uma conta Enterprise, entre em contato conosco. Teremos o prazer em ajudá-lo durante esse processo.
Se você esqueceu sua senha, poderá redefini-la pelo seguinte link:
Principais recursos disponíveis
O ecossistema da API da AdOpt oferece diversos recursos para integrar informações de privacidade e consentimento aos seus sistemas.
Entre os recursos disponíveis estão:
Informações de consentimento;
Solicitações dos titulares de dados;
Eventos do banner de cookies;
Logs de consentimento;
Ações dos usuários;
Dados da organização;
Gerenciamento de websites e banners;
Automação de fluxos de privacidade.
Além disso, a AdOpt oferece integração com:
Google Tag Manager (GTM);
Google Consent Mode;
TCF (Transparency & Consent Framework);
GPC (Global Privacy Control);
GPP (Global Privacy Platform);
WordPress;
Tray Commerce;
Aplicações e plataformas personalizadas.
APIs vs. Callbacks e Webhooks
Embora normalmente sejam utilizados em conjunto, APIs, Callbacks e Webhooks possuem finalidades diferentes.
API
A API permite que seus sistemas consultem informações da AdOpt sempre que necessário.
Exemplos:
Recuperar informações de consentimento;
Consultar registros;
Sincronizar dados com sistemas internos;
Criar dashboards e relatórios personalizados.
💡 Dica: Se o seu sistema precisa consultar informações sob demanda, a API normalmente é a melhor opção.
Callbacks
Os Callbacks notificam seu website ou aplicação sempre que um visitante atualiza suas preferências de consentimento.
Esse recurso é especialmente útil quando o front-end precisa reagir imediatamente às alterações de consentimento, por exemplo:
Habilitar ou desabilitar rastreadores;
Exibir conteúdos específicos;
Atualizar o comportamento da aplicação.
Webhooks
Os Webhooks enviam automaticamente informações da AdOpt para seus sistemas quando determinados eventos acontecem.
Casos de uso mais comuns:
Solicitações dos titulares de dados;
Solicitações de opt-out;
Solicitações de download de dados;
Automação de fluxos de trabalho;
Integrações com CRM e sistemas de atendimento (ticketing).
💡 Dica: Se o seu sistema precisa receber notificações em tempo real, os Webhooks geralmente são a melhor alternativa.
Boas práticas de implementação
Para garantir uma implementação segura e eficiente, recomendamos:
Revisar toda a documentação antes de iniciar o desenvolvimento;
Identificar previamente os endpoints e eventos necessários;
Testar todas as integrações em ambiente controlado antes da implantação em produção;
Validar os requisitos de autenticação e permissões;
Registrar (logar) todas as requisições e respostas da API durante a implementação;
Monitorar a entrega dos Webhooks e a execução dos Callbacks;
Seguir as políticas de segurança e governança de dados da sua organização;
Manter a documentação interna da integração sempre atualizada.
Em projetos de maior porte, recomenda-se envolver desde o início tanto a equipe técnica quanto os responsáveis por privacidade e compliance.
Onde obter suporte técnico
Se precisar de ajuda durante a implementação: