Documentação Serviços Abril ID

Voltar

Guia de integração rápida do Abril ID para sites terceiros para a orientação de desenvolvedores

Legenda:

  • * Campos Obrigatórios
  • obj Retorna postMessage ou window location; É retornado um JSON nos demais métodos.

Métodos

Método para cadastro de novos usuários no sistemas de autenticação

https://authp.abril.com.br/services/auth/

[payload]

  • Método = cadastro
  • email *
  • password *
  • confirmPassword *
  • firstName *
  • lastName *
  • urlRetorno

 

[response]

{
status: success,
msg: O cadastro foi feito com sucesso. Aguardando ativação de conta
}

[error]

{
status: error,
msg: “Este e-mail já está registrado, clique aqui para entrar | Senhas não conferem | Erro ao cadastrar usuário”
}


Método para verificar se o usuário já está cadastrado com o e-mail especificado, se email verificado valido, enviar codigo de verificação se email ja existir na base de dados ou invalido exibe mensagem de erro.

https://authp.abril.com.br/services/auth/

[payload]

  • Método = checaUsuarioCadastrado
  • email *

 

[response]

{
status: success,
msg:”
}

[error]

{
status: error,
msg: “Erro ao verificar o cadastro”
}

{
status: “error”,
msg: “Este e-mail já está registrado, clique aqui para entrar.”,
field: “email”
}

{
status: “error”,
msg: “Ocorreu um erro ao validar o e-mail”,
field: “email”
}


Método para confirmação de usuário, quando usuario logado envia codigo de confirmação para o email, validando o codigo, libera acesso no Abril ID, se erro exibe mensagem de erro.

https://authp.abril.com.br/services/auth/

[payload]

  • Método = confirmCadastro
  • email *,
  • confirmCode *,
  • urlRetorno

 

[response]

obj:
{
action: acessar,
status: success,
urlRetorno: editar-conta
}

[error]

obj:
{
action: acessar,
status: error,
urlRetorno: status=error&msg=Erro ao confirmar o cadastro
}


Método para login do usuário, se login valido loga usuario no Abril ID, se não exibe mensagem de erro.

https://authp.abril.com.br/services/auth/

[payload]

  • Método = login
  • email *,
  • password *,
  • urlRetorno

 

[response]

obj:
{
action: acessar,
status: success,
urlRetorno: editar-conta
}

[error]

obj:
{
action: acessar,
status: error,
urlRetorno: acessar
}

obj:
{
action: migrate,
status: error,
urlRetorno: nova-senha-migrados
}


Método que verifica usuários migrados de sites terceiros.

https://authp.abril.com.br/services/auth/

[payload]

  • Método = userInfo
  • email *,
  • password *

 

[response]

{
status: success,
msg:
{
first_name: “Primeiro Nome”,
last_name: “Sobrenome”,
email: “email@email.com”
}
}

[error]

{
status: error,
url: conta_inativa,
msg: Credenciais inválidas
}

{
status: error,
url: credenciais_invalidas,
msg: Conta migrada, necessita troca de senha
}

{
status: error,
url: bloqueio_temporario,
msg: Limite de tentativas excedido. Tente novamente em alguns minutos.
}


Método que desloga Usuario do sistema.

https://authp.abril.com.br/services/auth/

[payload]

  • Método = logout
  • urlRetorno,
  • loadCard

 

[response]

obj:
{
action: ‘logout’,
status: ‘success’,
urlRetorno: acessar
}

obj:
{
action: ‘logout_card’,
status: ‘success’
}

[error]

{
status: error,
msg: Voce ainda está Logado | Você não está logado | Você está logado
}


Método que recupera o token de acesso, verificando se usuario esta logado no sitema.

https://authp.abril.com.br/services/auth/

[payload]

  • Método = regenerateAccess
  • refreshtoken

 

[response]

{
status: ‘success’,
msg: Usuário logado com sucesso
}

[error]

{
status: ‘error’,
msg: ‘Erro ao atualizar token’
}

{
status: ‘error’,
msg: ‘Erro ao atualizar’
}


Método que cria um novo token de acesso, se token criado é valido usuario se loga com sucesso.

https://authp.abril.com.br/services/auth/

[payload]

  • Método = getAccessToken
  • refreshtoken

 

[response]

{
status: ‘success’,
msg: Usuário logado com sucesso
}

[error]

{
status: ‘error’,
msg: ‘Erro ao atualizar token’
}


Método que Retorna os dados do usuário logado.

https://authp.abril.com.br/services/auth/

[payload]

  • Método = getUsuario
  • accessToken

 

[response]

obj:
{
UserId: ID Usuario,
UserName: email@email.com.br,
firstName: “Primeiro Nome”,
lastName: “Sobrenome”
}

[error]

obj:
{
status: ‘error’,
msg: false

}


Este Método Faz a requisição no serviço para atualizar os dados do usuario no Abril ID.

https://authp.abril.com.br/services/auth/

[payload]

  • Método = updateUsuario
  • email *
  • newEmail *
  • confirmNewEmail *
  • passwordCheck *
  • oldPassword *
  • newPassword *
  • confirmNewPassword *
  • firstName *
  • secondName
  • lastName *
  • nickName
  • gender
  • cpf *
  • cnpj *
  • birthdate
  • endereco
  • numero
  • cep
  • complemento
  • bairro
  • cidade
  • estado
  • sectionUpdate
  • urlRetorno

 

