Listamos neste tópico os procedimentos para configurar e enviar os boletos do banco Sicredi por meio da API disponibilizada pela instituição.
Introdução ao módulo
O principal objetivo de uma API (Interface de Programação de Aplicações) é integrar dois sistemas diferentes.
O sistema permite uma integração com o banco Sicredi para os boletos emitidos, por meio de uma API.
Esta configuração substitui a opção “envio do arquivo de remessa para o banco”.
Cadastro no site do banco
Para ativar a API com o registro automático de boleto Sicredi será necessário realizar o cadastro no site disponibilizado pelo banco.
Cabe à empresa verificar com o banco se algum valor será cobrado para a prestação deste serviço.
Para cadastrar a API, siga o passo a passo abaixo:
- Acesse o portal do desenvolvedor Sicredi.
Clique no botão criar conta.
Selecione a opção conta profissional e preencha o formulário de acordo com os dados da empresa.
Após finalizar o cadastro, clique em Minha Conta > Minhas Apps e depois no botão “Criar Nova Aplicação”.
Será exibido um formulário para a criação de uma nova aplicação:
Neste formulário os campos devem ser preenchidos seguindo um determinado padrão:
- Nome da Aplicação: API de Cobrança + Beneficiário* + Agência* + Produção. Exemplo: API de Cobrança 11111-2222 Produção.
- Descrição: API de Cobrança + Beneficiário + Agência + Produção. Exemplo: API de Cobrança 11111-2222 Produção.
Selecione as opções “OPEN API – OAUTH – PARCEIROS 1.0.0” e “OPEN API – COBRANCA – PARCEIROS 1.0.0”.
Clique em “Registrar” para finalizar o cadastro.
Com a aplicação registrada, serão disponibilizados os campos “Client ID” e “Client Secret”, ambos utilizados pelo sistema.
Guarde os códigos ou anote o local onde estão o “Client ID” e o “Client Secret” fornecidos pelo banco, pois serão necessários na configuração da API.
Com o clientID e o client secret gerados, é necessário abrir um chamado com o suporte do Sicredi para solicitar o token de acesso no ambiente de Produção.
Para abrir um chamado, no menu de “Suporte” selecione a opção “Abra um chamado”.
No formulário preencha os campos com as seguintes informações:
- Escolha o tipo de solicitação abaixo: API Cobrança Boletos.
- Escolha o motivo do contato: solicitar Token de Acesso.
- Assunto: solicito o Token de Acesso de produção para integração ao software Zweb.
- Descrição detalhada: solicito o Token de Acesso de Produção para integração ao software Zweb, referente ao Client ID: (informe o Client ID gerado anteriormente).
Localize o Client ID no menu “Minhas Apps”.
- Ambiente: “Produção”.
- Client ID ou Nome da App: API Cobrança + Beneficiário + Agência + Produção. Conforme feito anteriormente na criação de uma nova APP.
Ao finalizar o preenchimento dos dados, clique em “Enviar” e aguarde até que o suporte do Sicredi forneça o retorno.
Para visualizar como está o status do chamado, acesse o menu Suporte > Meus chamados.
Quando o status do chamado estiver como aprovado, deve acessar o menu minha conta > minhas apps e clicar no link de detalhes na coluna access tokens.
O conteúdo da coluna código é o a informação que será preenchida no campo “Developer key”, na configuração da API do Zweb para o banco Sicredi.
Agora com o clienId, secret key e a developer key, inicie a configuração no sistema.
Configuração no Zweb
No sistema, acesse o menu Financeiro > Outros > Contas e clique em “Cadastrar conta” para cadastrar uma nova conta bancária.
Preencha os campos da seção boleto/remessa de acordo com a realidade da empresa e com base nos boletos já emitidos.
Se necessário, acesse o tutorial de configuração para geração de boletos para mais detalhes sobre esses dados.
Também é preciso que marque a opção API para liberar os campos relacionados à configuração da API.
Na seção “Configurações API”, preencha os dados solicitados com as informações geradas no site do banco.
- Username: informe uma combinação do código do beneficiário + número da cooperativa.
- Password: senha gerada no internet banking.
- ClientID: informe o clientID gerado anteriormente, ele pode ser consultado no internet banking, no menu minha conta > minhas apps.
- Client Secret: informe o client secret gerado anteriormente, ele pode ser consultado no internet banking, no menu minha conta > minhas apps.
- Developer Key: informe a “Developer Key” gerada anteriormente, que pode ser consultada no Internet Banking, em Minha Conta > Minhas Apps opção “Detalhes” na coluna “Access Tokens”.
Após informar os dados da API, clique em “salvar”.
Transmissão dos boletos
Quando finalizar o procedimento de configuração do boleto, sugerimos emitir um boleto como teste e confirmar com o banco se a operação obteve o êxito esperado.
Emita o primeiro boleto como teste e somente inicie a emissão de boletos caso o banco confirme a operação.
Acesse o menu Financeiro > Receitas e selecione as contas para transmitir os boletos ao banco. Clique em Ações > Emitir boleto.
Selecione a conta do Sicredi e clique em “emitir”.
Agora, basta aguardar que os clientes efetuem os pagamentos.
Retorno Bancário – recebimento dos boletos
No menu Financeiro > Receitas, clique no menu de Ações > API Boletos > Consultar Boletos.
Selecione a conta do Sicredi, informe o período de vencimento dos boletos e clique em “consultar”.
Uma mensagem de retorno será exibida como “Operação realizada com sucesso”.
Poderá verificar na listagem do módulo de receitas que as contas foram quitadas.
