A Carol possui autenticação OAuth, podendo ser explorado a autenticação API Key (também conhecido como API Token ou Connector Token).

Índice

Visão Geral

Abaixo um fluxo demonstrando o processo de autenticação OAuth:

...

Esses serviços permitem efetuar a autenticação na Carol e efetuar a validação de um token já existente. Vamos ver os detalhes desses serviços:

/api/v1/oauth2/token

Este endpoint permite efetuar a autenticação na Carol, validando se o usuário e a senha possuem acesso à plataforma. Abaixo é detalhado os parâmetros necessários:

...

{ "access_token": "1e2fe288fa3a4ca38257294008081317", "client_id": "4c2c9090e7c611e893bf0e900682978b_33dd1190ff2c11e8858be609736e2a59_c1367ca0e86311e8b979aedbc4a09666_mdmConnector", "expires_in": 3495, "refresh_token": "1fd8bc5763734ad0b8e18e2cd328f2f8", "state": "", "timeIssuedInMillis": 1591855130722, "token_type": "bearer" }

/api/v1/oauth2/token/{access_token}/userAccessDetails

Este endpoint permite resgatar detalhes referente ao token, inclusive verificar se o token ainda esta valido:

...

{ "envUserId": "c1367ca0e86311e8b979aedbc4a09666", "externalAppId": "33dd1190ff2c11e8858be609736e2a59", "loginLevel": "mdmTenant", "orgId": "856e0510729e11e99928acde48001122", "refreshToken": "1fd8bc5763734ad0b8e18e2cd328f2f8", "system": false, "tenantId": "4c2c9090e7c611e893bf0e900682978b", "userId": "fe115382754247d883d9a11b88b3d96e" }

Connector Token (API Key)

Além do processo convencional de autenticação do processo OAuth, é possível fazer a geracão de um token persistente. Este token é chamado de "Connector Token", e o mesmo é utilizado principalmente em integração de processos sendo que é utilizado uma chave pública e uma chave privada, conforme detalhado a seguir:

...

O acesso pelo conector permite visualizar que o conector possui tokens gerados, e é possível navegar para o fluxo acima apresentado (Environment Admin), podendo assim efetuar a manutenção dos tokens:

Regras de Token

Um item importante a se considerar referente ao Connector é que, em cada tenant, só é possível criar um Token por connector.

Caso o usuário queira efetuar uma consulta se o token ainda é valido, deve-se utilizar o endpoint abaixo, preenchendo o apitoken juntamente com o connector ID:

/api/v1/apikey/details

Revogação

O Connector Token uma vez criado, não se expira. Para que o mesmo seja revogado/invalidado, deve-se por conta das regras abaixo:

...

3. Usuário removido da plataforma.

Próximos Passos

Uma vez que a autenticação ocorreu, teremos o access_token disponível. Este valor deve ser inserido no swagger no atributo "Access Token" (parte superior central).

...