Histórico da Página
Informações | ||
---|---|---|
| ||
Disponível a partir da versão 19.3.1 e superiores. |
No Com o oAuth2 o acesso do cliente a uma API é feito mediante ao envio de a uma autorização, um token enviado no header da requisição a mesma.
Esse código de acesso ou Access Token é gerado previamente por um servidor de autorização(Authorization Server) determinado pelo dono da aplicação(Resource Owner) sem que o cliente precise efetuar um cadastro prévio.
Nesta implementação Para obter o token o cliente deve fazer uma chamada Http POST a API TlppCore através do endereço “/tlpp/oauth2/token” obedecendo a convenção de envio de parâmetros("Query String") desta forma :
https://localhost:1234/tlpp/oauth2/token?grant_type=password&username=nomedousuario&password=senhadousuario
Onde desmembrando a URL temos:
- https:// : Protocolo preferencial para utilização deste endpoint , necessário para utilização com utilização de SSL.
- localhost:1234 : Endereço e porta do seu servidor onde o oAuth2 está configurado.
- /tlpp/oauth2/token? : endpoint padrão TlppCore para obtenção de tokens.
- grant_type : "password"(enviar a palavra password)
- username - nome do usuário(nome do usuário que está solicitando acesso a aplicação).
- password - senha do usuário(senha do usuário que está solicitando acesso a aplicação).
Aviso |
---|
Os parâmetros da requisição devem ser enviados conforme a convenção "Query Params". |
Assim que é chegada a requisição, são é executadas algumas validações tais como: a validações de configuração do ambiente e parâmetros enviados, tanto os da requisição, quando dos parâmetros enviados na requisição bem como os fornecidos pelo EntryPoint de parâmetros antes antes que os tokens sejam gerados.
Havendo sucesso em todas as validações , a requisição é processada e caso não ocorra nenhum erro, é retornada uma resposta de sucesso(status 200-OK) para o cliente contendo no body da mesma um Json com o access token, refresh token, scope, type e expires in(tempo de validade em segundos) :
...
Caso haja falha em alguma das validações executadasprévias a geração do token, é enviado ao cliente uma resposta contendo o código de erro e constando no corpo da mensagem a descrição da falha:
...