Introdução

Essa é a documentação para ajudar você integrar a sua aplicação, Windows ou Linux com o Pay Kit da Linx.

Para que isso seja possível, nós disponibilizamos um SDK (Software Development Kit), multiplataforma, que possibilita pagamentos convencionais de crédito, débito, voucher, frota, PBM'S através da sua aplicação, e ainda realizar pagamentos com PIX, QR e Split de Pagamentos.

O desenvolvimento da solução constitui um conjunto de serviços e componentes para uma solução completa de pagamento.

O Pay Kit é construído em C++ é nativo Windows, mas para atender parceiros que utilizam Linux, temos uma solução multiplataforma.

Para entender a nossa documentação, aqui estão a definição dos parâmetros de funções e campos de registros

Windows & Linux

Uma das formas de integração da automação comercial com o TEF da Linx é por meio de biblioteca de funções (DPOSDRV.DLL para Windows ou libDPOSDRV.so para Linux). Esta biblioteca oferece funções que a automação utiliza, enviando parâmetros da automação e retornando os resultados na própria chamada dessas funções. As funções disponíveis na versão Linux são equivalentes às da versão Windows e a orientação é que em ambos os sistemas operacionais a automação carregue nossa biblioteca utilizando o path do sistema operacional (exceto no modelo embarcado). Na seção “EXEMPLOS DE INTEGRAÇÃO” são apresentadas formas de integração em diversas linguagens de programação.

As funções da biblioteca são exportadas conforme diretiva de callback, o que a torna possível de ser utilizada por sistemas desenvolvidos em qualquer linguagem ou ambiente de programação, como Delphi, Visual Basic e Visual C++, entre outros.

Recomendação: a DPOSDRV preferencialmente deve ser carregada no startup da AC e somente descarregada ao finalizar a Automação Comercial a fim de melhorar a performance do sistema.

Embarcado (Windows e Linux)

No modelo de utilização do Paykit embarcado, o processo de instalação bem como atualização de versão do Paykit é de responsabilidade da automação que está levando consigo o client, logo os métodos de Configura CNPJ Estabelecimento, Configura Empresa Loja e PDV, Configura Comunicação TEF e Busca do Certificado são de implementação obrigatória da automação, pois, é através desses métodos que a configuração da instalação do client será feita.

Nesse tipo de instalação, a automação terá a disposição 2 pacotes compactados, sendo eles: (1) ClientLinxTEF_<VERSÃO>_<ARCH>.zip e (2) Qt_Files_ClientLinxTEF_<VERSÃO>_<ARCH>.zip, que são respectivamente o Paykit em si e a interface gráfica à qual fica critério da automação utilizar ou não nossas interfaces de comunicação com o usuário. Além do pacote, também será disponibilizado um arquivo de configuração (dposlocal.ini) com algumas informações que deverão ser alteradas conforme orientação abaixo.

Processo de Instalação Paykit Embarcado

Paykit

Para instalar o pacote ClientLinxTEF_<VERSÃO>_<ARCH>.zip o mesmo deve ser descompactado em qualquer pasta do sistema operacional do PDV e sua estrutura de pastas deve ser preservada. O arquivo dposlocal.ini caso disponibilizado de forma separada, deve ser inserido dentro da pasta bin do local descompactado. Alguns conteúdos das chaves do arquivo ini estarão com o conteúdo {app} e nesse caso essa informação deve ser substituída para o path à qual foi descompactado o arquivo .zip.

Exemplo:

Uma vez descompactado o ClientLinxTEF_<VERSÃO>_<ARCH>.zip no path C:\Users\Linx\Downloads\Paykit.
A chave DIRETORIOBASE={app}\bin será alterada.
Novo valor: DIRETORIOBASE=C:\Users\Linx\Downloads\Paykit\bin

A utilização do dposlocal.ini caracteriza uma instalação embarcada, logo não deve haver nenhum outro arquivo de configuração no PDV para não gerar conflitos.

ATENÇÃO!!

O arquivo dposlocal.ini se localiza na pasta bin, logo, numa eventual atualização das bibliotecas do Paykit, somente os arquivos disponibilizados (arquivo.dll, arquivo.so, etc) devem ser substituídos para que a configuração não se perca em um procedimento de atualização.

Interface Gráfica

O pacote de interface gráfica é opcional e somente necessita ser utilizado nos casos onde a automação opta por utilizar as próprias telas do Paykit para interfaceamento com o usuário. Para a utilização do pacote Qt_Files_ClientLinxTEF_<VERSÃO>_<ARCH>.zip basta descompacta-lo em qualquer lugar do PDV (preferencialmente na pasta bin cítada no tópico anterior), configurar a variável de PATH do sistema para a pasta bin do Paykit e alterar no dposlocal.ini a seção/chave [CONFIG] QTDIRETORIOBASE= para o respectivo diretório onde foi descompactado o pacote.

Exemplo:

[CONFIG]
QTDIRETORIOBASE=C:\Users\Linx\Downloads\Paykit\bin\QTApplication

Coleta de logs

A coleta de logs no caso do client embarcado tem que ser feito de forma manual e pode ser feito pela própria automação ou suporte Linx. Os arquivos de logs que são gerados pelo Paykit são salvos no path configurado na seção/chave [CONFIG]INTERNO configurada no dposlocal.ini. Caso os path não tenham sido customizados pela automação os arquivos por padrão serão encontrados em: <PATH_DESCOMPACTAÇÃO_PAYKIT>/Interno, e são caracterizados pelos artefatos com a extensão .dbg, .LOG e .err.

Convenções utilizadas neste Manual

A descrição dos parâmetros de funções e campos de registros apresentados neste manual segue a convenção da tabela a seguir.

#	Descrição	Observação
`A`	campo alfanumérico	completado com espaços à direita e preenchidocom espaços, quando não informado
`H`	campo hexadecimal	campo binário
`N`	campo numérico	completado com zeros à esquerda e preenchidocom zeros, quando não informado
`I`	valor inteiro	retorno ou parâmetro de função de valor inteiro (integer )
`P`	ponteiro para caracter	ponteiro para um array de caracteres (PChar) como parâmetro de função