Acessar o SDK Javascript no seu site
Quando carregado no seu site, o Axeptio expõe uma instância JS de nossa classe SDK, que contém métodos e informações úteis. Com esse objeto, você pode personalizar propriedades em tempo de execução ou exibir qualquer widget configurado no seu projeto.
Usar uma função de retorno (callback) para obter uma referência ao SDK
Como o SDK é carregado de forma assíncrona, ele pode não estar disponível no momento em que você executa seu próprio código. Para ser notificado quando o objeto axeptioSDK estiver pronto, você deve usar uma variável nomeada _axcb (para Axeptio Callbacks). Aqui está um trecho de código:
window._axcb = window._axcb || [];window._axcb.push(function(sdk){ // aqui, você poderá acessar aos métodos e propriedades // da instância SDK do Axeptio.});Na primeira linha, acessamos o array _axcb se ele já existir, ou o criamos. Esta é uma técnica abreviada para "acessar ou criar" uma variável em JavaScript.
Em seguida, adicionamos uma função de retorno a esse array usando o método push(). O conteúdo dessa função será executado somente depois que o script do Axeptio for carregado e a configuração do projeto for recuperada de nosso CDN. Não se preocupe se o Axeptio já estiver carregado, sua função de retorno será chamada imediatamente.
Alternativa: usar o objeto window.axeptioSDK
Quando o Axeptio está pronto, ele cria vários métodos e objetos diretamente no escopo global window.
axeptioSDK: instância do objeto SDK.
axeptioBuildTimestamp: data e hora da construção do script SDK. Usado para resolver problemas de cache.
openAxeptioCookies(settings): chame esta função para abrir o widget de cookies. Você pode passar um objeto com parâmetros adicionais, como
currentStepIndex,onComplete,onEvent,userChoices. Se você precisar de ajuda para usar esses parâmetros, entre em contato conosco.showAxeptioButton(): esta função exibe o botão Axeptio no canto da página, se estiver oculto.
hideAxeptioButton(): esta função oculta o botão Axeptio no canto da página, se estiver visível.
Como o SDK Axeptio pode não estar carregado no momento em que você executa seu próprio código, recomendamos usar o método com função de retorno.
Anatomia do SDK Axeptio
Métodos
sdk.openCookies(settings)
Alias de openAxeptioCookies, este método abre o widget de consentimento para a cookiesVersion atual.
sdk.createConsentCheckbox()
Cria uma caixa de seleção para um widget de processamento de dados correspondente.
sdk.createConsentButton()
Cria um botão de consentimento para um widget de processamento de dados correspondente.
sdk.setCookiesVersion(version)
Especifica a versão de cookies a usar. Este método pode ser usado em tempo de execução para mudar de idioma, por exemplo.
sdk.setToken(token)
Especifica o token de usuário a ser usado para futuras coletas de consentimento.
sdk.getToken()
Retorna o token de usuário Axeptio para a sessão atual.
sdk.hasAcceptedVendor(vendor)
Retorna um booleano indicando se o usuário aceitou o uso de um serviço específico.
Observação: o serviço é um identificador em forma de cadeia de caracteres que você pode definir na administração do Axeptio.
sdk.requestConsent(vendor, onConsent)
Solicita consentimento para um serviço específico. Retorna uma promessa que se resolve quando o consentimento é concedido e é rejeitada quando não é.
Propriedades
sdk.settings
Um objeto contendo as configurações do SDK (relacionadas ao site).
sdk.userPreferencesManager
Um objeto contendo as preferências e métodos utilitários para gerenciar as preferências dos usuários.
sdk.config
A configuração completa gerada por nossa API ao publicar o projeto.
sdk.template
O projeto de modelo usado se o Axeptio for integrado a um serviço específico (Typeform, etc.).