POST

api/genericos/ge/Email/SetCredencialEmail

Notas de Implementação:

Método para gravar as credenciais de e-mail na sessão.

Informações de Envio:

Cabeçalhos de Envio:

Parâmetro Valor Descrição Tipo de parâmetro Tipo de dados
Authorization Bearer Hash gerado no login Header String

Acesse o método de login para mais informações: api/genericos/ge/Login/Autenticar

Modelo:

Dados do e-mail em formato de DTO.

CredencialEmailDTO

NomeDescriçãoTipoInformação Adicional
Email

string

Opcional
SenhaCriptografada

Senha criptografada a ser salva na sessão.

 string

Obrigatório
OpcaoSalvar

Informa quais dados serão salvos.

 string

Opcional

Tamanho Único: 1

Faixa: "N" = Não salvar, "U" = Usuário, "T" = Usuário e Senha

Formato de Envio:

application/json, text/json

Exemplo: 
{
  "Email": "string 1",
  "SenhaCriptografada": "string 2",
  "OpcaoSalvar": "string 3"
}

Informações de Retorno:

Cabeçalhos Adicionais:

Nome Descrição Valor
cigam-api-version Versão do build/compilação dessa versão da API 2.1.8565.21067

Modelo:

HttpCustomResponse

NomeDescriçãoTipoInformação Adicional
success

boolean

Opcional
hash

string

Opcional
messages

string

Opcional
data

Object

Opcional
tipoLogin

string

Opcional

Formato de Resposta:

Retorno de sucesso ou falha na gravar as credenciais.

Código de status HTTP Descrição Modelo de resposta
200 OK

application/json, text/json

Exemplo: 
{
  "success": true,
  "hash": "string 2",
  "messages": [
    "string 1"
  ],
  "data": {},
  "tipoLogin": "string 4"
}
400 Requisição inválida

application/json, text/json

Exemplo:
{ 
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"
}
401 Não autorizado

application/json, text/json

Exemplo:
{ 
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"
}
500 Requisição falhou

application/json, text/json

Exemplo:
{ 
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"
}
502 Falha de comunicação

application/json, text/json

Exemplo:
{ 
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"
}