Como identificar quais parâmetros retornam da API requisitada?

API é uma sigla do inglês que significa Application Programming Interface que, traduzindo para português seria uma Interface de Programação de Aplicativos. De forma geral, a API é um conjunto de padrões de programação e rotinas que permite a conexão de aplicativos e sistemas.

O Sienge Plataforma disponibiliza a documentação das APIs de forma pública para clientes, parceiros de integração ou desenvolvedores independentes.


Portanto, esse artigo tem como objetivo demonstrar a maneira de localizar e identificar os parâmetros das requisições, efetuadas via API's (GET, POST, PATCH, PUT e DELETE).


Atenção! Link de acesso a documentação pública: https://api.sienge.com.br/docs/.


Pré-requisito 

 Usufruir das API's disponibilizadas pelo Sienge Plataforma.

Passo a passo 

1. Acesse o link da documentação e consulte a API desejada para utilização;


2. Desça com a aba do navegador, clicando em "MODEL" e expandindo os itens no botão ">";

 


3. Do lado esquerdo estará o parâmetro e do lado direito o significado/retorno da requisição;



Desta maneira, ao realizar a requisição da API utilizada, como no exemplo, haverá o retorno de parâmetro e resultado:


Dica! Seguindo a mesma orientação descrita acima, você poderá averiguar quais informações qualquer API (GET) poderá te fornecer ou quais dados deverá preencher para executar qualquer API (PATCH, PUT, POST e DELETE). 

 

 

Artigos relacionados:

Como criar usuários de API?

Como liberar recursos para Usuários de APIs?

Esperamos que este artigo tenha ajudado!



 

Isso foi útil para você? Sim Não

Enviar feedback
Lamentamos não termos conseguido ajudá-lo(a) mais. Ajude-nos a melhorar este artigo com o seu feedback.