Documentação abrID JS

Voltar

Guia para uso da biblioteca para integração do Abril ID com sites terceiros.

O que é e para o que serve

O abrID.js é uma biblioteca que possibilita a rápida integração das principais funções do Abril ID com outros sites. O objetivo dessa documentação é orientar a forma que os métodos disponibilizados devem ser usados, para reduzir a chance de erros e padronizar o desenvolvimento entre as equipes.

Localização:

Instalação

Adicione a tag script com a URL da biblioteca antes da tag </body> na sua página.

Exemplo:

https://id.abril.com.br/abrID

Insira também a folha de estilos na tag <head> para que o modal seja exibido corretamente.

Exemplo:

<link rel=”stylesheet” href=”https://id.abril.com.br/abrIDCss”&gt;

Para o card do Abril ID, é necessário o uso de uma tag

com um ID para ser identificado pela função abrID.init().
O card serve como um botão para exibir a área do perfil do usuário, e também como um botão para login/logout.

Exemplo:

Funções

abrID.init(array{ELEMENTO, URL})

Inicialização da biblioteca abrID. Após o carregamento da página, é necessário utilizar essa função para criar o card que receberá as informações da biblioteca.

Geralmente utiliza-se após a tag script do abrID, junto de um listener para verificar se a página está carregada.

Exemplo de utilização:

document.addEventListener(‘DOMContentLoaded’, function(event) {
if(typeof abrID !== ‘undefined’) {
abrID.init({
‘abrIDCardElement’: ‘abrilID’, // ID DA DIV QUE TERÁ O CARD
‘wpAbrilIDUrl’: ‘https://id.abril.com.br/&#8217; // URL DO TEMA WP-THEME-ABRIL-ID
});
}
});

Parametros esperados:

  • abrIDCardElement = ID do elemento que receberá o card do ABRIL ID
    wpAbrilIDUrl = URL do ABRIL ID

abrID.acessar()

Exibe a tela de login do Abril ID dentro do modal.

Pode ser usado dentro de um elemento HTML como a tag a, entre outras tags que estejam sendo usadas como botão chamada para a ação de login.

Exemplo de utilização:

<button onclick=”abrID.acessar()”>Fazer login</button>

Também é possível utilizar callback para verificar o resultado da função.

Exemplo de utilização:

<button onclick=”abrID.acessar({‘callback’:’callback_success’})”>Fazer login</button>

Para verificar o callback:

var callback_success = function(data = null) {
if(data.action == ‘acessar’ && data.status == ‘success’){ console.log(‘Login efetuado com sucesso!’)
}


abrID.criarConta()

Exibe a tela de cadastro do Abril ID dentro do modal.

Exemplo de utilização:

<button onclick=”abrID.criarConta()”>Criar conta</button>

Também é possível utilizar callback para verificar o resultado da função.

Exemplo de utilização:

<button onclick=”abrID.criarConta({‘callback’:’callback_success’})”>Criar conta</button>

Para verificar o callback:

var callback_success = function(data = null) {
if(data.action == ‘cadastro’ && data.status == ‘success’) console.log(‘Cadastro realizado com sucesso’)
}


abrID.confirmarConta()

Exibe a tela de de confirmação de conta no modal, para preenchimento do código e email do usuário.

Exemplo de utilização:

<button onclick=”abrID.confirmarConta()”>Confirmar minha conta</button>

Também é possível utilizar callback para verificar o resultado da função.

Exemplo de utilização:

<button onclick=”abrID.confirmarConta({‘callback’:’callback_success’})”>Confirmar minha conta</button>

Para verificar o callback:

var callback_success = function(data = null) {
if(data.action == ‘confirmacao’ && data.status == ‘success’) console.log(‘Conta confirmada com sucesso!’)
}


abrID.esqueciSenha()

Inicia o fluxo de recuperação de senha, para o usuário receber um código ao preencher o email.

Exemplo de utilização:

<button onclick=”abrID.esqueciSenha()”>Esqueci minha senha</button>

Também é possível utilizar callback para verificar o resultado da função.

Exemplo de utilização:

<button onclick=”abrID.esqueciSenha({‘callback’:’callback_success’})”>Esqueci minha senha</button>

Para verificar o callback:

var callback_success = function(data = null) {
if(data.action == ‘esqueceu_senha’ && data.status == ‘success’) console.log(‘Códgigo de recuperação de senha enviado com sucesso!’)
}


abrID.novaSenha()

Exibe a página para o usuário alterar a senha usando o código enviado para o email.

Exemplo de utilização:

<button onclick=”abrID.novaSenha()”>Alterar senha</button>

Também é possível utilizar callback para verificar o resultado da função.

Exemplo de utilização:

<button onclick=”abrID.novaSenha({‘callback’:’callback_success’})”>Alterar senha</button>

Para verificar o callback:

var callback_success = function(data = null) {
if(data.action == ‘renova_senha’ && data.status == ‘success’) console.log(‘Senha renovada com sucesso!’)
}


abrID.sairCard()

Realiza logout do usuário.

Exemplo de utilização:

<button onclick=”abrID.sairCard()”>Fazer logout</button>

Também é possível utilizar callback para verificar o resultado da função.

Exemplo de utilização:

<button onclick=”abrID.sairCard({‘callback’:’callback_success’})”>Fazer logout</button>

Para verificar o callback:

var callback_success = function(data = null) {
if(data.action == ‘logout’ && data.status == ‘success’) console.log(‘Usuário deslogado com sucesso!’)
}


abrID.sair(‘string_URL’)

Realiza logout do usuário e redireciona para uma URL específica.

Exemplo de utilização:

<button onclick=”abrID.sair(‘string_URL’)”>Fazer logout</button>

Também é possível utilizar callback para verificar o resultado da função.

Exemplo de utilização:

<button onclick=”abrID.sair({‘callback’:’callback_success’,’url’:’string_URL’})”>Fazer logout</button>

Para verificar o callback:

var callback_success = function(data = null) {
if(data.action == ‘logoutRetorno’ && data.status == ‘success’) {
console.log(‘Usuário deslogado com sucesso!’);
}
}


abrID.status()

Retorna objeto com informações sobre o usuário autenticado.
Caso o usuário não estiver autenticado, o retorno será false

Exemplo de utilização:

var nome = abrID.status().name;
$(‘#labelNome’).innerHTML = nome;

Atributos disponíveis:

  • email
  • idp (qual identity provider de origem do usuário)
  • lastName (Sobrenome do usuário)
  • name (Primeiro nome do usuário)
  • picture (URL com a imagem do avatar do usuário)

abrID.loadAbrIDcard(‘string_ELEMENTO’)

Insere o card do Abril ID como filho do elemento especificado.
Essa função é iniciada juntamente do abrID.init();

Exemplo de utilização:

<button onclick=”abrID.loadAbrIDcard(‘abrilIDCard’)”>Carregar card</button>


abrID.loadAbrIDcard(‘string_ELEMENTO’)

Valida se a autenticação do usuário está ativa de forma assíncrona e em caso de sucesso, executa o callback fornecido no parâmetro do método. Pode ser útil em casos de manipulação de dados sensíveis como updates ou alteração de dados

Exemplo de utilização:

abrID.verificaLogin(function() {
console.log(“Usuário autenticado”);
});