Ambientes

Ambiente Sandbox

O ambiente de Sandbox permite que as requisições sejam devidamente testadas antes de serem executadas em produção. Isso previne que os dados reais sejam afetados por erros desconhecidos.

É possível executar todos os recursos da API Koncili nesse ambiente e, todas as informações criadas ou alteradas não terão nenhuma ligação com os dados em produção.

Ambiente de produção

Após os testes serem concluídos no ambiente de Sandbox, será requerido uma validação técnica das chamadas que foram realizadas. Após a validação ser concluída e todas as requisições aprovadas será liberado um outro Token de acesso permitindo o uso do ambiente de produção.

Callback de conciliação

O que é?

O Callback de conciliação é uma funcionalidade do Koncili que envia uma notificação a um sistema de integração quando há repasses não resolvidos prontos para baixa.

Porque usar?

Esta funcionalidade é parte integrante do processo de baixa de repasses. Ela pode ser uma alternativa eficaz para economizar recursos computacionais. Dependendo da estratégia de integração, pode ser utilizada como gatilho para iniciar o processo de baixa ao invés de mantê-lo constantemente ativo.

Como funciona?

Para receber esta notificação, é necessário que sua aplicação aceite requisições POST no formato JSON para o objeto listado abaixo:

                  
  {
    "date": "2021-11-01T12:00:00",
    "token": "1234567890",
    "uris": [
      "https://api.koncili.com/externalapi/orderextract/unresolveds?initDate=2021-08-23&endDate=2021-08-23&conciliationId=123456",
      "https://api.koncili.com/externalapi/orderextract/unresolveds?initDate=2021-08-26&endDate=2021-08-26&conciliationId=678910",
      "https://api.koncili.com/externalapi/orderextract/unresolveds"
    ]
  }
                  
                

Vejamos o que cada atributo significa:

• date: Data e hora da notificação.
• token: Chave de verificação, que se informada no cadastro do callback, será enviada pelo Koncili em toda notificação. Dependendo da opção cadastrada, esta chave pode ser um atributo no JSON ou header na requisição POST.
• uris: Array de URLs para pesquisa onde existem conciliações com lançamentos pendentes de baixa.

Quando uma requisição POST de callback for enviada pelo Koncili, a URL configurada em sua aplicação deverá retornar o status OK(200) ou ACCEPTED(202) em caso de sucesso para o recebimento das notificações.

Como ativar o callback?

Logado no Koncili, procure no menu pelo seguinte caminho: Integrações -> Callbacks.

A tela de cadastro de callbacks será apresentada. Nela você poderá ativar, reiniciar ou apagar um callback. Também poderá encontrar um histório das requisições enviadas pelo Koncili para a URL configurada.

No campo 'URL Callback', você deverá informar a URL para onde o Koncili enviará as requisições (POST) de notificação.

No campo 'Forma de envio token', você deverá uma das 3 opções disponíveis:

• Não enviar: Para desabilitar o envio da chave de verificação da autenticidade da requisição.
• Cabeçalho: Para habilitar o envio da chave de verificação de autenticidade como atributo 'token' no HEADER da requisição POST de notificação.
• Corpo do JSON: Para habilitar o envio da chave de verificação de autenticidade como atributo 'token' no corpo da JSON enviado na requisição POST de notificação.

No campo 'Token', você deverá informar uma chave de verificação de autentidade da requisição que será enviada em cada notificação.

No campo 'Período para execução', você deverá informar um período para o envio das notificações. Este período também serve como base para tentativas, caso a resposta para a requisição seja algo diferente dos status OK(200) ou ACCEPTED(202).

Caso tudo esteja configurado, quando uma conciliação for finalizada, o Koncili tentará notificar o sistema de integração.

Serão realizadas no máximo 10 tentativa de notificação respeitando o período de execução informado pelo usuário. O Koncili irá interromper as tentativas quando receber a confirmação da aplicação de integração. Neste caso, após o restabelecimento da comunicação entre as aplicações, será necessário aplicar um reset nos callbacks configurados utilizando a opção de tela.

As tentativas ficarão registradas na aba Histórico da tela de Callbacks.

O fluxo de integração para baixa utilizando o Callback de conciliação pode ser consultado na seção de Fluxos de integração/Baixa e resolução de repasses.

Se houver alguma dúvida, basta entrar em contato conosco pelo e-mail suporte@koncili.com. Obrigado.