Layout Requisição API - Histórico de revisão

Vinicius em 18h15min de 27 de janeiro de 2026

2026-01-27T18:15:52Z

← Edição anterior		Edição das 15h15min de 27 de janeiro de 2026
Linha 90:		Linha 90:
	Exemplos:		Exemplos:

	Banco do Brasil: True;Authorization;Bearer		Banco do Brasil e Bradesco: True;Authorization;Bearer

	Itaú: False;Authorization;Bearer		Itaú: False;Authorization;Bearer

Vinicius em 13h16min de 12 de novembro de 2025

2025-11-12T13:16:39Z

@@ Linha 104: / Linha 104: @@
 '''Ident-Banco-Conta''' - é a identificação do código do banco do ERP + o número da conta, esse campo se faz necessário para a guarda das credenciais no XML de configuração.
 == Layout de Registro de Cobrança ==
@@ Linha 277: / Linha 289: @@
     situacao-nome_do_campo
-Ultima atualização em 10/11/2025
+Ultima atualização em 12/11/2025

Vinicius em 13h10min de 12 de novembro de 2025

2025-11-12T13:10:34Z

Mostrar alterações

Vinicius em 19h08min de 10 de novembro de 2025

2025-11-10T19:08:50Z

← Edição anterior		Edição das 16h08min de 10 de novembro de 2025
Linha 206:		Linha 206:
	'''Nosso Número Banco do Brasil:''' NrParaTexto([[ConcatenarValores([numeroConvenio], , [[NrParaTexto({Cobranca.NossoNumero}, 10, False, 0, False)]], , , , )]], 20, False, 0, False)		'''Nosso Número Banco do Brasil:''' NrParaTexto([[ConcatenarValores([numeroConvenio], , [[NrParaTexto({Cobranca.NossoNumero}, 10, False, 0, False)]], , , , )]], 20, False, 0, False)

			== Filtros Adicionais ==
			Cabeçalhos adicionais podem ser incluídos adicionando novos elementos na seção
			de cabeçalho. Devem ser adicionais de acordo com as exigências da API.


	Ultima atualização em 19/01/~~2024~~		'''Nome Tag''' deve ser usada quando houver tags com o mesmo nome sendo do tipo
			VrAcopl, por exemplo desconto e juros que possuem uma tag filha chamada 'tipo'.
			Se não preenchida, será usada a coluna de identificação/descrição.


			Exemplo utilização campo pai:

			desconto {
			'valor':1.00, (Campo pai = desconto)
			'vencimento':01.01.0001 (Campo
			pai = desconto)
			}


			Filtro de Datas
			dataini-nome_do_campo
			datafim-nome_do_campo
			periodo-nome_do_campo
			Filtro de consulta
			pagina-nome_do_campo
			situacao-nome_do_campo

			Ultima atualização em 10/11/2025

Vinicius em 19h46min de 7 de abril de 2025

2025-04-07T19:46:57Z

← Edição anterior		Edição das 16h46min de 7 de abril de 2025
Linha 94:		Linha 94:
	'''Authorization''' - é o meio de autorização que a API exige para realizar as requisições, ou seja, no caso do Banco do Brasil é preciso enviar o client-id e o client-secret em base64, então o primeiro valor se refere ao fazer o hash em base64 das credenciais ou não, devendo ser informado '''(True ou False)''', seguido de um ponto e vírgula, e o próximo valor é a chave do Header da requisição para a autorização '''(Authorization)''', seguido de um ponto e vírgula, e o próximo valor é o tipo do token (token type) '''Bearer'''.<br>		'''Authorization''' - é o meio de autorização que a API exige para realizar as requisições, ou seja, no caso do Banco do Brasil é preciso enviar o client-id e o client-secret em base64, então o primeiro valor se refere ao fazer o hash em base64 das credenciais ou não, devendo ser informado '''(True ou False)''', seguido de um ponto e vírgula, e o próximo valor é a chave do Header da requisição para a autorização '''(Authorization)''', seguido de um ponto e vírgula, e o próximo valor é o tipo do token (token type) '''Bearer'''.<br>

	Valor do campo: True;Authorization;Bearer<br>		Valor do campo Banco do Brasil: True;Authorization;Bearer<br>
			Valor do campo Itáu: False;Authorization;Bearer<br>

	Lembrando que esse é para a API do Banco do Brasil, podendo variar para os outros bancos;<br>		Lembrando que esse é para a API do Banco do Brasil, podendo variar para os outros bancos;<br>

