Pular para o conteúdo principal

Autenticação API

Autenticar Login

POST [Url Ambiente]/OAuth2/Token

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

IdentificadorValor
Content-typeapplication/json
Acceptapplication/json
ParâmetroDescriçãoTipoExemplos
Scopeinforme apiString"api"
GrantTypeinforme client_credentialsString"client_credentials"
ClientIdUsuário da integraçãoString"104s3a5275a0d35e4"
ClientSecretSenha do usuário integraçãoString"e15148d497d8bc12"

Exemplo

{
"Scope": "api",
"GrantType": "client_credentials",
"ClientId": "104s3a5275a0d35e4",
"ClientSecret": "e15148d497d8bc12"
}

Exemplo

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \ 
"Scope": "api", \
"GrantType": "client_credentials", \
"ClientId": "104s3a5275a0d35e4", \
"ClientSecret": "e15148d497d8bc12" \
}' 'https://api.plataformaacert.com.br/OAuth2/Token'

Status Code 200

Retorno de sucesso.

ParâmetroDescriçãoTipoExemplos
expires_inexpiração em segundosint73160
access_tokenToken de autenticaçãoString"eyJhbGciOiJIUzI1NieyJhbGciOiJIUzI1NieyJhbGciOiJIUzI1NieyJhbGciOiJIUzI1Ni"
token_typeTipo de TokenString"Bearer"

Exemplo

{
"access_token": "eyJhbGciOiJIUzI1NieyJhbGciOiJIUzI1NieyJhbGciOiJIUzI1NieyJhbGciOiJIUzI1Ni",
"token_type": "Bearer",
"expires_in": 73160
}

Status Code 401

Usuário/Senha inválidos.

ParâmetroDescriçãoTipoExemplos
StatusStatus da requisiçãoOK = 0, ERRO = 11
MensagensDescrição dos errosString[]"Mensagens": []

Status Code 500

Erro não tratado pelo sistema.

ParâmetroDescriçãoTipoExemplos
StatusStatus da requisiçãoOK/ERROERRO
MensagensDescrição dos errosString[]"Mensagens": []

Exemplo

{
"Status": "OK",
"Mensagens": [
"string"
]
}