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.

Parametrização

• Consulte GE - Como Fazer - Ferramenta de implantação de sites e aplicações web para detalhamento do uso da ferramenta e implantação da aplicação.

Utilização

A API após ser instalada é 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 a URL deve ser utilizada assim:
  
  • http://servidor:porta/API/api
    

IMPORTANTE: Quando utilizado com protocolos de segurança (https) é 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.

• Abrir a extensão no crome:
  

API_ARC

• Fazer Login via API
  

API_LOGIN

LOG

Ativação do Log da API .
Para habilitar o registro de logs da API, é necessário ajustar o arquivo We.config da aplicação. Incluindo as seguintes configurações:

• <add key="LOG_API_PASTA" value="C:\Temp\" /> ativa a gravação de logs.
  • Essa configuração é necessária ser informada quando necessitar configurar um caminho diferente, caso contrário será salvo log dentro de C:\Temp\Cigam.Web.API, para que o log seja salvo a pasta deve ser existente.
• <add key="LOG_API_TAMANHO_MB" value="10" /> (Opcional) Define quebra dos arquivos de log. Caso deseje que os arquivos de log sejam divididos em partes, adicione a chave definindo um tamanho máximo em megabytes diferente de zero:

No exemplo acima, cada arquivo será quebrado em blocos de 10 MB.

• Padrão de Geração dos Arquivos
  • Quando não há quebra, os arquivos são criados com o formato:
    • process-#.log
      • Onde # representa o número de processo do Windows referente ao pool de aplicações no IIS.
  • Quando a quebra está habilitada, as partes são numeradas no formato:
    • process-#-#.log
      • Onde o primeiro # é o número do processo e o segundo # indica a sequência da parte do log.

Documentos relacionados

• Portais