Como obter acesso à API de Cobrança

O acesso à API de Cobrança tem duas frentes: uma comercial/contratual (feita com a cooperativa) e uma técnica (feita no Portal do Desenvolvedor e no Internet Banking). Você precisa das duas antes da primeira chamada.

  1. Contratação (com a cooperativa)
    • Contrate o produto Cobrança com o seu gerente de conta, optando pela modalidade API (Cobrança Online).
    • Na contratação é gerado o Código do Beneficiário (código do convênio), obrigatório em toda a integração.
    • Assine o termo de adesão após a análise de negócio.
    • Se pretende emitir boletos híbridos (com Pix), solicite a habilitação da modalidade híbrida no Portal PJ. Não é necessário contratar o produto Pix separadamente.
  2. Aplicação e x-api-key (Portal do Desenvolvedor)
    • Acesse o Portal do Desenvolvedor Sicredi, crie uma conta (ou faça login).
    • Crie uma nova aplicação. Sugestão de nome para diferenciar ambientes: API Cobrança
    • Selecione a API de Cobrança e a API de Autenticação de Parceiros na lista de APIs.
    • Ao criar a aplicação, você recebe o Client ID. O x-api-key que você usa nas requisições é obtido na área de access token da aplicação, após abrir o chamado de liberação pelo menu Suporte > Abrir chamado. O token de cada ambiente (Sandbox e Produção) fica visível em Minhas Apps > (sua app) > Ver detalhes.
  1. Código de acesso (Internet Banking)

    • Acesse o Internet Banking pela conta vinculada ao convênio de Cobrança, com perfil Master.
    • Vá em Cobrança > Código de Acesso > Gerar. Esse menu só aparece para beneficiários com a modalidade API (Cobrança Online) habilitada.
    • Guarde o código gerado, é o password do Passo 1 da autenticação.
📘

O código de acesso é por conta. Se você integra mais de uma conta com Cobrança, gere um código para cada conta e autentique-se separadamente para cada uma.

  1. Sequência de ambientes

Valide primeiro em Sandbox (com os dados de teste da seção "Antes de começar") e só então mude a URL base para Produção com os dados reais. Lembre que Webhook e consulta v2 não têm Sandbox.




Did this page help you?