Vinicius em 14h52min de 3 de fevereiro de 2025

2025-02-03T14:52:47Z

← Edição anterior		Edição das 11h52min de 3 de fevereiro de 2025
Linha 106:		Linha 106:
	'''Chave-Aplicativo''' - é a chave que será utilizada indicando qual o aplicativo que está fazendo a requisição;		'''Chave-Aplicativo''' - é a chave que será utilizada indicando qual o aplicativo que está fazendo a requisição;

	'''Ident-Banco-Conta''' - é a identificação do código do banco + o número da conta, esse campo se faz necessário para a guarda das credenciais no XML de configuração.		'''Ident-Banco-Conta''' - é a identificação do código do banco do ERP + o número da conta, esse campo se faz necessário para a guarda das credenciais no XML de configuração.

	== Layout de Registro de Cobrança ==		== Layout de Registro de Cobrança ==

Vinicius em 15h10min de 16 de janeiro de 2025

2025-01-16T15:10:08Z

← Edição anterior		Edição das 12h10min de 16 de janeiro de 2025
Linha 84:		Linha 84:

	Os primeiros passos é criar a seção cabecalho. Ao adicionar a seção cabeçalho será adicionado os valores necessários para a requisição, basta preencher:		Os primeiros passos é criar a seção cabecalho. Ao adicionar a seção cabeçalho será adicionado os valores necessários para a requisição, basta preencher:
	[[Arquivo:Secao cabecalho registro.png\|centro]]		[[Arquivo:Secao cabecalho registro v2.png\|centro]]

	Os valores são preenchidos da seguinte maneira (Esses valores são essenciais para todos os layouts de envio):		Os valores são preenchidos da seguinte maneira (Esses valores são essenciais para todos os layouts de envio):