[response]

obj:
{
status: success,
msg: Cadastro atualizado com sucesso!
}

[error]

obj:
{
status: error,
sectionUpdate: identidadeSection,
msg: Primeiro nome não pode ser vazio | Nome inválido. | Último nome não pode ser vazio. | Último nome inválido.
}

obj:
{
status: error,
sectionUpdate: emailSection,
msg: O e-mail antigo não pode ser vazio. | O novo e-mail não pode ser vazio. | A confirmação de email não pode ser vazia. | A confirmação da e-mail é diferente.
}

obj:
{
status: error,
sectionUpdate: perfilSection,
msg: Primeiro nome não pode ser vazio | Nome inválido. | Último nome não pode ser vazio. | Último nome inválido. | Apelido inválido. | O CPF está com o valor inválido. | CPF incorreto | CNPJ Incorreto | CNPJ incorreto. | Data de nascimento está com valor inválido. | Data de Fundação está com valor inválido.
}

obj:
{
status: error,
sectionUpdate: enderecoSection,
msg: CEP inválido. | Endereço inválido. | Número inválido. | Complemento inválido | Complemento inválido. | Bairro inválido. | Bairro inválido. | Cidade inválida. | Estado inválido.
}

obj:
{
status: error,
sectionUpdate: segurancaSection,
msg: Senha atual não pode ser vazia. | A confirmação da senha é diferente.
}


Método para verificar no middleware se o usuário esta logado.

https://authp.abril.com.br/services/auth/

[payload]

  • Método = verifyUserLoged

 

[response]

obj:
{
status: success,
msg: Usuário logado
}

[error]

obj:
{
status: ‘error’,
msg: Inconsistência nos dados, por favor, logue novamente. | O usuário não esta logado.
}


Método para gerar código de renovação de senha do usuário e enviar por e-mail,

https://authp.abril.com.br/services/auth/

[payload]

  • Método = forgotPassword,
  • email *

 

[response]

obj:
{
status: success,
msg:”
}

[error]

{
status: ‘error’,
field: email,
msg: E-mail não cadastrado. | Sua conta não foi ativada, clique aqui para fazer a validação. | Muitas tentativas no mesmo email
}


Método que reenvia código de ativação de conta,

https://authp.abril.com.br/services/auth/

[payload]

  • Método = resendCode,
  • email *

 

[response]

obj:
{
status: success,
msg: E-mail reenviado com sucesso.
}

[error]

{
status: ‘error’,
msg: E-mail inválido | Você só pode enviar nova mensagem daqui a 15 minutos | Essa conta já foi ativada, tente recuperar sua senha
}


Método para confirmação de reset de senha do usuário através do código gerado no Método anterior

https://authp.abril.com.br/services/auth/

[payload]

  • Método = confirmForgotPassword,
  • email *,
  • confirmCode *,
  • newPassword *,
  • confirmNewPassword *,
  • urlRetorno

 

[response]

{
action: acessar,
status: success,
msg: Senha alterada com sucesso

}

obj:
{
action: acessar,
status: success,
urlRetorno: editar-conta
}

[error]

{
status: ‘error’,
msg: Código inválido. Verifique seu e-mail.
}

{
action: acessar,
status: error,
msg: Código inválido. Verifique seu e-mail.,
field: confirmCode,
urlRetorno: /nova-senha/erro/codigo-invalido
}

{
action: acessar,
status: error,
msg: Código inválido. Verifique seu e-mail.,
field: email,
urlRetorno:/nova-senha/erro/codigo-email-invalido
}

{
action: acessar,
status: error,
msg: Muitas tentativas no mesmo email.,
field: email,
urlRetorno: /nova-senha/erro/acessos
}

{
action: acessar,
status: error,
msg: Senhas não conferem,
field: email,
urlRetorno: /nova-senha/erro/senhas
}


Método que habilita o usuário a usar a rede social na conta padrão

https://authp.abril.com.br/services/auth/

[payload]

  • Método = linkUserSocialLogin

 

[response]

{
status: success,
msg: Usuário cadastrado com sucesso.
}

[error]

{
status: error,
msg: Não foi possível associar usuário ao perfil da rede social
}


Método que registra usuário com o login de rede social

https://authp.abril.com.br/services/auth/

[payload]

  • Método = socialSignIn,
  • identityProvider *,
  • urlRetorno,
  • accessToken *

 

[response]

{
status: success,
msg: Usuário cadastrado com sucesso.
}

[error]

{
status: error,
msg: E-mail já existente.
}


Método para login do usuário via rede social

/services/auth

[payload]

  • Método = socialLogin,
  • identityProvider *,
  • urlRetorno,
  • accessToken *

 

[response]

{
status: success,
email: email@email.com.br,
username: email@email.com.br,
password: Senha do Usuario
}

[error]

{
status: error,
msg: Erro ao identificar o usuário na rede social.
}

{
status: error,
msg: E-mail já existente.
url: acessar/erro/email-existente
}


Método para update do Avatar(Foto de Perfil)

https://authp.abril.com.br/services/auth/

[payload]

  • Método = updateAvatar,
  • urlAvatar *

 

[response]

obj
{
action: edicao_avatar,
status: success,
msg: Avatar atualizado com sucesso
}

[error]

obj
{
action: edicao_avatar,
status: error,
msg: Erro ao atualizar o Avatar do usuário.
}