Plataforma de Comunicação Elgin versão 3.13.9
Documentação das bibliotecas de integração com hardware Elgin
Funções Retorno por Arquivo

Funções

int GetServerArq (const char *path)
 
int SetServerArq (const char *ipTerminal, int portaTransacao, int portaStatus, const char *path)
 
int SetSenhaArq (const char *senha, bool habilitada, const char *path)
 Configura as senhas que a dll vai enviar para o terminal para as transações. Mais...
 
int GetTimeoutArq (const char *path)
 
int SetTimeoutArq (int timeout, const char *path)
 
int ConsultarStatusArq (const char *path)
 
int ConsultarUltimaTransacaoArq (const char *pdv, const char *path)
 
int ImprimirCupomSatArq (const char *xml, const char *path)
 
int ImprimirCupomSatCancelamentoArq (const char *xml, const char *assQRCode, const char *path)
 
int ImprimirCupomNfceArq (const char *xml, int indexcsc, const char *csc, const char *path)
 
int SetSenhaServerArq (const char *senha, bool habilitada, const char *path)
 configura a senha do terminal remotamente. Mais...
 
int IniciaVendaArq (int idTransacao, const char *pdv, const char *valorTotal, const char *path)
 
int IniciaVendaDebitoArq (int idTransacao, const char *pdv, const char *valorTotal, const char *path)
 
int IniciaVendaCreditoArq (int idTransacao, const char *pdv, const char *valorTotal, int tipoFinanciamento, int numParcelas, const char *path)
 
int IniciaCancelamentoVendaArq (int idTransacao, const char *pdv, const char *valorTotal, const char *dataHora, const char *nsu, const char *path)
 
int IniciaOperacaoAdministrativaArq (int idTransacao, const char *pdv, int operacao, const char *path)
 

Descrição detalhada

Funções

◆ GetServerArq()

int GetServerArq ( const char *  path)

Obtem configuração do servidor.

Observação
Essa função é uma reescrita da função GetServer alterando apenas o modo como os dados são retornados.
Parâmetros
path- Caminho para o arquivo onde serão gravados os dados de resposta
Retorna
Retorno tipo int. Operação realizada com sucesso deve retornar ZERO(0)
e os dados no formato json estaram disponiveis no arquivo informado por path.
  • Consulte Códigos de erro para mais informações.

◆ SetServerArq()

int SetServerArq ( const char *  ipTerminal,
int  portaTransacao,
int  portaStatus,
const char *  path 
)

Configura servidor onde serão processadas as transações.

Observação
Essa função é uma reescrita da função SetServer alterando apenas o modo como os dados são retornados.
Parâmetros
ipTerminal- IP do terminal SmartPOS onde o APP E1_Bridge esta em execução. Exemplo: 192.168.0.10
portaTransacao- Identificação da porta de comunicação. A porta padrão é 3000
O valor deve ser entre 0 e 65535, onde 0 será para definir com o valor padrão de 3000.
portaStatus- Identificação da porta onde serão obtido o status das transações. A porta padrão é 3001
O valor deve ser entre 0 e 65535, onde 0 será para definir com o valor padrão de 3001.
path- Caminho para o arquivo onde serão gravados os dados de resposta
Retorna
Retorno tipo int. Operação realizada com sucesso deve retornar ZERO(0).
e os dados no formato json estaram disponiveis no arquivo informado por path.
  • Consulte Códigos de erro para mais informações.

◆ SetSenhaArq()

int SetSenhaArq ( const char *  senha,
bool  habilitada,
const char *  path 
)

Configura as senhas que a dll vai enviar para o terminal para as transações.

Parâmetros
senha- senha configurada pelo usuário
habilitada- boolean para saber se a senha vai estar habilitada ou não.
Ou seja se a senha será enviada para comunicar ou não.
path- Caminho para o arquivo onde serão gravados os dados de resposta
Retorna
código numérico referente ao processamento da função.
A função executada com sucesso deve retornar 0.
Para mais detalhes sobre o retorno consulte a sessão códigos de erro.

