Autenticação API
Autenticar Login
POST [Url Ambiente]/Autenticar/Login
O método login, recebe os seguintes parâmetros:
Header
Identificador | Valor |
---|---|
Content-type | application/json |
Accept | application/json |
Parâmetro | Descrição | Tipo | Exemplos |
---|---|---|---|
Usuario | Usuário da integração | String | "104s3a5275a0d35e4" |
Senha | Senha do usuário integração | String | "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âmetro | Descrição | Tipo | Exemplos |
---|---|---|---|
ValidadeToken | Até qual data será válido | String | "2024-07-24T09:29:32" |
Token | Token de autenticação | String | "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âmetro | Descrição | Tipo | Exemplos |
---|---|---|---|
ValidadeToken | Até qual data será válido | String | "0001-01-01T00:00:00" |
Token | Token de autenticação | null | null |
StatusCode | Status da requisição | Int | 401 |
Message | Descrição dos erros | Object | {"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âmetro | Descrição | Tipo | Exemplos |
---|---|---|---|
ValidadeToken | Até qual data será válido | String | "0001-01-01T00:00:00" |
Token | Token de autenticação | null | null |
StatusCode | Status da requisição | Int | 500 |
Message | Descrição dos erros | Object | {"TypeMessage":"500","Message":"ERRO NO SERVIDOR"} |
Exemplo
{
"ValidadeToken": "0001-01-01T00:00:00",
"Token": null,
"StatusCode": 500,
"Message": {
"TypeMessage": "500",
"Message": "ERRO NO SERVIDOR"
}
}