Dúvida

Como realizar uma requisição de API, no módulo Ronda Senior X ?

Solução

Para ativar e chamar uma API do Ronda Senior X, siga os passos abaixo:

Atenção antes de prosseguir, é fundamental contar com o apoio da equipe de TI interna ou de uma pessoa qualificada que tenha conhecimento sobre APIs. Este artigo tem como objetivo ensinar onde e como realizar uma requisição de forma correta.

Importante: Existem diversas ferramentas disponíveis atualmente para realizar chamadas de APIs. O passo a passo a seguir utiliza a ferramenta Postman para fazer as requisições, porém outras ferramentas com o mesmo propósito também podem ser usadas.

1. Acesse o site: https://dev.senior.com.br/apis_publicas/sam/;

Observação: Neste site, você encontrará as APIs públicas disponíveis para o Ronda Senior X. Cada API é descrita com suas respectivas funções.

2. Insira a URL da API no cabeçalho do Postman e especifique qual tipo de requisição (GET, POST, etc.) será realizada para essa API:

Exemplificação da função de cada tipo de chamada dentro do ambiente:

• GET: Usado quando você deseja obter informações de um servidor sem modificar seu estado. Por exemplo, buscar os dados de um usuário específico.
• POST: Utilizado quando você precisa adicionar um novo recurso ao servidor, como ao criar um novo usuário.
• PUT: Empregado para substituir os dados de um recurso existente com novos dados. Caso o recurso não exista, alguns servidores podem criá-lo automaticamente.

Observação: A demonstração será feita utilizando a API https://sam-api.senior.com.br/sdk/v1/pendency/ que é responsável por gerenciar as pendências enviadas para os equipamentos.

3. Na guia Headers, é necessário informar o autenticador da API. Como estamos utilizando a URL padrão (https://sam-api.senior.com.br/sdk/v1), devemos fornecer o Token do drive que está sendo usado pelo dispositivo;

4. Esse token pode ser encontrado no caminho: Controle de Acesso / Drives;

5. Defina a chave (Key) como api_key e insira o token correspondente ao dispositivo, conforme mencionado no passo 4;

6. Feito este procedimento, esta API está pronta para consumo, se clicado no campo 'Send' será enviado uma Requisição dessa URL com uma resposta, sendo positiva ou negativa, segue exemplo:

Observação: O Body que está sublinhado de vermelho é resultado da minha Requisição, ou seja, para esta API me trouxe todas a pendencias que estão pendentes para envio para o Token no qual informei anteriormente. O retorno que está sublinhado como 200 OK, significa que o operação da Requisição foi atendida corretamente.

Importante: A URL utilizada neste Exemplo precisa de uma autenticação em Token, porém outras URLs padrões como do Senior X, se faz necessário a autenticação por Bearer Authorization da Plataforma Senior X,  e nessa situação é preciso estudar junto a sua Equipe qual a melhor formato para estar adaptando para realizar as autenticações das APIs por este formato.