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:
| Nome | Descrição | Tipo | Informação Adicional |
|---|---|---|---|
| NomeUsuario |
Usuário utilizado para login no sistema. |
string |
Opcional |
| Login | string |
Opcional |
|
| Senha |
Senha do usuário. |
string |
Opcional |
| Nome |
Nome completo do usuário. |
string |
Opcional |
| CpfCnpj |
CPF/CNPJ do contato do usuário. |
string |
Opcional |
|
E-mail do contato do usuário. |
string |
Opcional |
|
| PerguntaSecreta |
Número contendo a sequência da pergunta selecionada, utilizado ao realizar a autenticação em duas etapas. |
integer |
Opcional |
| RespostaSecreta |
Resposta da pergunta secreta, utilizada ao realizar a autenticação em duas etapas. |
string |
Opcional |
| CodigoVerificacao2Etapas |
Código de verificação gerado ao realizar a autenticação em duas etapas. |
string |
Opcional |
| Portal |
Nome do portal descrito no SESSION_APP_PORTAL no AppSettings do Web.config. |
string |
Obrigatório |
| CodigoPessoa |
Código de pessoa para acesso externo de usuários. Obrigatório somente para login com acesso externo. |
string |
Opcional |
| Sequencia |
Sequência do contato para acesso externo de usuários. Obrigatório somente para login com acesso externo. |
integer |
Opcional |
| CodigoVerificacao |
Codigo verificacao gerado para acesso externo de usuários. Obrigatório somente para login com acesso externo. |
string |
Opcional |
| Funcionalidade |
Funcionalidade do portal para acesso externo de usuários. |
string |
Opcional |
| DadosDispositivo |
Dados do dispositivo que requisitou o login. |
Opcional |
|
| FormaAcesso |
Forma de acesso utilizada no login. |
string |
Opcional |
| TipoAcesso |
Tipo de acesso utilizado no login. |
string |
Opcional |
| IdPaiControleAcesso |
Id do registro pai, usado quando TipoAcesso = 'A'. |
integer |
Opcional |
Formato de Envio:
application/json, text/json
{
"NomeUsuario": "string 2",
"Login": "string 2",
"Senha": "string 3",
"Nome": "string 4",
"CpfCnpj": "string 5",
"Email": "string 6",
"PerguntaSecreta": 1,
"RespostaSecreta": "string 7",
"CodigoVerificacao2Etapas": "string 8",
"Portal": "string 9",
"CodigoPessoa": "string 10",
"Sequencia": 11,
"CodigoVerificacao": "string 12",
"Funcionalidade": "string 13",
"DadosDispositivo": {
"TipoDispositivo": "string 1",
"Navegador": "string 2",
"Ip": "string 3",
"Dns": "string 4"
},
"FormaAcesso": "string 14",
"TipoAcesso": "string 15",
"IdPaiControleAcesso": 1
}
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:
| Nome | Descrição | Tipo | Informação Adicional |
|---|---|---|---|
| success | boolean |
Opcional |
|
| hash | string |
Opcional |
|
| messages | string |
Opcional |
|
| data | Object |
Opcional |
|
| tipoLogin | string |
Opcional |
Formato de Resposta:
| 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"
}
|