◆ GetTimeoutArq()

int GetTimeoutArq ( const char *  path)

Obtem o timeout definido para as transações em segundos;
O valor padrão é de 180 segundos (3 minutos);

Observação
Essa função é uma reescrita da função GetTimeout alterando apenas o modo como os dados são retornados.
Parâmetros
path- Caminho para o arquivo onde serão gravados os dados de resposta
Retorna
Retorno tipo int. Operação realizada com sucesso deve retornar ZERO(0).
e os dados no formato json estaram disponiveis no arquivo informado por path.
  • Consulte Códigos de erro para mais informações.

◆ SetTimeoutArq()

int SetTimeoutArq ( int  timeout,
const char *  path 
)

Configura um timeout para as funções de transação.
O valor padrão é de 180 segundos (3 minutos);

Observação
Essa função é uma reescrita da função SetTimeout alterando apenas o modo como os dados são retornados.
Parâmetros
timeout- Valor em segundos a ser definido.
path- Caminho para o arquivo onde serão gravados os dados de resposta
Retorna
Retorno tipo int. Operação realizada com sucesso deve retornar ZERO(0).
e os dados no formato json estaram disponiveis no arquivo informado por path.
  • Consulte Códigos de erro para mais informações.

◆ ConsultarStatusArq()

int ConsultarStatusArq ( const char *  path)

Obtém o status do terminal SmartPOS.
Essa função disponibiliza o status de transação e de tela.

Parâmetros
path- Caminho do arquivo que receberá o JSON de retorno da função, conforme descrito em ConsultarStatus.
Retorna
Um inteiro positivo para indicar o status, ou um inteiro negativo em caso de erro.
Essa função trabalha com os bits conforme descrição abaixo:
BIT STATUS DESCRIÇÃO
0 LIGADO Indica terminal ocupado
DESLIGADO Indica terminal livre
1 LIGADO Indica tela bloqueada
DESLIGADO Indica tela desbloqueada
  • Consulte Códigos de erro para mais informações.

◆ ConsultarUltimaTransacaoArq()

int ConsultarUltimaTransacaoArq ( const char *  pdv,
const char *  path 
)

Retorna ultima transação processada pelo terminal.
Deve ser utilizada casos de timeout.

Observação
Essa função é uma reescrita da função ConsultarUltimaTransacao alterando apenas o modo como os dados são retornados.
Parâmetros
pdv- Identificação do PDV utilizada nas transações.
path- Caminho para o arquivo onde serão gravados os dados de resposta
Retorna
Retorno tipo int. Operação realizada com sucesso deve retornar ZERO(0).
e os dados no formato json estaram disponiveis no arquivo informado por path.
Consulte Códigos de erro para mais informações.

◆ ImprimirCupomSatArq()

int ImprimirCupomSatArq ( const char *  xml,
const char *  path 
)

Imprimir Cupom Sat de acordo com a especificação da Sefaz para bobina de 55mm.

Observação
Essa Função pode ser usada para impressão de Danfe do MFe (Ceará)
Parâmetros
xml- Dados do XML retornado da operação de venda do SAT.
path- Caminho para o arquivo onde serão gravados os dados de resposta.
Retorna
Retorno tipo int. Operação realizada com sucesso deve retornar ZERO(0).
e os dados no formato json estarão disponíveis no arquivo informado por path.
Consulte Códigos de erro para mais informações.

◆ ImprimirCupomSatCancelamentoArq()

int ImprimirCupomSatCancelamentoArq ( const char *  xml,
const char *  assQRCode,
const char *  path 
)

Imprimir Cupom de cancelamento SAT de acordo com a especificação da Sefaz para bobina de 55mm.

