Ativação por API
Com o registro por API (também chamado de webservice), a Kobana registra, altera e cancela os boletos direto no banco, pela conexão da sua conta com o banco, sem precisar de arquivo de remessa. A ativação por API também libera uma carteira que ainda está em Homologação Pendente.
A opção só aparece quando o banco da carteira oferece registro por API.
O que é preciso
Uma conexão ativa com o banco da carteira, cadastrada em Integrações > API > Conexões Configuradas (ou Configurar Nova). A conexão guarda as credenciais que o banco forneceu para a integração.
Onde fica no painel
Na tela da carteira:
- enquanto a carteira não está ativa, no quadro Conexão com Web Service;
- com a carteira ativa, em Ações > Ativar Webservice.
O botão muda conforme a situação da sua conta:
| Botão | Situação | O que fazer |
|---|---|---|
| Configurar conexão | A conta não tem conexão ativa com o banco da carteira. ("Você precisa criar ou habilitar uma conexão para o registro online.") | O botão abre o cadastro de conexões já filtrado pelo banco. Cadastre e ative a conexão, e volte à carteira. |
| Associar conexão | A conta tem conexão ativa com o banco, mas ela não está associada à carteira. ("Você possui conexão ativa disponível e precisa associá-la à carteira.") | Na tela Associar conexão, clique em Associar na conexão desejada. |
| Ativar conexão | A carteira já tem uma conexão ativa associada. ("Você já possui uma conexão ativa associada a esta carteira e precisa autorizar a integração para permitir o registro online.") | Clique para ativar. |
Ao ativar, o painel mostra "Carteira ativada com sucesso!" e a carteira passa a Ativa, com o registro por API ligado. Se a conexão associada não está ativa, o painel mostra "Carteira não pode ser ativada".
Trocar ou remover a conexão
Com a carteira ativa, Ações > Alterar Conexão abre a mesma tela de associação. Lá você associa outra conexão ou usa Desassociar na conexão atual, quando permitido.
Depois da ativação
- Os novos boletos da carteira são registrados por API. Veja Registro no banco.
- Se o registro por API falhar e a carteira também aceitar remessa CNAB, a Kobana pode incluir o pedido na próxima remessa.
Permissões
Ativar o registro por API exige a permissão Ativar API no módulo Carteiras de Cobrança.
Eventos de webhook
bank_billet_account.activated: a carteira foi ativada.