Portais API - Histórico de revisão

Camila.Oliveira em 20h23min de 19 de outubro de 2026

2026-10-19T20:23:48Z

← Edição anterior		Edição das 20h23min de 19 de outubro de 2026
Linha 1:		Linha 1:
	[[API]] > [[Portais API]]		{{VoltarPagina}}
			[[API]] >
			[[Portais API]]

	~~<p align="justify">~~		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 é 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".<br>~~
	~~<br>~~		A API dos Portais CIGAM utiliza a arquitetura REST e o formato JSON, codificado em UTF-8, para receber e retornar dados.
	~~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~~.~~<br>~~		O processamento das requisições varia conforme o método HTTP utilizado:
	~~<br>~~		* '''GET:''' o processamento ocorre de forma síncrona, e os dados são retornados diretamente na resposta à requisição.
	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.~~<br>~~		* '''POST:''' o processamento ocorre de forma assíncrona. Para consultar o resultado, é necessário acessar a URL retornada no cabeçalho Location da resposta.
	~~<br>~~
	O ~~resultado~~ contém ~~todas~~ as informações do recurso ~~além dos~~ campos status e response, ~~detalhados~~ na documentação de cada recurso.~~<br>~~		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.
	~~<br></p>~~

	= Parametrização =		= 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~~.		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 =
	A API ~~após ser instalada é necessário informar a URL da aplicação ou site instalado conforme indicado em [[Portais\|Portais]]~~ - ~~API_URL.<br>~~		Para realizar e validar requisições à API, recomenda-se utilizar uma ferramenta do tipo REST Client.
	* Quando indicado um site somente para API a URL pode ser utilizada no seguinte formato:<br>
	** http://servidor:porta/API<br>
	* Quando for uma ~~aplicação dentro do site a URL deve ser utilizada assim:<br>~~
	** http://servidor:porta/API/api<br>
	~~<b>IMPORTANTE</b>: 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~~.~~<br>~~
	~~<br>~~

	~~É 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~~.~~<br>~~		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.

	* Abrir a ~~extensão no crome:<br>~~		Para obter orientações sobre a configuração e a execução de requisições, consulte a documentação [[CGWebRequestClient]].

	~~[[Image~~: ~~API_0.png\|center\|750px\|semmoldura\|API_ARC]]<br>~~		== 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

	* Fazer Login via API<br>		Substitua servidor e porta pelos valores correspondentes ao ambiente instalado.
	~~<br>~~
	~~[[Image~~: ~~API_1~~.~~png\|center\|750px\|semmoldura\|API_LOGIN]]~~		'''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 =		= LOG =
	~~Ativação do Log~~ da ~~API~~ <ref group="Versão 251103">Liberado a partir da OS 650489/189.</ref>~~.<br>~~		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.
	~~Para~~ habilitar o registro de logs da API~~, é necessário ajustar o~~ arquivo <code>We.config</code> da aplicação.
	~~Incluindo as seguintes configurações~~:		== Configuração dos logs ==
	* <add key="LOG_API_PASTA" value="C:\Temp\" /> ~~ativa a gravação de 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>:
	** 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_PASTA" value="C:\Temp\" />
	* <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~~:
			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

	~~No exemplo~~ acima, ~~cada arquivo será quebrado em blocos de 10 MB.~~		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.
	* 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=		= Documentos relacionados =
	* [[Portais]]		* [[Portais]]
			* [[CGWebRequestClient]]
			* [[GE - Como Fazer - Ferramenta de implantação de sites e aplicações web]]

	=Versões=		=Versões=
	===Versão 251103===		===Versão 251103===
	<references group="Versão 251103"/>		<references group="Versão 251103"/>

Camila.Oliveira em 19h53min de 19 de outubro de 2026

2026-10-19T19:53:31Z

← Edição anterior		Edição das 19h53min de 19 de outubro de 2026
Linha 1:		Linha 1:
	[[API]] > [[~~Portais_API\|~~API]]		[[API]] > [[Portais API]]

	<p align="justify">		<p align="justify">

Camila.Oliveira em 19h52min de 19 de outubro de 2026

2026-10-19T19:52:37Z

← Edição anterior		Edição das 19h52min de 19 de outubro de 2026
Linha 1:		Linha 1:
	[[~~Portais~~]] > [[Portais_API\|API]]		[[API]] > [[Portais_API\|API]]

	<p align="justify">		<p align="justify">

Camila.Oliveira: /* LOG */

2026-10-19T19:52:24Z

LOG

← Edição anterior		Edição das 19h52min de 19 de outubro de 2026
Linha 35:		Linha 35:

	= LOG =		= LOG =
	Ativação do Log da API <ref group="Versão 251103">Liberado a partir da OS ~~000000650489~~/189.</ref>.<br>		Ativação do Log da API <ref group="Versão 251103">Liberado a partir da OS 650489/189.</ref>.<br>
	Para habilitar o registro de logs da API, é necessário ajustar o arquivo ~~Web~~.config da aplicação.		Para habilitar o registro de logs da API, é necessário ajustar o arquivo <code>We.config</code> da aplicação.
	Incluindo as seguintes configurações:		Incluindo as seguintes configurações:
	* <add key="LOG_API_PASTA" value="C:\Temp\" /> ativa a gravação de logs		* <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.		** 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:		* <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.		No exemplo acima, cada arquivo será quebrado em blocos de 10 MB.
			* Padrão de Geração dos Arquivos
	** Padrão de Geração dos Arquivos		** Quando não há quebra, os arquivos são criados com o formato:
	*** Quando não há quebra, os arquivos são criados com o formato:		*** process-#.log
	**** process-#.log		**** Onde # representa o número de processo do Windows referente ao pool de aplicações no IIS.
	***** 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:
	***Quando a quebra está habilitada, as partes são numeradas no formato:		*** process-#-#.log
	**** process-#-#.log		**** Onde o primeiro # é o número do processo e o segundo # indica a sequência da parte do log.
	***** Onde o primeiro # é o número do processo e o segundo # indica a sequência da parte do log.

	=Documentos relacionados=		=Documentos relacionados=

Camila.Oliveira: /* Utilização */

2026-10-19T19:44:44Z

Utilização

← Edição anterior		Edição das 19h44min de 19 de outubro de 2026
Linha 32:		Linha 32:
	* Fazer Login via API<br>		* Fazer Login via API<br>
	<br>		<br>
	[[Image: API_1.png\|center\|750px\|semmoldura\|API_LOGIN]]~~<br><br>~~		[[Image: API_1.png\|center\|750px\|semmoldura\|API_LOGIN]]

	= LOG =		= LOG =

Camila.Oliveira: /* Utilização */

2026-10-19T19:44:34Z

Utilização

← Edição anterior		Edição das 19h44min de 19 de outubro de 2026
Linha 32:		Linha 32:
	* Fazer Login via API<br>		* Fazer Login via API<br>
	<br>		<br>
	[[Image: API_1.png\|center\|750px\|semmoldura\|API_LOGIN]]<br>		[[Image: API_1.png\|center\|750px\|semmoldura\|API_LOGIN]]<br><br>

	= LOG =		= LOG =
	Ativação do Log da API <ref group="Versão 251103">Liberado a partir da OS 000000650489/189.</ref>.<br>		Ativação do Log da API <ref group="Versão 251103">Liberado a partir da OS 000000650489/189.</ref>.<br>

Camila.Oliveira: /* Parametrização */

2026-10-19T19:44:13Z

Parametrização

← Edição anterior		Edição das 19h44min de 19 de outubro de 2026
Linha 13:		Linha 13:

	= Parametrização =		= Parametrização =
	~~<p align="justify">~~		* 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.
	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.~~<br>~~
	~~</p>~~

	= Utilização =		= Utilização =

Camila.Oliveira: /* Documentos relacionados */

2026-10-19T19:29:32Z

Documentos relacionados

← Edição anterior		Edição das 19h29min de 19 de outubro de 2026
Linha 53:		Linha 53:

	=Documentos relacionados=		=Documentos relacionados=
			* [[Portais]]

	=Versões=		=Versões=
	===Versão 251103===		===Versão 251103===
	<references group="Versão 251103"/>		<references group="Versão 251103"/>

Camila.Oliveira: /* Versões */

2026-10-19T19:29:11Z

Versões

← Edição anterior		Edição das 19h29min de 19 de outubro de 2026
Linha 51:		Linha 51:
	**** process-#-#.log		**** process-#-#.log
	***** Onde o primeiro # é o número do processo e o segundo # indica a sequência da parte do log.		***** Onde o primeiro # é o número do processo e o segundo # indica a sequência da parte do log.

			=Documentos relacionados=

	=Versões=		=Versões=
	===Versão 251103===		===Versão 251103===
	<references group="Versão 251103"/>		<references group="Versão 251103"/>

Elizama.Dias: /* LOG */

2025-09-25T12:40:18Z

LOG

← Edição anterior		Edição das 12h40min de 25 de setembro de 2025
Linha 40:		Linha 40:
	Incluindo as seguintes configurações:		Incluindo as seguintes configurações:
	* <add key="LOG_API_PASTA" value="C:\Temp\" /> ativa a gravação de logs		* <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:		* <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.		No exemplo acima, cada arquivo será quebrado em blocos de 10 MB.
Linha 50:		Linha 51:
	**** process-#-#.log		**** process-#-#.log
	***** Onde o primeiro # é o número do processo e o segundo # indica a sequência da parte do log.		***** Onde o primeiro # é o número do processo e o segundo # indica a sequência da parte do log.

	=Versões=		=Versões=
	===Versão 251103===		===Versão 251103===
	<references group="Versão 251103"/>		<references group="Versão 251103"/>