Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
  1. Visão Geral
  2. Exemplo de utilização
  3. Principais Campos e Parâmetros 
  4. Configuração ambiente Protheus Rest
  5. Tabelas utilizadas


Modelo de dados a ser seguido para consumo da API Balancete Modelo1 (CTR040S) via Smartlink .

...

Configurar no Schedule o Job FWTOTVSLINKJOB .

Aviso
titleIMPORTANTE

Inserir a configuração somente no ambiente que estiver em produção.

Bases de testes que estejam configuradas com o Smartlink interceptarão mensagens da fila da mesma forma que a base de produção, fazendo com que a gravação ou retorno dos dados sejam executados na base de testes. 

Para utilizar a rotina de importação automática são necessários as configurações abaixo descritas:


Expandir
titleCadastrando o agendamento "Schedule" (CFGA010)
  1. Acesse, no módulo Configurador (SIGACFG),  Ambiente →  Cadastros →  Schedule →  Agendamentos →  Cadastro →  Botão Incluir:

    Image Added

  2. Ao clicar no botão incluir os campos: Código, Usuário, Nome do Usuário, Data, Hora e Ambiente serão preenchidos automaticamente com as informações do acesso propriamente dito, será necessário definir apenas a "Rotina" que no caso deve ser utilizado para Retorno Automático de Extratos Bancários (FINA475), a "Empresa/Filial" que o JOB vai considerar no Processamento e também deve-se informar o "Módulo" que se refere a ROTINA "06 - Financeiro"

    Image Added


    Informações
    titleImportante

    O botão "Parâmetros" não será utilizado para a rotina FINA475, pois os parâmetros de execução são definidos no Cadastro Parâmetros de Bancos FINA130.



  3. Após realizado as definições acima, clique em "Recorrência", para definir a recorrência de execução do Job:
    Image Added
    Defina em qual momento e quantas vezes será realizado o processamento e "Confirme":

    Image Added
  4. Feito isso, "Confirme" a inclusão do Agendamento:

    Image Added

  5. Ainda no Cadastro do Schedule (CFGA010) acesse: Agent > Cadastro > Adicionar Agents Padrão

    Image Added

    Ao realizar a inclusão de um AGENT padrão, automaticamente o sistema já preenche os dados do ambiente padrão (logado) - IP do AppServer, Porta e Ambiente - que será executado o Job parametrizado anteriormente.
Expandir
titleCadastrando Parâmetros Bancos (FINA130)

Este cadastro tem como finalidade configurar os parâmetros bancários utilizados em diversas operações relacionadas a comunicação bancária.

Expandir
titleConfiguração de Envio de E-mail - Visão Geral

Para a importação de extratos bancários, é necessário gerar uma senha de APP, no caso do G-Mail, primeiro precisamos ativar a verificação em duas etapas:

Image Added

Após a verificação de duas etapas ativada, é necessário adicionar um APP e gerar uma senha:

Image Added

Image Added

Copie a senha gerada e salve em um lugar seguro.

Image Added

Com a senha de app gerada, abra o Protheus no SIGACFG, ambiente, E-mail/Proxy, Configurar. Coloque o servidor de e-mail, o seu e-mail e a senha do APP gerada anteriormente, em servidor de e-mail necessita de autenticação, coloque sim.

Image Added

Na próxima tela, apenas clique em avançar sem alterar nada:

Image Added

Utiliza segurança TLS - SIM

Image Added

Finalize a configuração de E-MAIL:

Image Added

Expandir
titleConfigurações de Credenciais para Importação do Extrato via API
Aviso
titleATENÇÃO


Bancos disponíveis para operação de extrato por API:


É possível efetuar a importação do extrato bancário por meio da API (Interface de Programação de Aplicações), eliminando a necessidade de um arquivo para tal procedimento.

Para utilizar o serviço de API, é fundamental configurar as credenciais por meio de um layout Pagar nas configurações de contas do NGF (Novo Gestor Financeiro).

É possível incluir um layout acessando o a rotinaFINA710 - Novo Gestor Financeiro.

  • Acesse o menu Comunicação online;
  • Selecione a opção Configuração de contas;
  • E cadastre um Novo layout.

Novo layout de contaImage Added












Também é preciso selecionar entre as opções "API Extrato" — evitando que este layout seja considerado na API para registros de títulos a pagar — ou "Ambos", para que o layout seja incluído tanto na operação de extrato quanto no registro via API dos títulos a pagar.

Opções de layoutImage Added


Após essa etapa de configuração, informe as credenciais de autenticação fornecidas pelo banco, juntamente com o certificado digital correspondente.

Credenciais layoutImage Added

Para mais informações sobre este processo acesse Contas a pagar (Comunicação bancária online).


Informações
titleImportante:

Certifique-se de que este serviço esteja ativo para a sua conta bancária. Recomenda-se verificar a disponibilidade diretamente com o seu gerente.



Envio de dados deve ser realizado via SmartLink utilizando o Padrão CloudEvents/Modo Estruturado para envio de mensagens no formato Json de acordo com o modelo a seguir :

...

OBS: Erro: não foi encontrado servidor Rest, verifique se o serviço Rest foi iniciado.

Os campos e parâmetros devem ser passados conforme padrão Padrão CloudEvents/Modo Estruturado . O conteúdo da propriedade data:{} deve ser enviado conforme documentação: documentação API balancete modelo1.

O sistema irá chamar a api com base nos parâmetros configurados no appserver.ini conforme modelo abaixo:

...

Em casos onde o security = 1 a api deverá ser adicionada na lista de exceções conforme modelo abaixo.


  • CT1- Plano de Contas
  • CQ0- Saldo por Conta no Mês
  • CQ1- Saldo por Conta no Dia        
  • CVN - Plano de Contas Referencial
  • CVD - Plano de Contas Referenciais  
  • CTG - Calendário Contábil       

...