Configurando preferências para Aplicativos
Caso você possua vários aplicativos você pode criar uma chave de API para cada um e configurar diferentes preferências para cada aplicação.
Passo 1 - Crie a sua aplicação
Acesse o menu “SDK Mobile” e clique no botão “Adicionar novo app”, ao clicar neste botão exibirá os seguintes campos:
Nome do aplicativo mobile - Defina o nome do seu aplicativo, este nome será exposto na tela de gerenciamento de preferencias.
Aviso de privacidade - Preencha com o link da politica que deseja ser exibida, ao clicar em ‘Aviso de privacidade’ na plataforma, será direcionado para este link.
Logo - Escolha o logotipo a ser exibido na tela de gerenciamento de preferencias.
Tipos de extensões aceitas: .svg, .png, .jpg, .jpeg e .gif
Tamanho máximo do logotipo: 250 kb.
CSS - Neste espaço, é possível editar o estilo da tela que será apresentada para o usuário, utilizando a linguagem de folhas de estilo CSS.
Passo 2 - Configure as preferência de cada aplicativo
Após criar a sua aplicação, clique no botão “+” para adicionar novas preferências. A plataforma sugere alguns tipos de preferências comuns em aplicativos como:
Push - Autorização para Receber notificações
Storage - Permissão para ler e gravar no storage
Camera - Permissão para utilizar a câmera do dispositivos
GPS - Autorização para coleta da localização em GPS
Caso a sua preferência não esteja na lista basta criar uma personalizada. O campo “Código da Permissão” é muito importante pois é com ele que o desenvolvedor do aplicativo irá trabalhar para detectar mudanças de preferências.
Edição de Layout
Após a criação do layout da tela de gerenciamento de preferencias, há a possibilidade de edição, para isso:
Selecione o aplicativo criado anteriormente, clicando no nome do aplicativo mobile.
Nesta tela para onde você será direcionado, aparecerá novamente os campos, para que você possa realizar as edições.
Após realizar as edições, basta selecionar o botão ‘Salvar’.
Ao pressionar o botão amarelo ‘Visualizar’, ao lado direito do campo ‘API Key’ poderá ser visualizado as suas modificações.
As modificações realizadas no layout, podem demorar até 75 minutos, para que sejam refletidas no visualizador.
Acompanhando logs e auditoria
Na lista de aplicações você pode clicar ainda no último ícone na direita para acessar os logs de auditoria das autorizações dos usuários.
Manual de Integração
Variáveis
Em sua área interna na sessão “SDK Mobile” você tem à disposição as variáveis:
API_KEY | Chave da API para integração com o backend |
PUBLIC_KEY | Chave pública para criptografia |
PRODUCTION | Envie “true” caso esteja usando ambiente de produção ou “false” em caso de testes em sandbox |
PERMISSION_CODE | É o código de cada preferência do usuário |
Android - Instruções de instalação
Bibliotecas necessárias:
implementation "org.bouncycastle:bcprov-jdk15on:1.60" implementation "org.bouncycastle:bcpkix-jdk15on:1.60" privacymodule-release.aar <-- Você pode fazer o download dessa biblioteca na sua área interna
Inicialização
PrivacyBuilder.init( "API_KEY", "PUBLIC_KEY", "PRODUCTION", "Seu objeto Context"); // Habilitar Console PrivacyLog.getInstance().debug = switchDebugConsole.isChecked //Ler o Listener - opção para o programador ler os logs como dado PrivacyLog.getInstance().delegate = PrivacyLog.PrivacyLogDelegate { text -> activity?.runOnUiThread { print("Recebeu " + text) } }
Comando para abrir a popup
PrivacyBuilder.showPrivacyPreferences("Seu objeto activity");
Comando para criar eventos
PrivacyBuilder.addPrivacyEvent("Permission code",PrivacyEvent(){ public void onAuthorize(){ //on authorize permission } public void onForbidden(){ //on remove permission } });
Adicionar o seguinte trecho para ler eventos da janela:
PrivacyBuilder.addPreferenceEvents(object: PreferenceEvent { override fun onClose() { println("onCLose") } override fun onSave() { println("onSave") } })
IOS - Instruções para instalação
Adicionar o framework ao projeto
Embed o arquivo PrivacyConsentMobile.framework ao projeto. O arquivo você encontra em sua área interna.
Importar o módulo no código-fonte
import PrivacyConsentMobile
Adicionar o delegate à classe
class ViewController: UIViewController, ConsentDelegate { func onAuthorize(code: String) { print ("onAuthorize -> \(code)") } func onForbidden(code: String) { print ("onForbidden -> \(code)") } }
Chamar a tela de Preferências
let APIKEY = "SUA API_KEY" let PUBLICKEY = "SUA PUBLIC_KEY" ... let consentBuilder = ConsentBuilder() consentBuilder.delegate = self let controller = consentBuilder.showConsent(apiKey: APIKEY, publicKey: PUBLICKEY, production: false) controller.modalPresentationStyle = .fullScreen self.present(controller, animated: true, completion: nil) ...
Implementar o protocolo PreferencesDelegate
func onSave() { print ("onSave ->") } func onClose() { print ("onClose ->") } //Assinar o delegate consentBuilder.preferencesDelegate = self
Download das bibliotecas iOS e Android
Segue abaixo o download da biblioteca iOS(para Xcode 12.4)
Segue abaixo o download da biblioteca iOS(para Xcode 11.3)
Segue abaixo o download da biblioteca Android