Manual de integração financeira via API de cobrança online Sicredi
1 - Primeiros passos para iniciar o processo de integração da API de Cobrança Online.
- O responsável pela conta do condomínio(associado) precisará entrar em contato com o gerente de conta no Sicredi e solicitar a alteração do convênio de cobrança para a API de Cobrança Online Sicredi.
- Se for uma conta nova, ao contratar o convênio de cobrança solicitar para que seja habilitado na modalidade de API – Cobrança Online Sicredi.
- Solicitar o boleto híbrido (boleto com o QRCode para pagamento com PIX).
- Após ser habilitado a API de Cobrança Online, no Internet Banking será disponibilizado a opção de menu para gerar uma CÓDIGO DE ACESSO de segurança que será utilizada para fazer a integração no Condominizar.
- Efetuar o cadastro no site developers para solicitar o TOKEN DE ACESSO.
2 - Como obter a chave de acesso
- Acesse o Internet Banking pelo navegador do seu computar utilizando as informações da conta e convênio de cobrança com o usuário e senha do titular da conta.
- Selecionar a opção de menu: COBRANÇA em seguida clique na opção GERAR do menu CÓDIGO DE ACESSO.
- Importante: Para a validar a geração do código deve ser feito através do aplicativo instalado no celular, pelo responsável da conta, com a senha master de acesso.
- Na tela seguinte marque a opção Li e concordo com o termo de adesão e em seguida clique em avançar.
- Em seguida, abra o aplicativo do Sicredi no celular e na tela de login, clique na opção Segurança, para ativar a leitura do QRCode, e aponte para a tela do computador.
- Depois que o aplicativo executar a leitura do QRCode, aguarde alguns segundos que a tela do seu navegador irá atualizar, e apresentar o Código de acesso, conforme a imagem abaixo
- Clique no botão imprimir e salve este arquivo em PDF que ele será usado para parametrizar a integração com o Condominizar.
Importante: O banco sicredi está lançando uma nova atualização para contas que possuam duas pessoas que fazem aprovação, onde o caminho para emitir o código de acesso está localizado em outro campo, caso após ter efetuado a leitura do QRCODE e a chave de acesso não tenha surgido na tela, recomendamos seguir este passo a passo abaixo:
- Acesse o menu Outros serviços.
- Em seguida acesse Histórico de transações e procure pelo período que foi feito a solicitação.
Feito, em seguida clique no botão imprimir e salve este arquivo em PDF que ele será usado para parametrizar a integração com o Condominizar.
3 – Como fazer o cadastro no portal do desenvolvedor
O cadastro neste portal é realizado apenas uma vez com os dados da administradora. Nesta área irá cadastrar todas as aplicações de integrações das contas financeiras dos condomínios administrados.
Utilizar um e-mail que possa ser de uso comum para todos.
Acessar o portal https://developer.sicredi.com.br/api-portal/pt-br/user/register
Clique em CRIAR CONTA.
Efetuar o cadastro com os dados da administradora:
- Selecione Conta profissional.
- Nome da administradora.
- E-mail da empresa – não pode ser trocado posteriormente.
- Senha de 10 dígitos para acesso posterior.
- Selecione as opções de receber e-mail de aceite de termos.
Ao clicar em “Criar Conta” será encaminhado um e-mail para sua caixa de e-mail para confirmar o cadastro de acesso.
Após receber o e-mail, clicar em Confirmar acesso, será direcionado para o site do Sicredi para prosseguir com o cadastro da aplicação.
4 – Como criar uma aplicação (APP’S)
Clique no botão CADASTRAR NOVA APP
Nome da API: APP+Agência+conta do condomínio
Descrição: Aplicação de integração de cobrança
5 – Selecione as opções da API
- OPEN API - OAUTH - PARCEIROS 1.0.0
- OPEN API - COBRANÇA - PARCEIROS 1.0.0
Clique REGISTRAR
Será direcionado para a tela de APP’S criada, já com a informação do Client_id que será solicitado no próximo passo.
Atenção: Copie somente a parte inicial do código Client_id, duas primeiras linhas até a barra. (Ou duplique a página para copiar quando for solicitado).
6 – Como solicitar o Access Token
- Nesse momento abre-se um chamado para o suporte do banco analisar e aprovar a criação da aplicação (API) quando será liberando o Token de integração.
- Acesse o menu SUPORTE
- Abrir Chamado
- No cadastro selecione:
- Api Cobrança Boletos;
- Solicitar Access Token;
- Assunto: "Solicitação de Token de acesso";
- Descrição completa: "Estamos fazendo a integração pela API de Cobrança Online"
- Selecionar o ambiente: Produção
- Cola o ClientId copiado na tela anterior
- ENVIAR
Feito este processo de cadastro no portal do desenvolvedor, aguardar até ser disponibilizado o TOKEN de ACESSO.(Em torno de de 30 min.).
7 – Acompanhamento do processo
No menu SUPORTE em Meus chamados para acompanhar e verificar status do processo.
8 - Como localizar o TOKEN DE ACESSO.
Acesse pelo menu Minha Conta – Minhas APIs
Clique em Ver detalhes
Assim que aprovado chave TOKEN estará disponível para ser copiado.
9 - Cadastrar o convênio e configurar a API no Condominizar
- Acesse menu CONTAS FINANCEIRAS em seguida
- Se estiver incluindo uma conta nova no Condominizar acesse a opção INCLUIR CONTA. Após cadastrar a conta inclua o convênio de cobrança.
- Acesse a opção COBRANÇA - em TIPO DE INTEGRAÇÃO selecione INTEGRAÇÃO POR API.
Verifique se a sequência de numeração de Último boleto, caso não tenha informe 200000. (Formado por 6 dígitos, iniciando com o número 2), caso tenha alguma numeração de boleto é importante que siga este padrão, mais a sequência de números de boletos.
- SALVAR Importante: Salvar alterações antes de configurar a API.
10 - Configurando a integração pela API
Clique no link Clique aqui para alterar para em cadastrar as chaves.
NOVA API DE COBRANÇA
- Informe a chave gerada pelo Internet Banking
- Informe o Token criado pelo portal do desenvolvedor
- SALVAR
11 - Teste de registro
Feito o processo de cadastramento agora o próximo passo é verificar se está tudo funcionando perfeitamente, para isso vamos fazer um teste registrando um título de R$50,00. (Importante que seja um valor maior de R$50,00 para que valide o cálculo de juros).
- Vá no menu FINANCEIRO em TÍTULOS A RECEBER
- Cadastre um título individual para o teste.
- Selecione o título e acesse o botão BOLETO em seguida REGISTRAR.
- Feito isso acesse o Internet Banking para verificar se o título foi registrado.
- Para excluir o registro do título basta Excluir o registro no Condominizar que já será excluído no banco.
- Os retornos de liquidações são feitos automaticamente. A partir deste momento toda troca de arquivo foi eliminada.