Pular para o conteúdo principal

Marcadores na API pública

· 3 min para ler
Equipe Banqer
Backplane Soluções em TI

Os marcadores agora podem ser controlados pela API pública. Com o filtro Marcadores dos lotes de cobrança, o integrador passa a controlar a segmentação da carteira.

Para que serve​

O integrador monta listas de fichas a partir de qualquer fonte com identificadores do cliente:

  • Resultados de outras consultas do Banqer.
  • O discador da operação.
  • Listagens e relatórios enviados pelo credor.
  • Higienizações.

Uma automação do integrador mantém essas listas nos marcadores, e os lotes de cobrança que usam o filtro Marcadores seguem a segmentação definida por ela.

O que a API faz​

  • Consultar os marcadores liberados, com indicadores e fichas.
  • Criar marcadores, alterar nome, descrição e cor, e enviar para a Lixeira.
  • Incluir e remover fichas pelo identificador da ficha, CPF ou CNPJ, telefone ou e-mail.

A inclusão e a remoção por CPF, CNPJ, telefone ou e-mail devolvem o resultado de cada item enviado, como incluído, removido ou não encontrado.

Acesso por integrador​

O integrador só vê os marcadores liberados. A liberação é feita no passo Marcadores da emissão da API, no Painel de Controle, em APIs Públicas:

Passo Marcadores na emissão de uma nova API pública, com a opção Acesso a todos os marcadores e a lista de marcadores com dois deles selecionados

  • Acesso a todos os marcadores libera acesso a marcadores atuais e criados posteriormente.
  • Sem seleção, o integrador vê apenas os marcadores que criar.

Depois da emissão, a opção Acesso, no menu Opções, altera os produtos e os marcadores liberados. As fichas de cada marcador continuam limitadas aos produtos liberados.

Leitura e alteração de marcadores são permissões separadas. A inclusão e a remoção por CPF ou CNPJ exigem também a permissão de identidade do devedor. Por telefone ou e-mail, exigem as permissões de identidade e de contatos.

Registro das operações​

As inclusões e remoções feitas pela API aparecem no Histórico do marcador, com o autor Sistema e a identificação do integrador na origem. A última operação do marcador pode ser revertida em Desfazer.

Histórico do marcador com a operação mais recente feita pela API pública, autor Sistema, origem com a identificação do integrador, opção Desfazer e a lista das fichas incluídas

A auditoria da API, em Ver auditoria no menu Opções, registra os marcadores criados pelo integrador e as mudanças de acesso.

Documentação​

O guia para desenvolvedores traz a referência dos marcadores, as permissões de cada operação e a receita marcar fichas por CPF ou CNPJ.

Como ativar​

Para incluir as permissões de marcadores em uma API já emitida, ou para ativar as APIs públicas na operação, fale com o suporte.