Account
Serviço responsável pela criação, alteração e autenticação das contas de acesso.
Contas de acesso podem pré-existir caso criadas pela loja do cliente. Nestes cenários o usuário adquire ingressos para acesso as dependencias do cliente utilizando uma conta de acesso, seja pré-existente ou criada durante a compra do ingresso.
A conta de acesso criada durante a aquisição do ingresso deve ser utilizada pelo usuário no aplicativo. Desta forma, todos as contas de consumos criadas a partir dos ingressos serão automaticamente vinculadas.
Login
Valida um nome de usuário e uma senha para autenticação da conta de acesso.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| data | LoginData | Dados para autenticação. Obrigatório. |
Retorno
| Tipo | Descrição |
|---|---|
| LoginResult | Se autenticado, retorna os dados do usuário autenticado. Senão dispara erro. |
RememberPassword
Solicita o lembrete de senha. Ao solicitar o lembrete, será enviada um e-mail contendo a senha no corpo do e-mail. A conta de acesso existente será localizada pelo e-mail informado.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| String | E-mail do usuário cadastrado. Obrigatório. Tamanho: 50. |
Retorno
Este método não possui retorno.
Create
Cria uma nova conta de acesso.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| data | CreateData | Dados para criação da conta de acesso. Obrigatório. |
Retorno
| Tipo | Descrição |
|---|---|
| Int32 | Identificador único da conta de acesso criada. |
EditCadaster
Altera o cadastro de uma conta de acesso existente.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| data | EditCadasterData | Dados para alteração do cadastro. Obrigatório. |
Retorno
Este método não possui retorno.
EditEmail
Altera o e-mail de uma conta de acesso existente.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| data | EditEmailData | Dados para alteração do e-mail. Obrigatório. |
Retorno
Este método não possui retorno.
EditPassword
Altera a senha de autenticação de uma conta de acesso existente.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| data | EditPasswordData | Dados para alteração da senha. Obrigatório. |
Retorno
Este método não possui retorno.
LoadCards
Retorna os cartões vinculados a conta do usuário.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| accountEid | Int32 | Identificador único da conta de acesso. Obrigatório. |
Retorno
| Tipo | Descrição |
|---|---|
| LoadCardResult[] | Retorna os cartões verificados e autorizados para utilização futura pelo usuário. |
RemoveCard
Remove o cartão da conta do usuário.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| data | RemoveCardData | Dados para remover o cartão da conta. Obrigatório. |
Retorno
Este método não possui retorno.
GenerateToken
Gera um token para autenticação integrada que pode ser utilizado na Loja Web e Portal.
O token gerado deve ser passado por QueryString para a página de autenticação dos
produtos da seguinte forma:
Loja Web
https://[endereco_loja]?token=[token_gerado]
Portal
https://[endereco_portal]/login.aspx?token=[token_gerado]
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| data | GenerateTokenData | Dados para geração de token de acesso integrado ao Portal e Loja Web. Obrigatório. |
Retorno
| Tipo | Descrição |
|---|---|
| String | Retorna a string correspondente ao hash do token de sessão criado. |
RemoveAccount
Remove/bloqueia a conta do usuário.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| data | RemoveAccountData | Dados para remover/bloquear conta do usuário. Obrigatório. |
Retorno
Este método não possui retorno.
RefreshUser
Remove/bloqueia a conta do usuário.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| data | RefreshUserData | Dados para remover/bloquear conta do usuário. Obrigatório. |
Retorno
| Tipo | Descrição |
|---|---|
| RefreshUserResult |
Error codes
Códigos de erro retornados pelo serviço
Valores
| Nome | Valor | Descrição |
|---|---|---|
| UnavailableCloud | 0 | Não é possível estabelecer conexão com o data center do sistema. |
| InvalidCredentialOrPassword | 1 | Fornecido como parâmetro um e-mail ou senha que não conferem com nenhuma conta de acesso existente. |
| InvalidEmail | 2 | Fornecido como parâmetro um e-mail que não pertence a nenhuma conta de acesso existente. |
| InvalidAccount | 3 | Fornecido como parâmetro um identificador de conta de acesso inexistente. |
| SendRememberPasswordEmailFailed | 4 | Erro inesperado no envio do e-mail de lembrete de senha. |
| EmailAlreadyExists | 5 | Fornecido como parâmetro um e-mail que está vinculado uma outra conta de acesso existente. |
| InvalidPassword | 6 | Fornecido uma senha que não confere. |
| InvalidOldPassword | 7 | Fornecido como parâmetro uma senha atual que não confere. |
| InvalidNewPassword | 8 | Fornecido como parâmetro uma nova senha inválida. |
| InvalidCadasterData | 9 | Fornecidos como parâmetro dados cadastrais inválidos. |
| InvalidCpf | 10 | Fornecido como parâmetro um CPF inválido. |
| CpfAlreadyExists | 11 | Fornecido como parâmetro um CPF de uma outra conta de acesso existente. |
| TitleNotActive | 12 | O título não está ativo. |
| TitleHasNotAccount | 13 | O título não possui conta de acesso. |
| UnauthorizedCloudAccount | 14 | O cartão não foi encontrado. |
| HasAwaitingPayments | 15 | Existem pagamentos agendados com este cartão. |
| InvalidTitleAccount | 16 | Fornecido como parâmetro um título que não pertence à conta de acesso. |
| AutenticationKeyMissing | 901 | Chave de autenticação não informada. |
| AutenticationKeyInvalid | 902 | Fornecido como parâmetro uma chave de autenticação inválida. Este erro ocorre quando, a chave não é encontrada, quando a chave informada está incorreta ou quando o usuário associado a chave não possui permissão para utilizar a API. |
| IntegrationDisabled | 903 | A integração com o aplicativo está desativada. Este erro ocorre devido a configuração na administração do servidor. |