Show / Hide Table of Contents

    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.

    POST {baseAddress}/login
    
    {
      "Credential": "{{texto}}",
      "Password": "{{texto}}"
    }
    

    Parâmetros

    Nome Tipo Descrição
    data LoginData Dados para autenticação. Obrigatório.

    Retorno

    {
      "LoginMode": 0,
      "Titles": [
        {
          "Id": 0,
          "TitleType": "{{texto}}",
          "Code": "{{texto}}"
        }
      ],
      "CloudAccountEid": 0,
      "Name": "{{texto}}",
      "Document": "{{texto}}"
    }
    
    Tipo Descrição
    LoginResult Se autenticado, retorna os dados do usuário autenticado. Senão dispara erro.

    LoginToken

    Valida um token para autenticação da conta de acesso.

    POST {baseAddress}/loginToken
    
    {
      "Token": "{{texto}}"
    }
    

    Parâmetros

    Nome Tipo Descrição
    data LoginTokenData Dados para autenticação. Obrigatório.

    Retorno

    {
      "LoginMode": 0,
      "Titles": [
        {
          "Id": 0,
          "TitleType": "{{texto}}",
          "Code": "{{texto}}"
        }
      ],
      "CloudAccountEid": 0,
      "Name": "{{texto}}",
      "Document": "{{texto}}"
    }
    
    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.

    POST {baseAddress}/rememberPassword
    
    "{{texto}}"
    

    Parâmetros

    Nome Tipo Descrição
    email 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.

    POST {baseAddress}/create
    
    {
      "Name": "{{texto}}",
      "Email": "{{texto}}",
      "Document": "{{texto}}",
      "DocumentType": 0,
      "Password": "{{texto}}"
    }
    

    Parâmetros

    Nome Tipo Descrição
    data CreateData Dados para criação da conta de acesso. Obrigatório.

    Retorno

    0
    
    Tipo Descrição
    Int32 Identificador único da conta de acesso criada.

    EditCadaster

    Altera o cadastro de uma conta de acesso existente.

    POST {baseAddress}/editCadaster
    
    {
      "CloudAccountEid": 0,
      "Name": "{{texto}}",
      "Document": "{{texto}}",
      "DocumentType": 0
    }
    

    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.

    POST {baseAddress}/editEmail
    
    {
      "CloudAccountEid": 0,
      "Email": "{{texto}}",
      "Password": "{{texto}}"
    }
    

    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.

    POST {baseAddress}/editPassword
    
    {
      "CloudAccountEid": 0,
      "NewPassword": "{{texto}}",
      "OldPassword": "{{texto}}"
    }
    

    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.

    POST {baseAddress}/loadCards
    
    0
    

    Parâmetros

    Nome Tipo Descrição
    accountEid Int32 Identificador único da conta de acesso. Obrigatório.

    Retorno

    [
      {
        "Eid": 0,
        "CardType": 0,
        "CardHolderName": "{{texto}}",
        "CardNumber": "{{texto}}",
        "ExpiryMonth": 0,
        "ExpiryYear": 0
      }
    ]
    
    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.

    POST {baseAddress}/removeCard
    
    {
      "CloudAccountEid": 0,
      "CardEid": 0
    }
    

    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]

    POST {baseAddress}/generateToken
    
    {
      "AccountEid": 0,
      "TitleId": 0
    }
    

    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

    "{{texto}}"
    
    Tipo Descrição
    String Retorna a string correspondente ao hash do token de sessão criado.

    RemoveAccount

    Remove/bloqueia a conta do usuário.

    POST {baseAddress}/removeAccount
    
    {
      "CloudAccountEid": 0,
      "Credential": "{{texto}}",
      "Password": "{{texto}}"
    }
    

    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.

    POST {baseAddress}/refreshUser
    
    {
      "CloudAccountEid": 0
    }
    

    Parâmetros

    Nome Tipo Descrição
    data RefreshUserData Dados para remover/bloquear conta do usuário. Obrigatório.

    Retorno

    {
      "AllowDelete": false
    }
    
    Tipo Descrição
    RefreshUserResult
    Back to top Um produto MultiClubes