Observação
Essa Função pode ser usada para impressão de Danfe do MFe (Ceará)
Parâmetros
xml- Dados do XML retornado da operação de cancelamento do SAT.
assQRCode- Assinatura do QRcode retornado na venda cancelada.
path- Caminho para o arquivo onde serão gravados os dados de resposta.
Retorna
Retorno tipo int. Operação realizada com sucesso deve retornar ZERO(0).
e os dados no formato json estarão disponíveis no arquivo informado por path.
Consulte Códigos de erro para mais informações.

◆ ImprimirCupomNfceArq()

int ImprimirCupomNfceArq ( const char *  xml,
int  indexcsc,
const char *  csc,
const char *  path 
)

Imprimir Cupom NFCe de acordo com a especificação da Sefaz para bobina de 55mm.

Parâmetros
xml- Dados do XML retornado da operação de venda nfce.
indexcsc- Identificador do CSC (Código de Segurança do Contribuinte no Banco de Dados da SEFAZ).

‍Deve ser informado sem os “0” (zeros) não significativos. A identificação do CSC corresponde à ordem do
CSC no banco de dados da SEFAZ, não confundir com o próprio CSC.

csc- Código de Segurança do Contribuinte.

‍Corresponde a um código de segurança alfanumérico (16 a 36 bytes) de conhecimento apenas da Secretaria da Fazenda
da Fazenda da Unidade Federada do emitente e do próprio contribuinte. Anteriormente, o código de segurança
CSC era chamado de “Token”.

pathInforma o caminho do arquivo onde o json de retorno da função será salvo
Retorna
Retorno tipo int. Operação realizada com sucesso deve retornar ZERO(0).
e os dados no formato json estarão disponíveis no arquivo informado por path.
Consulte Códigos de erro para mais informações.

◆ SetSenhaServerArq()

int SetSenhaServerArq ( const char *  senha,
bool  habilitada,
const char *  path 
)

configura a senha do terminal remotamente.

Parâmetros
senha- senha configurada pelo usuário
habilitada- boolean que configura se a senha vai ser ativada no servidor
ou não. Se for true vai ser verificado as senhas que recebem as transações
e se for false significa que vai ter uma senha que não vai estar em uso, portanto
qualquer transação que chegar no terminal vai ser aceito direto
path- Caminho para o arquivo onde serão gravados os dados de resposta
Retorna
código numérico referente ao processamento da função.
A função executada com sucesso deve retornar 0.
Para mais detalhes sobre o retorno consulte a sessão códigos de erro.

◆ IniciaVendaArq()

int IniciaVendaArq ( int  idTransacao,
const char *  pdv,
const char *  valorTotal,
const char *  path 
)

Inicia um operação de venda.
O tipo da operação será definido pelo operador como débito ou crédito.

Observação
Essa função é uma reescrita da função IniciaVenda alterando apenas o modo como os dados são retornados.
Parâmetros
idTransacao- Código númerico gerenciado pelo PDV para identificar uma transação.
Valor entre 0 e 999999.
pdv- Código identificador do PDV.
Valor alfanumérico.
valorTotal- Valor total da venda em centavos, ex: 100 para venda de R$1,00
path- Caminho para o arquivo onde serão gravados os dados de resposta
Retorna
Retorno tipo int. Operação realizada com sucesso deve retornar ZERO(0).
e os dados no formato json estaram disponiveis no arquivo informado por path.
  • Consulte Códigos de erro para mais informações.

◆ IniciaVendaDebitoArq()

int IniciaVendaDebitoArq ( int  idTransacao,
const char *  pdv,
const char *  valorTotal,
const char *  path 
)

Inicia uma venda no débito.

