Parceiros BankPlus v3

A API Parceiros v3 é uma funcionalidade essencial do ecossistema BankPlus que permite a localização estratégica de Parceiros de Negócios (PN) através de seus dados de contato, além de possibilitar a consulta de Notas Fiscais de Saída vinculadas. Esta ferramenta é fundamental para a integração com CRMs e portais de autoatendimento.

1. Configuração e Acesso (InventApps)

Seguindo a evolução da V3, o processo de autenticação foi simplificado e reforçado:

• Autenticação Bearer: Utilize o ID do Serviço e a Chave Secreta no InventApps para gerar o token de acesso (Bearer Token).

• Gestão de Token: O token tem validade de 8 horas. Em caso de reinicialização do serviço, gere um novo token para garantir a continuidade das requisições no Postman ou Swagger.

• URL Dinâmica: A validação é realizada pela porta configurada no serviço. Não é necessário informar o apelido da base de dados na URL, pois o token já carrega o contexto do serviço.

2. Métodos de Busca de Parceiros (GET)

Estes métodos permitem localizar o cadastro principal do cliente no SAP Business One através de diferentes chaves:

• Buscar Parceiro pelo Código: Localiza os dados mestres do PN utilizando o seu identificador único no ERP.

  • GET /api/v3/Parceiros/{parceiroCodigo}

• Buscar Parceiro por E-mail: Identifica o cadastro do PN através do e-mail vinculado ao cadastro principal.

  • GET /api/v3/Parceiros/busca-email/{email}

3. Métodos de Gestão de Contatos (GET)

Permite navegar pela lista de pessoas de contato vinculadas a uma empresa:

• Listar Todos os Contatos do Parceiro: Retorna a relação completa de contatos associados a um PN.

  • GET /api/v3/Parceiros/contatos

• Buscar Contato pelo ID: Localiza um contato específico através do seu ID único no sistema.

  • GET /api/v3/Parceiros/contatos/{id}

• Buscar Contato por Telefone ou E-mail: Localiza a pessoa de contato específica utilizando seus dados de comunicação.

  • GET /api/v3/Parceiros/contatos/busca?telefone={numero}

4. Consulta de Notas Fiscais (GET)

Integração direta com o histórico de faturamento do parceiro:

• Buscar Notas Fiscais de Saída do Parceiro: Lista todos os documentos de saída emitidos para o código do parceiro informado.

  • GET /api/v3/Parceiros/{parceiroCodigo}/notas

• Buscar Nota por Número Interno (DocEntry): Busca um documento específico utilizando o código do parceiro e o número interno do SAP.

  • GET /api/v3/Parceiros/{parceiroCodigo}/notas/{docNum}