Como obter informações do ambiente utilizando a API do Manager

Neste artigo onde vamos explicar e montar um passo a passo para que seja possível usar a API do Manager para obter informações de seu ambiente, como por exemplo: Quais APIs estão associadas á uma APP.

PS: Nós do time do suporte não podemos realizar esta tarefa no ambiente produtivo do cliente por questões relacionadas a política de segurança interna e também devido a LGPD.

Para obter estas informações, é necessário ter em mãos um access-token Sensedia-auth que esteja associado a API do Manager. Pois sem informar o mesmo nos headers da requisição, não conseguiremos realizar a chamada para a API e teremos como retorno um status code 401.

PS: Todos os testes, casos de uso e imagens presentes nesse artigo foram obtidos/realizados no ambiente de suporte.

COMO CRIAR O SENSEDIA-AUTH

O Sensedia-Auth é um access-token específico utilizado para autenticação em APIs do Manager.
Para obter um Sensedia-Auth é preciso criar um Access-Token vinculado a API de integração do
manager e informar um "userId".

Abaixo iremos detalhar procedimento a ser realizado:

1 -​ Na plataforma clique em Access Tokens > Simbolo de + (Create Access Token)

   

2 -​ Preencha as informações necessárias como OWNER e APP e o EXTRA FIELD userId:

Para criar o sensedia-auth é necessário fornecer o userId do usuário que irá utilizar o token como extra
info.
Insira este ID no campo Extra Field e clique em ADD Extra Field, conforme imagem abaixo:

Obs: Atualmente não temos uma forma de ver pelo manager este User ID, a forma que podemos

consultar é pela API do manager ou pelo console do desenvolvedor (F12) na pagina users.

3 -​ Na próxima etapa iremos vincular este access token a uma API e um plano.
Neste exemplo estamos vinculando a API do manager, pois iremos simular a visualização de APPs.

API do Manager:​ Utilizada para criação / consulta de APP, API, Users, Planos.

API Metrics: ​ Utilizada para consulta de dados das chamadas.

4 -​ Na próxima etapa vamos finalizar a criação deste sensedia-auth, clicando em PUBLISH YOUR
ACCESS TOKEN.

Com o token ativo, podemos usar a API do Manager para obter as informações desejadas como por exemplo: Todas as APIs de uma APP.

COMO ACESSAR E UTILIZAR A API DO MANAGER

Através da plataforma, temos acesso à toda a documentação (swagger) da API do Manager. Essa documentação está acessível através do ícone de três pontos presente no canto superior direito da tela do manager, conforme podemos ver na imagem abaixo:

Através da API do manager podemos obter as informações desejadas como por exemplo a lista de APIs vinculadas a um APP pelo método GET APis.

 

Para isso será necessário passar duas informações como parâmetros, um sensedia-auth vinculado a api do manager e o clientid da app desejada.

Ao ter essas informações em mãos basta passar no header e executar. Será retornado as informações solicitadas com o código 200.

Para que seja possível exportar essa informação a chamada deve ser feita em um aplicativo como o postman e salvar o response/arquivo em CSV.

Para isso pode copiar o CURL da chamada acima e passar no postman.

Segue CURL utilizado:

 

1curl -X GET "https://manager-support-aws.sensedia.com/api-manager/api/v3/apps/xxxxxxxxxxxxxxxxxxxxxx" -H "accept: application/json" -H "Sensedia-Auth: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

 

PS: A API Do Manager deve ser utilizada para uso pontual e esporádico, a mesma não deve ser utilizada massivamente em fluxo produtivo das APIs, pois pode gerar deteriorização do desempenho do Manager e indisponibilida em sua API Produtiva. 

 

Para maiores detalhes sobre o uso da API Do manager confira nossa página de FAQ do produto