Esta documentação foi criada para ajudar os parceiros a integrar a sua aplicação ao TEF Stone
Kit TEF Stone (Embarcado) - Mais recomendada
Ao utilizar o Kit do TEF Stone embarcado, o processo de instalação bem como atualização de versão é de responsabilidade do parceiro que está integrando, devendo o mesmo realizar as configurações relacionadas a CNPJ do estabelecimento, PDV vinculado, comunicação do TEF e Certificado vinculado de modo que a instalação do Client seja realizada corretamente.
Nesse tipo de instalação, o parceiro terá à disposição 2 pacotes compactos:
ClientLinxTEF_<VERSÃO>_<ARCH>.zip
:Qt_Files_ClientLinxTEF_<VERSÃO>_<ARCH>.zip
O primeiro refere-se ao kit do TEF Stone para desenvolvimento e o segundo é a interface gráfica, a qual fica a critério do parceiro implementar ou não, de acordo com a customização que desejar fazer perante os seus usuários.
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.
Modo de instalação
Para instalar o pacote ClientLinxTEF_<VERSÃO>_<ARCH>.zip
o mesmo deve ser descompactado em qualquer pasta do sistema operacional do Software 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 pathC:\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.
Observação: O arquivo dposlocal.ini
se localiza na pasta bin
, logo, numa eventual atualização das bibliotecas, 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 TEF Stone 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 da automação (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 são salvos no path e configurados na seção/chave [CONFIG]INTERNO
configurada no dposlocal.ini
. Caso o path não tenha sido customizado 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.
Kit TEF Stone (Instalador)
Ao utilizar o Kit TEF Stone via instalador, quem fará a gestão dos pacotes em produção seremos nós, logo, a implantação, setup da aplicação em produção e atualização da mesma está sob nossa responsabilidade.
Nesse modelo, diferente do modelo embarcado há dois tipos de implantação, uma para ambientes produtivos e outro para ambiente de desenvolvimento, o qual será descrito aqui.
Nesse cenário de desenvolvimento, será disponibilizado dois pacotes, sendo eles:
DTEF8RuntimeSetup<versao>.exe
ClientLinxTEFSetup_<versao>-<timestamp>_<arquitetura>.exe