Autorização

O que é autorização?

Autorização é o processo de concessão de acesso de integração aos dados. Esse processo varia dependendo se a integração é ou não pública ou interna.

Integração pública

As integrações públicas podem ser usadas por qualquer usuário em qualquer espaço de trabalho. Elas permitem o uso da API REST, uma vez que a integração tenha sido autorizada corretamente.

As integrações públicas seguem o protocolo OAuth 2.0.

Credenciais

Uma vez que todo o processo de liberação dos usos da API estiver concluído será o momento de receber suas credenciais de acesso.

Será disponibilizado para você um clientId e um clientSecret que serão os responsáveis por gerar um token de Autenticação.

{
	"clientId": "VzH0zYuQACEyF9AQreWv65uocYrMhJa7",
	"clientSecret": "2Mi3GbRvqTfF2JzLDTVjDXOkXVn41R0yy9TAV1C1K6t08EeuWgPu7N5Ixs6iUIgy"
}

Em posse do token autenticado em mãos será possível realizar os acessos aos modelos contratados.

{
	"token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Ik9aZTQwdVFNdWRXUm9sd09LT1RzNSJ9.eyJpc3MiOiJodHRwczovL2Rldi1xbGNiMGxpaHZsMG16OG8yLnVzLmF1dGgwLmNvbS8iLCJzdWIiOiJWekgwell1UUFDRXlGOUFRcmVXdjE1dW9jWXJNaEphN0BjbGllbnRzIiwiYXVkIjoiaHR0cHM6Ly9kZXYtcWxjYjBsaWh2bDBtejhvMi51cy5hdXRoMC5jb20vYXBpL3YyLyIsImlhdCI6MTY5NTk4ODQzOCwiZXhwIjoxNjk2MDc0ODM4LCJhenAiOiJWekgwell1UUFDRXlGOUFRcmVXdjE1dW9jWXJNaEphNyIsImd0eSI6ImNsaWVudC1jcmVkZW50aWFscyJ9.C7WKo29NVU_wwv__-8whjzV_WTegKC6R9gBPcRIGuvb3TEBoH_Ayq1vfMp6RzY96UZjxAE_JzudAXkPEKe_-e5pWXOit2xepBjLLuKT1BK96ihhgKD9_x4f0l-WqJ7hyhchphsKXyCDHlnjwW2UithJqYE37mRXGp3OikmXraQlzb4nhWvGiLKfWlonuzZcwOW6_gMQIUwDkSuzMO5KNsoAFJ887-hZgY1I_S8lp6znQkrByzq9ZKl01UrMXT0SVVV2koMCLOLNNbuIXu-crc7uzW9s-xf6CjeVHLJL-6bmlY90i5lbVS0Zo3G_LwID9twRxrrg8AdBhpl3vQtRhGA",
	"expiresIn":86400,
  	"createdAt": "2023-11-14T18:27:33.1611453+00:00"
}

Note que o token possui um tempo de expiração, logo será necessário na sua integração implementar uma função de refresh token.

Guarde suas credenciais em segredo

Suas credenciais são segredo. Para manter sua integração segura, nunca armazene em seu código-fonte. Em vez disso, leia de uma variável de ambiente. Use um gerenciador secreto ou sistema de implantação para acessar as credenciais.