Observação
Essa função é uma reescrita da função IniciaVendaDebito alterando apenas o modo como os dados são retornados.
Parâmetros
idTransacao- Código númerico gerenciado pelo PDV para identificar uma transação.
Valor entre 0 e 999999.
pdv- Código identificador do PDV.
Valor alfanumérico.
valorTotal- Valor total da venda em centavos, ex: 100 para venda de R$1,00
path- Caminho para o arquivo onde serão gravados os dados de resposta
Retorna
Retorno tipo int. Operação realizada com sucesso deve retornar ZERO(0).
e os dados no formato json estaram disponiveis no arquivo informado por path.
  • Consulte Códigos de erro para mais informações.

◆ IniciaVendaCreditoArq()

int IniciaVendaCreditoArq ( int  idTransacao,
const char *  pdv,
const char *  valorTotal,
int  tipoFinanciamento,
int  numParcelas,
const char *  path 
)

Inicia Venda no Crédito.

Observação
Essa função é uma reescrita da função IniciaVendaCredito alterando apenas o modo como os dados são retornados.
Parâmetros
idTransacao-Código númerico gerenciado pelo PDV para identificar uma transação.
Valor entre 0 e 999999.
pdv- Código identificador do PDV.
Valor alfanumérico.
valorTotal- Valor total da venda em centavos, ex: 100 para venda de R$1,00
tipoFinanciamento- Tipo do financiamento (A vista = 1, parcelado emissor = 2 ou parcelado estabelecimento = 3)
numParcelas- Quantidade de parcelas para as transações parcelada. Para transação a vista o valor sera desconsiderado.
path- Caminho para o arquivo onde serão gravados os dados de resposta
Retorna
Retorno tipo int. Operação realizada com sucesso deve retornar ZERO(0).
e os dados no formato json estaram disponiveis no arquivo informado por path.
  • Consulte Códigos de erro para mais informações.

◆ IniciaCancelamentoVendaArq()

int IniciaCancelamentoVendaArq ( int  idTransacao,
const char *  pdv,
const char *  valorTotal,
const char *  dataHora,
const char *  nsu,
const char *  path 
)

Inicia um cancelamento de venda.

Observação
Essa função é uma reescrita da função IniciaCancelamentoVenda alterando apenas o modo como os dados são retornados.
Parâmetros
idTransacao- Código númerico gerenciado pelo PDV para identificar uma transação.
Valor entre 0 e 999999.
pdv- Código identificador do PDV.
Valor alfanumérico.
valorTotal- Valor total da venda em centavos, ex: 100 para venda de R$1,00
dataHora- Data e hora da transação no formato dd/MM/yyyy HH:mm:ss ou dd/MM/yyyy.
Este valor é retornado no JSON das vendas na chave dataHoraTransacao.
nsu- nsu da transação que é retornado no JSON das vendas na chave nsuLocal.
path- Caminho para o arquivo onde serão gravados os dados de resposta
Retorna
Retorno tipo int. Operação realizada com sucesso deve retornar ZERO(0).
e os dados no formato json estaram disponiveis no arquivo informado por path.
  • Consulte Códigos de erro para mais informações.

◆ IniciaOperacaoAdministrativaArq()

int IniciaOperacaoAdministrativaArq ( int  idTransacao,
const char *  pdv,
int  operacao,
const char *  path 
)

Inicia uma operação administrativa.

Observação
Essa função é uma reescrita da função IniciaOperacaoAdministrativa alterando apenas o modo como os dados são retornados.
Parâmetros
idTransacao- Código númerico gerenciado pelo PDV para identificar uma transação.
Valor entre 0 e 999999.
pdv- Código identificador do PDV.
Valor alfanumérico.
operacao- Informa a operação a ser realizada. Operações disponiveis são:

‍Operação administrativa = 0
Operação de instalação = 1
Operação de configuração = 2
Operação de manutenção = 3
Teste de comunicação = 4
Operação de reimpressão de comprovante = 5

path- Caminho para o arquivo onde serão gravados os dados de resposta
Retorna
Retorno tipo int. Operação realizada com sucesso deve retornar ZERO(0).
e os dados no formato json estaram disponiveis no arquivo informado por path.
  • Consulte Códigos de erro para mais informações.