Ativação da API para boletos do banco Sicoob no ZWeb
Ativação da API para boletos do banco Sicoob no ZWeb
Listamos neste tópico os procedimentos para o envio de boletos do banco Sicoob por meio da API disponibilizada pela instituição.
O principal objetivo de uma API (Interface de Programação de Aplicação) é integrar dois sistemas diferentes. O sistema permite uma integração com o banco Sicoob para os boletos emitidos, por meio de uma API. Essa configuração substitui a opção “envio do arquivo de remessa para o banco”.
O sistema trabalha apenas com a versão V3 da API do SICOOB, é necessário ficar atento no momento da ativação para selecioná-la corretamente. Para ativar a API com o registro automático de boleto Sicoob 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. Acesse o site https://developers.sicoob.com.br/portal/dashboard e realize o cadastro. Após efetuar o cadastro e acessar a página com login e senha, clique no botão “gerar aplicativo”.
Seguindo com o cadastro da aplicação, preencha com o nome da aplicação (ex.: nome da empresa – registro de boleto – Gdoor) e uma descrição (Ex.: Registro de boletos via integração Gdoor). Selecione a opção desejada para a integração da API (conforme este exemplo “cobrança bancária”).
Nome do cooperado: informe o nome do titular da conta. Número da conta: informe o número da conta da empresa. A integração será por uma empresa parceira: selecione “não”. Certificado digital: clique no botão com o sinal de adição e localize o certificado digital. O certificado precisa estar no formato .CER, .CRT ou .PEM. Caso o certificado esteja no formato .PFX siga as instruções descritas no tutorial: https://developers.sicoob.com.br/portal/documentacao? slugItem=seguranca&slugSubItem=certificado-digital
A tela de confirmação será aberta. Confira todos os dados e, caso estejam corretos, clique em prosseguir. Serão gerados os dados referente a Client ID e Secret ID. Copie as informações e clique no botão “concluir”. Certifique-se de que a credencial foi gerada para o ambiente de produção.
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 de configurações API e preencha os dados solicitados de acordo com as
Client Id: copie a informação do campo Client ID do site da Sicoob.
Senha do certificado: informe a senha do certificado digital (.pfx). É a mesma senha que foi configurada nas emissões de NF-e e NFC-e. Importar certificado .pfx: é o mesmo arquivo do certificado que selecionou para a emissão de NF-e e NFC-e. A configuração da API deve ser realizada em todas as contas Sicoob que fazem o envio de boletos.
Caso deseje usar o QR Code Pix no impresso do boleto Sicoob, é possível configurar na
Para realizar a configuração, marque a opção Pix QRCode, selecione o tipo da sua chave PIX entre os disponíveis (CPF/CNPJ, telefone, e-mail e aleatória) e informe a chave PIX. A configuração de API PIX no Sicoob permite que você pague os boletos com o PIX ou efetue os recebimentos pelo módulo de receitas. Ao finalizar a configuração clique em salvar para gravar os dados.
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 que deseja transmitir os boletos para o banco. Após selecionar todas as contas, clique no botão Ações > Emitir boleto. Selecione a conta do Sicoob e clique em “emitir”.
Agora, basta aguardar que os clientes efetuem os pagamentos.
No menu Financeiro > Receitas, clique no menu de Ações > API Boletos > Consultar Boletos.
Selecione a conta do Sicoob, informe o período de vencimento dos boletos e clique em “consultar”. Uma mensagem de retorno será apresentada como “operação realizada com sucesso”. Poderá verificar na listagem do módulo de receitas que as contas foram quitadas.