Linha 92:		Linha 92:
	'''Requisição''' - é o serviço a ser utilizado;		'''Requisição''' - é o serviço a ser utilizado;

	'''Authorization''' - é o ~~token~~ para ~~ser autenticado no servidor da API~~, ~~algumas API's fornecem um token permanente~~, no caso da do ~~banco~~ do ~~brasil~~, ~~eles~~ não ~~fornecem~~, ~~porém~~, o ~~ERP coleta~~ esse ~~valor automático~~, ~~então pode deixar vazio nesse caso~~;		'''Authorization''' - é o meio de autorização que a API exige para realizar as requisições, ou seja, no caso do Banco do Brasil é preciso enviar o client-id e o client-secret em base64, então o primeiro valor se refere ao fazer o hash em base64 das credenciais ou não, devendo ser informado '''(True ou False)''', seguido de um ponto e vírgula, e o próximo valor é a chave do Header da requisição para a autorização '''(Authorization)''', seguido de um ponto e vírgula, e o próximo valor é o tipo do token (token type) '''Bearer'''.<br>

			Valor do campo: True;Authorization;Bearer<br>

			Lembrando que esse é para a API do Banco do Brasil, podendo variar para os outros bancos;<br>

	'''Url-OAuth''' - é o link em que a requisição será autenticada, ou seja, é o link em que será coletado um novo token (Authorization);		'''Url-OAuth''' - é o link em que a requisição será autenticada, ou seja, é o link em que será coletado um novo token (Authorization);
Linha 100:		Linha 104:
	'''Scopos''' - É a identificação de quais serviços serão utilizados, esses valores são de uso interno da API;		'''Scopos''' - É a identificação de quais serviços serão utilizados, esses valores são de uso interno da API;

	'''Chave-Aplicativo''' - é a chave que será utilizada indicando qual o aplicativo que está fazendo a requisição.		'''Chave-Aplicativo''' - é a chave que será utilizada indicando qual o aplicativo que está fazendo a requisição;

			'''Ident-Banco-Conta''' - é a identificação do código do banco + o número da conta, esse campo se faz necessário para a guarda das credenciais no XML de configuração.

	== Layout de Registro de Cobrança ==		== Layout de Registro de Cobrança ==
	Ao criar o layout de registro de cobranças, você vai precisar da seção Dados, que será utilizada para montar o corpo da requisição, ela é criada da seguinte maneira:		Ao criar o layout de registro de cobranças, você vai precisar da seção Dados, que será utilizada para montar o corpo da requisição, ela é criada da seguinte maneira:
	[[Arquivo:~~Secao~~ dados ~~registro~~.png\|centro]]		[[Arquivo:Seção dados layout requisição API v2.png\|centro]]

	Para criar os elementos, você pode utilizar Textos, Formulas e Campos. Como comentando anteriormente a estrutura do envio da requisição da API é formada da seguinte maneira:		Para criar os elementos, você pode utilizar Textos, Formulas e Campos. Como comentando anteriormente a estrutura do envio da requisição da API é formada da seguinte maneira:

Vinicius em 12h19min de 19 de janeiro de 2024

2024-01-19T12:19:53Z

← Edição anterior		Edição das 09h19min de 19 de janeiro de 2024
Linha 202:		Linha 202:


	Ultima atualização em 08/09/~~2023~~		Ultima atualização em 19/01/2024

Vinicius em 12h19min de 19 de janeiro de 2024

2024-01-19T12:19:38Z

← Edição anterior		Edição das 09h19min de 19 de janeiro de 2024
Linha 189:		Linha 189:
	== Parametrização das Ocorrência Bancária ==		== Parametrização das Ocorrência Bancária ==
	Para parametrizar as ocorrências bancárias referentes as requisições por meio da API, segue a imagem abaixo:		Para parametrizar as ocorrências bancárias referentes as requisições por meio da API, segue a imagem abaixo:
	[[Arquivo:Parametrizacao ~~banco~~.png\|centro]]		[[Arquivo:Parametrizacao Banco API.png\|centro]]

	~~Para parametrizar as ocorrências bancárias foi definido dois códigos, um de envio e outro~~ de retorno~~, o de envio foi definido como 90~~ com o tipo de ação '''~~Envio_Cobranca~~''' e ação '''~~Envio_Cobranca_Api~~''' e o de ~~retorno sendo 91 com~~ o ~~tipo de ação~~ '''~~Retorno~~''' e a ação '''~~Retorno_Liquidacao~~'''.		A nova coluna Cod.Api indica uma relação do código de retorno por arquivo com o retorno da API

			O tipo de ação de envio de cobrança por API permanece sendo o '''Envio_Cobranca_Api''', aonde por sua vez pode ser parametrizado com qualquer código, o motivo de ter essa ação é pelo fato de que no modo convencional de gerar as cobranças pela remessa de arquivo não criava o '''Nosso Número''', e sim somente na impressão do boleto. Como para registro de cobranças por meio da API é obrigatório o envio do '''Nosso Número''' ele é gerado assim que é gravada a remessa online, como o tipo de ação '''Envio_Cobranca_Api'''.

	== Formulas ==		== Formulas ==

Vinicius em 13h08min de 8 de setembro de 2023

2023-09-08T13:08:43Z

← Edição anterior		Edição das 10h08min de 8 de setembro de 2023
Linha 201:		Linha 201:

	Ultima atualização em 08/09/2023		Ultima atualização em 08/09/2023


	~~Debug para Teste: H:\ERP-Debug Teste~~