Ir para o conteúdo

Bnex (WSDL/SOAP) — Legado / Depreciada

Conjunto de APIs legadas do CRM Bnex/Zoombox para integração com o PDV (Frente de Caixa), expostas como um WebService SOAP (GerenciaVendaWS).

Integração depreciada — exclusiva para consulta

Estas APIs estão depreciadas e são mantidas apenas para consulta de integrações já existentes. Não implemente novas integrações sobre o Bnex.

Para novas integrações de PDV, use a Rock Conecta (API REST) — a integração oficial e recomendada.

Endpoint (WSDL)

Todos os métodos abaixo são expostos pelo mesmo serviço GerenciaVendaWS:

http://servidor:porta/IntegradorGSWS/GerenciaVendaWS?wsdl
Item Valor
Protocolo SOAP 1.1 / SOAP 1.2
WSDL GerenciaVendaWS?wsdl
Content-Type text/xml (SOAP 1.1) ou application/soap+xml (SOAP 1.2)
Namespace http://ws.integrador.gs.com.br/

Substitua servidor:porta pelos valores do ambiente fornecido pela Rock Conecta.

Métodos disponíveis

  • setIdentificaCliente

    Identifica o cliente pelo CPF/CNPJ, retornando saldo de fidelidade, prêmios e vouchers disponíveis. Chamado antes da notificação da venda.

    Ver setIdentificaCliente

  • setNotificaVenda

    Notifica (envia) a venda realizada no PDV para o CRM, incluindo itens, pagamentos e vouchers utilizados.

    Ver setNotificaVenda

  • setCancelaVenda

    Cancela uma venda previamente notificada, quando o cancelamento ocorre na sequência da notificação.

    Ver setCancelaVenda

Autenticação e segurança

As chamadas utilizam dois mecanismos combinados:

Campo Descrição
token Valor fornecido à empresa integradora pela Rock Conecta. Obrigatório em todos os métodos.
Hash Chave MD5 gerada a partir do texto CPF - Data Atual. Obrigatório em todos os métodos.

Cálculo do Hash

O Hash é o MD5 do texto no formato CPF - Data Atual (com espaços ao redor do hífen). A data deve ser a data do envio da requisição.

Texto:  12345678909 - 30/10/2014
MD5:    9d9357fa875c8c9298e2d99fd5d246d1

CPF no Hash

Para clientes não identificados, use 00000000000 como CPF, tanto no Hash quanto nos campos de CPF/CNPJ das mensagens.

Fluxo de integração

sequenceDiagram
    autonumber
    participant PDV
    participant WS as GerenciaVendaWS (Bnex)

    PDV->>WS: setIdentificaCliente (CPF + Hash + token)
    WS-->>PDV: WSRetorno (saldo, prêmios, vouchers)

    Note over PDV: Aplica benefícios / vouchers na venda

    PDV->>WS: setNotificaVenda (Venda + itens + pagamentos + vouchers)
    WS-->>PDV: WSRetorno (código de retorno)

    opt Venda cancelada na sequência
        PDV->>WS: setCancelaVenda (Venda + Hash + token)
        WS-->>PDV: WSRetorno (código de retorno)
    end

Regras gerais do XML

Tags sempre presentes

Mesmo que não exista valor para um campo, a tag correspondente deve existir no XML (ex.: <complemento></complemento>).

Formatação das tags

As tags devem ser envoltas pelos caracteres < e >, sem espaços em branco logo após o < nem antes do >.

Os valores apresentados nos exemplos são ilustrativos — utilize os valores reais no momento da chamada ao método.

Referências