Central de Ajuda

Leitura de 3 min

Configurando Tarefas de Consulta para APIs Bancárias

Este tutorial irá guiá-lo através do processo de configuração de tarefas de consulta para APIs bancárias no Sistema, permitindo a atualização eficiente dos pagamentos recebidos.

Introdução

As APIs bancárias funcionam de maneira diferente dos gateways de pagamento no Sistema. Enquanto os gateways atualizam automaticamente a cada três horas e os Webhooks são imediatos, as APIs bancárias requerem configuração manual de tarefas para consultar e atualizar os pagamentos.

Passo 1 - Acessar o Módulo de Agendamento de Tarefas

  1. No menu Ferramentas, clique em Ferramentas.
  2. Selecione Agenda de Tarefas.

Dica!

Antes de criar uma nova tarefa, verifique os horários das tarefas já existentes para evitar sobreposições.

Passo 2 - Criar Nova Tarefa de Consulta

  1. Na tela de Agenda de Tarefa, clique no botão Novo.
  2. Tarefa: Selecione Consulta pagamento “NOME” API.
  3. Minuto (0-59): Coloque o valor dos minutos, entre 0 e 59 min.
  4. Hora (0-23): Coloque o valor da hora, entre 0 e 23. Podendo incluir mais horários utilizando a vírgula, exemplo:
  5. Horas (0-23): 6,12,18,23.

Aviso!

É recomendado configurar múltiplas tarefas ao longo do dia para garantir atualizações frequentes.

Passo 3 - Configurar Detalhes da Tarefa

  1. Selecione a API bancária específica que você está utilizando (ex: Banco do Brasil, Sicoob, Sicredi).
  2. Defina a frequência de execução (diária, horária, etc.).
  3. Configure os parâmetros específicos da API, se necessário.

Passo 4 - Salvar e Ativar a Tarefa

  1. Revise todas as configurações.
  2. Clique em Salvar para criar a tarefa.
  3. Certifique-se de que a tarefa esteja ativada para começar a executar nos horários programados.

Perigo!

Caso desejar um intervalo de consulta reduzido, por exemplo, executar a tarefa a cada 30 minutos, é possível. Porém, sempre é válido ressaltar que corre o risco de gerar lentidão e possíveis travamentos em seu servidor. Então busque horários em que não vá conflitar com demais tarefas em seu servidor. E busque o seu setor de TI para analisar o impacto em seu servidor. Dito isto, para o exemplo de configurar a tarefa a cada 30 minutos, você pode inserir os valores nos campos:

  • Minuto (0-59): */30
  • Hora (0-23): */1
  • Desta forma, o seu servidor irá executar a tarefa a cada hora do dia, com um intervalo de 30 minutos.

Aba: Logs consulta de pagamentos

O sistema armazena todos os logs de requisições e respostas trafegados com as APIs das instituições financeiras e Gateways, seja durante uma consulta manual pelo formulário ou por uma execução automática via tarefa de rotina.

Estes registros centralizam as informações de comunicação (como Endpoints, Cabeçalhos, Status HTTP e o Corpo da Resposta), o que simplifica e agiliza imensamente a análise técnica e o diagnóstico em casos de instabilidades ou falhas de compensação.

Para mais detalhes sobre os campos, regras e o uso desta funcionalidade, consulte a seção Aba Logs consulta de pagamentos nos artigos:

Conclusão

Você configurou com sucesso as tarefas de consulta para APIs bancárias no Sistema. Isso garantirá que os pagamentos recebidos sejam atualizados regularmente, melhorando a precisão do seu controle financeiro.

Etiquetas

APIBancaria ConsultaAPI AgendaDeTarefas Rotinas LogsGateway Recebimento ContasAReceber

Leia Também

Visão de gráfico

Páginas relacionadas