APIs

Token de autorização

Como obter o Token de autorização as APIs

Uma vez que você tenha suas credenciais, o próximo passo é obter um token de autorização. Para obter o token de autorização, você precisará fazer uma solicitação ao serviço de autenticação da Plataforma nstech no endpoint apropriado, dependendo do ambiente em que está operando. Utilize os seguintes endpoints:

  • Ambiente de Desenvolvimento (DEV):

    
    Endpoint: https://dev.nstech.com.br/auth/realms/platform/protocol/openid-connect/token
    
  • Ambiente de Produção (PROD):

    
    Endpoint: https://hub.nstech.com.br/auth/realms/platform/protocol/openid-connect/token
    

Certifique-se de utilizar suas credenciais na requisição POST para obter o token de autorização:

  • client_id: O ID do cliente que foi fornecido durante a obtenção das credenciais.
  • client_secret: O segredo do cliente que foi fornecido durante a obtenção das credenciais.
  • grant_type: Este parâmetro deve ser definido como "client_credentials" para indicar que você está usando o fluxo de credenciais do cliente.

🚧

Para APIs da Plataforma (exceto MDM)

Apenas utilize o endpoint de PROD (produção) quando estiver certo que a integração está funcionando perfeitamente.

🚧

APIs do MDM

Caso você esteja tentando utilizar as APIs do MDM o endpoint para obter o Token de Autorização deve ser sempre o de Produção.

Após enviar esta requisição, você receberá uma resposta contendo o token de autorização, que poderá ser usado para autenticar suas futuras solicitações à Plataforma nstech. Certifique-se de armazenar e gerenciar o token de forma segura, pois ele é fundamental para acessar as APIs de forma autorizada.

Com o token de autorização em mãos, você pode agora invocar qualquer API da Plataforma nstech. Basta incluir o token no cabeçalho de autorização de suas solicitações HTTP da seguinte forma:


Authorization: Bearer SEU_ACCESS_TOKEN
Content-Type: application/json

Substitua SEU_ACCESS_TOKEN pelo token obtido no passo anterior.

🚧

Em caso de erro

Se mesmo de posse do Token a chamada a alguma API da plataforma retornar erro de autorização entre em contato com o suporte através do email [email protected]

Expiração do Token

Lembre-se de que o token de autorização possui um tempo de vida limitado, após o qual você precisará renová-lo seguindo o mesmo processo de obtenção.

👍

Recomendação

Sempre utilize o mesmo token de autorização durante o período de validade do mesmo. Essa prática promove a eficiência das solicitações, reduz o consumo de recursos, simplifica a escalabilidade da infraestrutura e aprimora a segurança geral da aplicação. Portanto, evite gerar um novo token de acesso para cada requisição feita a uma API da Plataforma.

Uma vez obtido o tempo de expiração do token de autorização faça uma lógica para utilizar o mesmo e faça sua renovação se o token tiver expirado ou estiver prestes a expirar (por exemplo, dentro dos próximos 5 minutos), iniciando o processo de renovação.

Language
Click Try It! to start a request and see the response here!