Testando uma API

Aqui você encontrará as informações sobre como conhecer e testar os serviços de determinada API disponibilizada no portal de integração, no próprio portal de integração, por meio da plataforma de gestão de APIs. 

Para verificar e conhecer os serviços oferecidos por uma API, acesse a propriedade [API Console], onde será possível visualizar todos os serviços oferecidos pela API em questão. Para detalhar um serviço, clique no serviço desejado e será apresentada as propriedades daquele serviço, como Método http , path e os parâmetros solicitados, para sua utilização.

A aplicação, representa a aplicação inscrita e selecionada para uso desta api. O Ambiente, representa de qual ambiente o serviços oferecidos estão consumindo dados. O cabeçalho da solicitação deverá conter o seu token de acesso para confirmar a autorização gerada para sua aplicação.

Posteriormente, é possível identificar os endpoints ou serviços disponíveis na API em questão. Ao clicar em cada serviço, este é expandido e detalhado seus recursos, parâmetros obrigatórios e opcionais, documentação e exemplo de resposta do serviço. Para executar o serviço pela plataforma, basta indicar os parâmetros obrigatórios, e clicar no botão [Execute]. Assim, na própria plataforma será apresentado o resultado da requisição.