Integração via middleware Zoop PC

O Zoop PC é uma aplicação Windows desenvolvida em C#, .Net (CLR VERSÃO) que pode ser utilizada de forma independente, stand alone, instalada no computador com sistema operacional Windows do Estabelecimento Comercial (seller).

Abaixo você encontrará o link para download do Kit de Desenvolvedor contendo DLL de integração, aplicativo conector (ZoopCheckoutLite.exe) para integração mediada por WebSockets ou Windows Messaging e samples de uso de ambos os tipos de integração.

Requisitos

  • O Zoop PC é compatível com Windows (7 ou superior)
  • Um terminal homologado com chave Zoop

Configurando

Parâmetros

Você pode alterar o formato de integração passando os parâmetros abaixo no CLI

integration=websocket # As opções são: websocket, stdstream, wm 1337 

Exemplo: ZoopCheckoutLitePC.exe integration=websocket 8000 // onde 8000 é o numero da porta tcp.

zconfig.ini

Você pode ajustar configurações da execução do Zoop PC através do arquivo zconfig.ini (que deve ser guardado no mesmo diretório do executável). Atualmente você tem 2 opções disponíveis:

intervalHours=12 # Intervalo para verificação de atualizações do Zoop PC 
port=COM4 #  Porta serial onde o PIN Pad a ser utilizado está conectado (opcional)

Drivers

Alguns PIN Pads necessitam instalação de drivers para funcionar, para garantir o funcionamento correto, verifique a necessidade de instalação do driver.

MPOS

  • Pax (D150, D180) - Qualquer versão do windows precisa de instalação de drivers
  • Gertec (MP5) - Não precisa de drivers no Windows 10

PIN pad

  • Ingenico (IPP320) - Não precisa de Driver no Windows 10
  • Gertec (PPC 920, PPC 930) - Não precisa de Driver no Windows 10

Instalador

Caso você utilize o arquivo com o instalador. Saiba que ele realiza as seguintes operações:

  • Configuração da auto inicialização
  • Disponibiliza o executável na pasta Special Folder para evitar problemas de permissionamento
  • Habilita a configuração padrão (atualmente habilitando integração por WebSockets)

Caso seja necessário, você pode solicitar ao time Zoop a geração de um instalador com outra configuração padrão.

Resolução de erros (com a instalação de driver)

Caso esteja enfrentando problemas para identificar o PIN Pad, pode ser necessário definir a porta serial manualmente utilizando o arquivo de configuração (zconfig.ini)
port=COMXX (substituir XX pela porta onde o PIN Pad está conectado)

Você pode identificar a porta no gerenciador de dispositivos no subitem ports

Integrando

Para se integrar a aplicação basta optar por um formato escolhido de Integração e seguir o fluxo de mensagens abordados nos tópicos seguintes.

Diagrama do fluxo de mensagens para realização de uma cobrança

Diagrama do fluxo de mensagens para realização de uma cobrança

Após instalar o Zoop PC , ele inicia automaticamente e detecta PIN Pads homologados conectados. Com os PIN Pads de cabo, a detecção é automática, dependendo do modelo e necessidade de drivers instalados.

Formas de Integração

A integração se dá de três formas:

  1. Utilizando o WebSocket server
  2. Utilizando sistema de mensageria do windows WM_COPYDATA
  3. Process IO (ou Windows Standard Streams)

Via WebSocket

Na sua aplicação você precisa abrir uma conexão em localhost na porta 1337. Exemplo: ws://localhost:1337. Caso queira alterar a porta padrão, você pode passar como parâmetro na inicialização do servidor. Para isso inicialize dessa forma:
`ZoopCheckoutLitePC.exe integration=websocket nnnn (onde nnnn é o numero da porta desejada) ou pela interface gráfica.

Para mais detalhes da implementação, verifique a implementação exemplo de WebSockets.

Via WM_COPYDATA

O modelo de integração utiliza mensagens do Windows WM_COPYDATA, disponíveis em todas as tecnologias Windows em aplicações com janelas. Nesse sistema você consegue fazer o envio de mensagens entre janelas do Windows.

Saiba mais na documentação da Microsoft: WM_COPYDATA

Além disso o processo do Zoop PC precisa ser inicializado passando o parâmetro do WM_COPYDATA. Para isso inicialize dessa forma:
ZoopCheckoutLitePC.exe integration=wm <nome da janela>

Ou você pode inicializar a aplicação pela interface gráfica e localizar ela através do findWindow no user32.dll

Via Process IO (Standard Streams)

Para aplicações sem janelas, oferecemos os modelos de integração via Process IO (Windows Standard Streams).

Para implementações em C# utilize:

Além disso o processo do Zoop PC precisa ser inicializado passando o parâmetro do Standard Streams. Para isso inicialize dessa forma:
ZoopCheckoutLitePC.exe integration=stdstream

Updated about a month ago


Integração via middleware Zoop PC


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.