Portais API

Portais > API

API é um conjunto de rotinas e padrões de programação para acesso a um aplicativo de software ou plataforma baseado na Web. A sigla API significa "Interface de Programação de Aplicativos".

As APIs utilizam o padrão REST e o formato JSON codificado em UTF-8 para receber e retornar os dados. O processamento das requisições do tipo GET é feito de modo síncrono. Assim, após a requisição a uma URL os resultados são imediatamente exibidos.

O processamento das requisições do tipo POST, por sua vez, é feito de modo assíncrono. Para saber o resultado, é necessário acessar a URL que é retornada no cabeçalho Location.

O resultado contém todas as informações do recurso além dos campos status e response, detalhados na documentação de cada recurso.

Utilização

A API após ser instalada pode ser utilizadas nos portais, para isso é necessário informar a URL da aplicação ou site instalado conforme indicado em Portais - API_URL. Quando indicado um site somente para API a URL pode ser utilizada no seguinte formato: http://servidor:porta/API, quando for uma aplicação dentro do site deve ser utilizada assim: http://servidor:porta/API/api
IMPORTANTE: Quando utilizado https com protocolos de segurança é necessário que a API e os portais fiquem dentro do mesmo site para não existir bloqueio devido estarem em portas distintas.

É Recomendado o uso de uma ferramenta do tipo Rest Client para fazer os testes de comunicação com a API, por exemplo a extensão Advanced Rest Client do Chrome.