Pular para o conteúdo principal

Autenticação API

Autenticar Login

POST [Url Ambiente]/Autenticar/Login

O método login, recebe os seguintes parâmetros:

IdentificadorValor
Content-typeapplication/json
Acceptapplication/json
ParâmetroDescriçãoTipoExemplos
UsuarioUsuário da integraçãoString"104s3a5275a0d35e4"
SenhaSenha do usuário integraçãoString"e15148d497d8bc12"

Exemplo

{
"Usuario": "104s3a5275a0d35e4",
"Senha": "e15148d497d8bc12"
}

Exemplo

curl -X POST https://api-energia-hml.plataformaacertpix.com.br/Autenticar/Login \
-H "Content-Type: application/json" \
-d '{"Usuario": "username", "Senha": "password"}'

Status Code 200

Retorno de sucesso.

ParâmetroDescriçãoTipoExemplos
ValidadeTokenAté qual data será válidoString"2024-07-24T09:29:32"
TokenToken de autenticaçãoString"12345GciOiJIUzI1Nie5JhbGciOiJIUzI1N5eyJhbGci3iJIUzI1NieyJhbGciOiJIUzI1Ni"

Exemplo

{
"ValidadeToken": "2024-07-24T09:29:32",
"Token": "12345GciOiJIUzI1Nie5JhbGciOiJIUzI1N5eyJhbGci3iJIUzI1NieyJhbGciOiJIUzI1Ni.12345GciOiJIUzI1Nie5JhbGciOiJIUzI1N5eyJhbGci3iJIUzI1NieyJhbGciOiJIUzI1Ni.12345GciOiJIUzI1Nie5JhbGciOiJIUzI1N5eyJhbGci3iJIUzI1NieyJhbGciOiJIUzI1NieyJhbGci3iJIUzI1NieyJhbGciOiJIUzI1Ni123",
"StatusCode": 200,
"Message": {
"TypeMessage": "200",
"Message": "SUCESSO"
}
}

Status Code 401

Usuário/Senha inválidos.

ParâmetroDescriçãoTipoExemplos
ValidadeTokenAté qual data será válidoString"0001-01-01T00:00:00"
TokenToken de autenticaçãonullnull
StatusCodeStatus da requisiçãoInt401
MessageDescrição dos errosObject{"TypeMessage":"401","Message":"Credenciais inválidas"}

Exemplo

{
"ValidadeToken": "0001-01-01T00:00:00",
"Token": null,
"StatusCode": 401,
"Message": {
"TypeMessage": "401",
"Message": "Credenciais inválidas"
}
}

Status Code 500

Erro não tratado pelo sistema.

ParâmetroDescriçãoTipoExemplos
ValidadeTokenAté qual data será válidoString"0001-01-01T00:00:00"
TokenToken de autenticaçãonullnull
StatusCodeStatus da requisiçãoInt500
MessageDescrição dos errosObject{"TypeMessage":"500","Message":"ERRO NO SERVIDOR"}

Exemplo

{
"ValidadeToken": "0001-01-01T00:00:00",
"Token": null,
"StatusCode": 500,
"Message": {
"TypeMessage": "500",
"Message": "ERRO NO SERVIDOR"
}
}