Portais API: mudanças entre as edições
Sem resumo de edição |
|||
| (17 revisões intermediárias por 2 usuários não estão sendo mostradas) | |||
| Linha 1: | Linha 1: | ||
[[ | {{VoltarPagina}} | ||
[[API]] > | |||
[[Portais API]] | |||
A '''API (Application Programming Interface)''', ou Interface de Programação de Aplicativos, permite a comunicação e a troca de informações entre sistemas por meio de um conjunto de rotinas e padrões de programação. | |||
API | |||
A API dos Portais CIGAM utiliza a arquitetura REST e o formato JSON, codificado em UTF-8, para receber e retornar dados. | |||
O processamento das requisições varia conforme o método HTTP utilizado: | |||
* '''GET:''' o processamento ocorre de forma síncrona, e os dados são retornados diretamente na resposta à requisição. | |||
* '''POST:''' o processamento ocorre de forma assíncrona. Para consultar o resultado, é necessário acessar a URL retornada no cabeçalho Location da resposta. | |||
O retorno contém as informações do recurso solicitado, incluindo os campos status e response, cuja finalidade e estrutura são detalhadas na documentação específica de cada recurso. | |||
= Parametrização = | = Parametrização = | ||
Para instalar e configurar a aplicação da API, consulte a documentação [[GE - Como Fazer - Ferramenta de implantação de sites e aplicações web]], que apresenta as orientações para implantação e configuração de sites e aplicações web. | |||
Após a instalação, configure a URL da API conforme as orientações disponíveis na documentação [[Portais#Informações_gerais|Portais]], utilizando o parâmetro API_URL. | |||
= Utilização = | = Utilização = | ||
Para realizar e validar requisições à API, recomenda-se utilizar uma ferramenta do tipo REST Client. | |||
* | O '''CIGAM Web Request Client''' permite criar, configurar, enviar e validar requisições HTTP, possibilitando testar a comunicação com a API e analisar as respostas recebidas. | ||
* | |||
Para obter orientações sobre a configuração e a execução de requisições, consulte a documentação [[CGWebRequestClient]]. | |||
< | == URL de acesso à API == | ||
A URL de acesso deve ser definida conforme a estrutura de instalação da aplicação: | |||
* '''API instalada em um site exclusivo:''' http://servidor:porta/API | |||
* '''API instalada como uma aplicação dentro de um site:''' http://servidor:porta/API/api | |||
Substitua servidor e porta pelos valores correspondentes ao ambiente instalado. | |||
'''Importante:''' quando utilizado o protocolo HTTPS, a API e os portais devem estar hospedados no mesmo site, evitando bloqueios de comunicação decorrentes da utilização de portas distintas. | |||
= LOG = | |||
A partir da <ref group="Versão 251103">Liberado a partir da OS 650489/189.</ref>, é possível habilitar o registro de logs da API por meio da configuração do arquivo <code>Web</code><code>.config</code> da aplicação. | |||
== Configuração dos logs == | |||
Para habilitar a gravação dos logs em um diretório específico, adicione a seguinte chave ao arquivo <code>Web</code><code>.config</code>: | |||
: <add key="LOG_API_PASTA" value="C:\Temp\" /> | |||
Essa configuração define o diretório no qual os arquivos de log serão armazenados. Caso a chave não seja informada, os logs serão gravados no diretório padrão '''C:\Temp\Cigam.Web.API'''. | |||
'''Importante:''' o diretório informado deve existir para que os arquivos de log possam ser gerados. | |||
== Tamanho dos arquivos de log == | |||
Opcionalmente, é possível definir o tamanho máximo dos arquivos de log antes da criação de uma nova parte, adicionando a seguinte configuração: | |||
: <add key="LOG_API_TAMANHO_MB" value="10" /> | |||
No exemplo, cada arquivo de log terá o limite de 10 MB antes de ser dividido. Um valor diferente de zero habilita a divisão dos arquivos conforme o tamanho configurado. | |||
== Padrão de geração dos arquivos == | |||
O nome dos arquivos varia conforme a configuração de divisão dos logs: | |||
* '''Sem divisão:''' process-#.log | |||
* '''Com divisão:''' process-#-#.log | |||
Nos nomes acima, o primeiro # representa o número do processo do Windows associado ao pool de aplicações do IIS. Quando há divisão, o segundo # identifica a sequência da parte do arquivo. | |||
[[ | = Documentos relacionados = | ||
* [[Portais]] | |||
* [[CGWebRequestClient]] | |||
* [[GE - Como Fazer - Ferramenta de implantação de sites e aplicações web]] | |||
=Versões= | |||
===Versão 251103=== | |||
<references group="Versão 251103"/> | |||
Edição atual tal como às 20h23min de 19 de outubro de 2026
A API (Application Programming Interface), ou Interface de Programação de Aplicativos, permite a comunicação e a troca de informações entre sistemas por meio de um conjunto de rotinas e padrões de programação.
A API dos Portais CIGAM utiliza a arquitetura REST e o formato JSON, codificado em UTF-8, para receber e retornar dados.
O processamento das requisições varia conforme o método HTTP utilizado:
- GET: o processamento ocorre de forma síncrona, e os dados são retornados diretamente na resposta à requisição.
- POST: o processamento ocorre de forma assíncrona. Para consultar o resultado, é necessário acessar a URL retornada no cabeçalho Location da resposta.
O retorno contém as informações do recurso solicitado, incluindo os campos status e response, cuja finalidade e estrutura são detalhadas na documentação específica de cada recurso.
Parametrização
Para instalar e configurar a aplicação da API, consulte a documentação GE - Como Fazer - Ferramenta de implantação de sites e aplicações web, que apresenta as orientações para implantação e configuração de sites e aplicações web.
Após a instalação, configure a URL da API conforme as orientações disponíveis na documentação Portais, utilizando o parâmetro API_URL.
Utilização
Para realizar e validar requisições à API, recomenda-se utilizar uma ferramenta do tipo REST Client.
O CIGAM Web Request Client permite criar, configurar, enviar e validar requisições HTTP, possibilitando testar a comunicação com a API e analisar as respostas recebidas.
Para obter orientações sobre a configuração e a execução de requisições, consulte a documentação CGWebRequestClient.
URL de acesso à API
A URL de acesso deve ser definida conforme a estrutura de instalação da aplicação:
- API instalada em um site exclusivo: http://servidor:porta/API
- API instalada como uma aplicação dentro de um site: http://servidor:porta/API/api
Substitua servidor e porta pelos valores correspondentes ao ambiente instalado.
Importante: quando utilizado o protocolo HTTPS, a API e os portais devem estar hospedados no mesmo site, evitando bloqueios de comunicação decorrentes da utilização de portas distintas.
LOG
A partir da [Versão 251103 1], é possível habilitar o registro de logs da API por meio da configuração do arquivo Web.config da aplicação.
Configuração dos logs
Para habilitar a gravação dos logs em um diretório específico, adicione a seguinte chave ao arquivo Web.config:
- <add key="LOG_API_PASTA" value="C:\Temp\" />
Essa configuração define o diretório no qual os arquivos de log serão armazenados. Caso a chave não seja informada, os logs serão gravados no diretório padrão C:\Temp\Cigam.Web.API.
Importante: o diretório informado deve existir para que os arquivos de log possam ser gerados.
Tamanho dos arquivos de log
Opcionalmente, é possível definir o tamanho máximo dos arquivos de log antes da criação de uma nova parte, adicionando a seguinte configuração:
- <add key="LOG_API_TAMANHO_MB" value="10" />
No exemplo, cada arquivo de log terá o limite de 10 MB antes de ser dividido. Um valor diferente de zero habilita a divisão dos arquivos conforme o tamanho configurado.
Padrão de geração dos arquivos
O nome dos arquivos varia conforme a configuração de divisão dos logs:
- Sem divisão: process-#.log
- Com divisão: process-#-#.log
Nos nomes acima, o primeiro # representa o número do processo do Windows associado ao pool de aplicações do IIS. Quando há divisão, o segundo # identifica a sequência da parte do arquivo.
Documentos relacionados
Versões
Versão 251103
- ↑ Liberado a partir da OS 650489/189.
