GF - Como Fazer - Open Banking
Índice
Introdução
O Open Banking CIGAM é o projeto que visa implementar as APIs bancárias (interfaces online de comunicação) no ERP CIGAM. O maior benefício obtido com estas integrações é a eliminação do uso de arquivos CNAB (*.txt) e a migração para uma conexão direta com o banco. Assim o usuário passa a fazer tudo dentro do CIGAM sem precisar entrar no gerenciador financeiro do banco.
Com base em estatísticas colhidas com nossos clientes, após a implementação do open banking CIGAM é possível reduzir cerca de 5 a 8 horas semanais de envolvimento com os gerenciadores bancários! Isso é mais tempo para o que realmente importa!
Lista de APIs
Atualmente, cada banco possui um escopo próprio de soluções via API. Nas tabelas abaixo são descritos os serviços disponíveis por instituição bancária e a versão CIGAM em que eles foram liberados.
>>INCLUIR IMAGENS<<
Um tópico universal dentre todos eles é o de que para utilizar um serviço, são necessárias credenciais e, em alguns casos, até certificados digitais. No seção Obtenção das Credenciais serão apresentadas dicas de como proceder com a obtenção de credenciais em cada instituição.
Migrando um cliente do CNAB para a API Open Banking
A migração de um cliente que hoje está utilizando CNAB para os seus movimentos ocorre de forma transparente, o que está mudando é a forma de registro e não o registro em si. Pense no CNAB como um envio via carta, e o Open Banking como um e-mail, a mensagem chegará de ambas as formas, porém na primeira você precisa levar a mensagem escrita à mão até o correio, já a segunda você digita e envia de casa.
Essa troca de formato possibilita que quando um cliente tiver o seu CIGAM configurado no open banking ele poderá imediatamente realizar o retorno via API e irá obter as informações dos títulos registrados na instituição independentemente da forma de registro. Inclusive, o método de registro via CNAB continua valendo simultaneamente ao uso da API. Desta forma, embora alguns bancos disponibilizem ambientes de homologação, não recomendamos a criação de movimentos de teste nestes ambientes uma vez que existem restrições de CPF/CNPJ exclusivos para teste, situação que o cliente não possuirá.
Configurando APIs Open Banking para clientes novos em período de implementação
Para clientes novos, que não tem como registrar títulos oficiais no CIGAM, recomendamos avaliar a seção “testes em homologação” dentro de cada seção do item Assistente de configuração Open Banking (inserção de credenciais por banco) deste manual para obter informações de como utilizar o ambiente de homologação de cada banco.
Obtenção das Credenciais
Invariavelmente, para obter as suas credenciais, você deverá acessar primeiro o seu Gerente Cash ou gerente de conta PJ na instituição em que está buscando as credenciais. Em muitos casos, ele irá abrir um chamado técnico junto à área responsável para iniciar o seu processo de credenciamento seja através de um portal ou e-mail.
NOTA AOS SETORES DE ATENDIMENTO E IMPLEMENTAÇÃO CIGAM: independentemente do banco que você estiver configurando, antes de iniciar o processo implementação do Open Banking no CIGAM, é imprescindível ter os dados de credenciais, certificados digitais, scopes etc. em mãos, a primeira página do assistente open banking irá indicar as informações necessárias para cada banco. Recomendamos que o trabalho de implementação/atendimento só seja iniciado após a confirmação da existência de tais dados, uma vez que não está dentro das nossas possibilidades obter tais informações.
Gestão dos certificados digitais: Ainda no tópico referente aos dados de credenciais, normalmente itens como “Client_ID” e “Client_secret” tem validade indeterminada e não sofrem alteração a não ser a pedido do próprio cliente. Porém um item que vêm sendo bastante difundido e incorporado ao grupo de credenciais para utilização das APIs Open Banking é o CERTIFICADO DIGITAL, onde ele é consumido em vários formatos, seja apenas pela exportação da sua chave pública, como é feito no Bradesco, seja utilizando-o de modo semelhante à NFe, como é feito no SICOOB; mas também possuindo um processo de exportação e geração complexo como é o caso da V2 do Itaú.
Independentemente da forma com que foi gerado, assim como nos processos de Notas Fiscais Eletrônicas, o certificado digital possui prazo de validade, desta forma, o cliente deve estar atento a este período de expiração, onde um novo certificado deverá ser gerado e instalado/compartilhado com a instituição financeira sempre que houver a sua renovação. Isso também implica na possibilidade de ficar sem poder utilizar a comunicação com as APIs até que seja realizada a substituição do certificado vencido por um válido. O processo de substituição dos certificados irá variar conforme a instituição e pode ser revisado neste manual no item correspondente a cada instituição.
Abaixo serão disponibilizados os processos de obtenção de credenciais e fluxo de obtenção de certificados de acordo com cada banco. Os fluxos descritos abaixo podem sofrer alterações por parte dos bancos, portanto sempre leve em consideração consultar a sua instituição:
Configurando o Open Banking (informações gerais)
Apesar de cada banco possuir o seu jeito de ser parametrizado, o processo de configuração do Open Banking CIGAM se dá através de apenas dois cadastros, sendo: cadastro de configuração de Bancos, onde todas as informações de credenciais e gerais daquela instituição serão concentradas; e o cadastro de portador, onde serão apontadas as informações referentes a cada uma das contas correntes de cada instituição.
IMPORTANTE: Recomendamos que antes de realizar a parametrização de bancos para o open banking CIGAM você revise todos os portadores que serão utilizados no processo, eles precisam existir e estarem prontos para serem utilizados.
Configuração do Portador
O cadastro do Portador, como no processo CNAB tem o objetivo de apontar os dados de cobrança/pagamento para uma Conta Corrente. De forma geral, todos os dados já informados funcionam da mesma maneira no Open Banking.
Dados como carteira e variação permanecem no mesmo formato uma vez que estas são informações de domínio do banco. O único ponto de alerta é que para o Open Banking a opção “Processar retornos pelo número do boleto” deve estar marcada. (a rotina já realiza esta marcação, mas é importante verificar em caso de dúvidas).
>>>IMAGEM<<<
Caso tenha sido realizado movimentações com esta opção desmarcada, não será possível realizar a Baixa, pois sistema não consegue localizar devido não possuir o Nosso Número gravado nas tabelas envolvidas.
Para solucionar essa questão será necessário:
- GFBOLETOS: campo a ser atualizado NOSSO_NRO com a informação do Nosso Número.
- GFLAUXIL: campo a ser atualizado CODIGO_BARRAS com a informação do Nosso Número.
1.Identificar o Nosso Número do registro a ser baixado (Lançamento Financeiro);
2.Gravar o Nosso Número nas seguintes tabelas:
Outro ponto importante a considerar é o campo “auditoria” do portador, no open banking é mandatório que ele esteja configurado como "Detalhada" para que o log de auditoria seja registrado.
>>>IMAGEM<<<
Além disso, a configuração "GE - SI - 348 (Sincronismo lançamento)" precisa estar diferente de "Nenhum".
>>>IMAGEM<<<
Configuração de Bancos
No programa configuração de bancos, existe um tooltip que aponta quais os bancos estão disponíveis na sua versão do CIGAM:
>>>IMAGEM<<<
É no programa de configuração de bancos, dentro do botão “Open Banking” que serão informados os dados de credenciais, ambientes e serviços que serão utilizados via API para aquela instituição.
No primeiro acesso ao botão open banking, será chamado o assistente de configurações onde o usuário será acompanhado passo a passo no preenchimento das informações necessárias. Consulte a sessão 5 para um descritivo completo de cada um dos assistentes.
Telas de parâmetros open banking
Caso você já possua uma parametrização open banking para o banco que você está entrando, a tela de parâmetros será aberta, aqui será possível visualizar os dados atuais parametrizados para o banco. Caso você ainda não tenha realizado nenhuma parametrização open banking, sugerimos que você avalie primeiro o tópico 5 para as informações do assistente open banking específico para o banco que quiser configurar. Abaixo seguem as informações gerais de cada área da tela de parâmetros Open banking.
- Botão "Credenciais":
A tela de credenciais apresentada poderá ter entre uma e duas abas. Conforme o banco, poderá existir uma aba para cada ambiente entre homologação e produção com credenciais distintas. Mas também existem bancos apenas com ambiente de produção, sem possibilidade de testes em ambiente de homologação; e ainda, aqueles que utilizam as mesmas credenciais para ambos, homologação e produção tendo o apontamento do ambiente como um combo em tela. A especificação de cada banco será descrita no item 5 deste manual.
>>>IMAGEM<<<
Aqui são visualizadas todas as informações relacionadas às credenciais open banking do banco que se está pesquisando. As informações contidas aqui variam de acordo com a instituição e normalmente contém as credenciais (Client_secret e Client_ID), certificado digital (quando aplicável), versão da API que está sendo utilizada e dados de escopo (que são os serviços atendidos por aquelas credenciais).
As informações mais sensíveis estão protegidas por criptografia (representada pelo cadeado azul à direita) e não possuem nenhuma possibilidade de visualização. A partir do momento em que as informações são inseridas, o CIGAM as criptografa tanto em ambiente runtime quanto no banco de dados. A única forma de validar se as credenciais estão iguais às que você possui fora do CIGAM é através do botão 
onde você pode reinseri-las e clicar em “validar”, caso estejam de acordo com os dados previamente gravados, será emitida uma mensagem confirmando.
>>>IMAGEM<<< >>>IMAGEM<<<
Caso você queira utilizar um novo dado, basta inseri-lo e clicar em “confirmar”, o CIGAM irá checar novamente se é isso que você deseja fazer e substituir o dado antigo pelo novo.
>>>IMAGEM<<<
- Botão "Endereços":
Neste botão estão localizados os endereços de comunicação com as APIs bancárias do CIGAM para cada banco. Elas são geridas pela equipe de desenvolvimento CIGAM e não possuem possibilidade de alteração pelo usuário comum.
>>>IMAGEM<<<
- Abas Cobrança e Pagamento:
Atualmente possuímos as abas Cobrança e Pagamento para configuração dos portadores destas APIs em separado, porém ainda não possuímos a função pagamento, desta forma ela ainda não está em uso e todas as informações contidas nesta sessão são relativas ao serviço de Cobrança.
- Grupo Convênios e Portadores:
O grupo “convênios” pode ter N registros conforme o cliente os possuir, é comum que haja um convenio de cobrança e um convenio de pagamento em um cliente, porém pode ocorrer de haver mais de um convenio para um mesmo serviço de cobrança, por exemplo. O conteúdo do convenio é determinado durante a parametrização (no assistente do open banking) onde o usuário pode escolher apontar um convenio (localizado pelo CIGAM dentro do universo de portadores do banco que se está configurando), ou “pular” esta etapa. Caso selecionado, será criada uma linha com aquele convenio selecionado, caso pulado, será criada uma linha com a informação “Geral”.
Neste exemplo, foi localizado o convenio 946278214 dentre os portadores cadastrados para o banco SICREDI (746). Caso o usuário clique em “avançar”, os parâmetros OB serão criados em uma linha com este convenio, caso seja selecionado o botão “pular”, a parametrização será criada como “Geral”.
>>>IMAGEM<<<
Sempre que o Banco não especificar um convênio, sugerimos que esta etapa seja pulada para que as credenciais sejam criadas como “Geral”.
>>>IMAGEM<<<
O grupo “Portadores” está amarrado ao grupo “Convênios”, ou seja, pode existir mais de uma linha de portadores para um mesmo convênio, essa situação é gerada quando o cliente possui mais de uma conta corrente que realiza cobranças.
>>>IMAGEM<<<
No campo “Portador” está indicado o portador de registro a ser utilizado no registro dos boletos deste convenio, já o campo “Portador de Retorno” será trazido como sugestão de portador de liquidação na rotina de retorno open banking para os bancos que possuírem este serviço.
Aqui também existem alguns parâmetros relacionados ao comportamento do CIGAM como: “Direto” para que o registro seja feito diretamente na impressão do boleto; e “PIX” que irá indicar que os títulos registrados devem também registrar uma operação PIX e imprimi-la no boleto (atualmente disponível apenas no Banco do Brasil). Já o campo “U.N. Ced” funciona como Empresa cedente na API de cobrança do Itaú. Maiores detalhes podem ser encontrados na seção Funcionalidades Open Banking específica de cada banco.
