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

Funções

const char * GetServer ()
 
const char * SetServer (const char *ipTerminal, int portaTransacao, int portaStatus)
 
const char * SetSenha (const char *senha, bool habilitada)
 Configura as senhas que a dll vai enviar para o terminal para as transações. Mais...
 
const char * GetTimeout ()
 
const char * SetTimeout (int timeout)
 
const char * ConsultarStatus ()
 
const char * ConsultarUltimaTransacao (const char *pdv)
 
const char * ImprimirCupomSat (const char *xml)
 
const char * ImprimirCupomSatCancelamento (const char *xml, const char *assQRCode)
 
const char * ImprimirCupomNfce (const char *xml, int indexcsc, const char *csc)
 
const char * SetSenhaServer (const char *senha, bool habilitada)
 configura a senha do terminal remotamente. Mais...
 
const char * IniciaVenda (int idTransacao, const char *pdv, const char *valorTotal)
 
const char * IniciaVendaDebito (int idTransacao, const char *pdv, const char *valorTotal)
 
const char * IniciaVendaCredito (int idTransacao, const char *pdv, const char *valorTotal, int tipoFinanciamento, int numParcelas)
 
const char * IniciaCancelamentoVenda (int idTransacao, const char *pdv, const char *valorTotal, const char *dataHora, const char *nsu)
 
const char * IniciaOperacaoAdministrativa (int idTransacao, const char *pdv, int operacao)
 

Descrição detalhada

Funções

◆ GetServer()

const char * GetServer ( )

Função utilizada para obter configuração do servidor

Retorna
string no formato json Exemplo:
{"e1_bridge_code":0,"e1_bridge_msg":"192.168.0.1|3000|3001"}

◆ SetServer()

const char * SetServer ( const char *  ipTerminal,
int  portaTransacao,
int  portaStatus 
)

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

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.
Retorna
string no formato json Exemplo:
{"e1_bridge_code":0,"e1_bridge_msg":"Sucesso"}

◆ SetSenha()

const char * SetSenha ( const char *  senha,
bool  habilitada 
)

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.
Retorna
string no formato json Exemplo:
{"e1_bridge_code":0,"e1_bridge_msg":"Sucesso"}

◆ GetTimeout()

const char * GetTimeout ( )

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

Retorna
string no formato json Exemplo:
{"e1_bridge_code":0,"e1_bridge_msg":"180000"}

◆ SetTimeout()

const char * SetTimeout ( int  timeout)

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

Parâmetros
timeout- Valor em segundos a ser definido.
Retorna
string no formato json Exemplo:
{"e1_bridge_code":0,"e1_bridge_msg":"Sucesso"}

◆ ConsultarStatus()

const char * ConsultarStatus ( )

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

Retorna
String no formato JSON. Exemplo:
{"e1_bridge_code":2,"e1_bridge_msg":"Terminal livre|Tela bloqueada"}

Essa função trabalha com os bits de um inteiro positivo para indicar o status.
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.

◆ ConsultarUltimaTransacao()

const char * ConsultarUltimaTransacao ( const char *  pdv)

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

Parâmetros
pdv- Identificação do PDV utilizada nas transações.
Retorna
string no formato json.
Consulte a sessão retorno para ter um exemplo de um json de saída e todos os dados.

◆ ImprimirCupomSat()

const char * ImprimirCupomSat ( const char *  xml)

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.
Retorna
string no formato json Exemplo:
{"e1_bridge_code":0,"e1_bridge_msg":"Sucesso"}

◆ ImprimirCupomSatCancelamento()

const char * ImprimirCupomSatCancelamento ( const char *  xml,
const char *  assQRCode 
)

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.
Retorna
string no formato json Exemplo:
{"e1_bridge_code":0,"e1_bridge_msg":"Sucesso"}

◆ ImprimirCupomNfce()

const char * ImprimirCupomNfce ( const char *  xml,
int  indexcsc,
const char *  csc 
)

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 Unidade Federada do emitente e do próprio contribuinte. Anteriormente, o código de segurança
CSC era chamado de “Token”.

Retorna
string no formato json Exemplo:
{"e1_bridge_code":0,"e1_bridge_msg":"Sucesso"}

◆ SetSenhaServer()

const char * SetSenhaServer ( const char *  senha,
bool  habilitada 
)

configura a senha do terminal remotamente.

Parâmetros
senha- senha configurada pelo usuário
habilitada- booleano 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
Retorna
string no formato json Exemplo:
{"e1_bridge_code":0,"e1_bridge_msg":"Sucesso"}

◆ IniciaVenda()

const char * IniciaVenda ( int  idTransacao,
const char *  pdv,
const char *  valorTotal 
)

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

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
Retorna
String no formato Json com os dados da transação; Consulte a sessão retorno para ter um exemplo de um json de saída e todos os dados.

◆ IniciaVendaDebito()

const char * IniciaVendaDebito ( int  idTransacao,
const char *  pdv,
const char *  valorTotal 
)

Inicia uma venda no débito.

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
Retorna
String no formato Json com os dados da transação; Consulte a sessão retorno para ter um exemplo de um json de saída e todos os dados.

◆ IniciaVendaCredito()

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

Inicia Venda no Crédito.

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.
Retorna
String no formato Json com os dados da transação; Consulte a sessão retorno para ter um exemplo de um json de saída e todos os dados.

◆ IniciaCancelamentoVenda()

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

Inicia um cancelamento de venda.

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.
Retorna
String no formato Json com os dados da transação; Consulte a sessão retorno para ter um exemplo de um json de saída e todos os dados.

◆ IniciaOperacaoAdministrativa()

const char * IniciaOperacaoAdministrativa ( int  idTransacao,
const char *  pdv,
int  operacao 
)

Inicia uma operação administrativa.

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

Retorna
String no formato Json com os dados da transação; Consulte a sessão retorno para ter um exemplo de um json de saída e todos os dados.