![]() |
Plataforma de Comunicação Elgin versão 3.14.07
Documentação das bibliotecas de integração com hardware Elgin
|
Funções | |
| int | GetServerRef (char **retorno) |
| int | SetServerRef (const char *ipTerminal, int portaTransacao, int portaStatus, char **retorno) |
| int | SetSenhaRef (const char *senha, bool habilitada, char **retorno) |
| Configura as senhas que a dll vai enviar para o terminal para as transações. Mais... | |
| int | GetTimeoutRef (char **retorno) |
| int | SetTimeoutRef (int timeout, char **retorno) |
| int | ConsultarStatusRef (char **retorno) |
| int | ConsultarUltimaTransacaoRef (const char *pdv, char **retorno) |
| int | ImprimirCupomSatRef (const char *xml, char **retorno) |
| int | ImprimirCupomSatCancelamentoRef (const char *xml, const char *assQRCode, char **retorno) |
| int | ImprimirCupomNfceRef (const char *xml, int indexcsc, const char *csc, char **retorno) |
| int | SetSenhaServerRef (const char *senha, bool habilitada, char **retorno) |
| configura a senha do terminal remotamente. Mais... | |
| int | IniciaVendaRef (int idTransacao, const char *pdv, const char *valorTotal, char **retorno) |
| int | IniciaVendaDebitoRef (int idTransacao, const char *pdv, const char *valorTotal, char **retorno) |
| int | IniciaVendaCreditoRef (int idTransacao, const char *pdv, const char *valorTotal, int tipoFinanciamento, int numParcelas, char **retorno) |
| int | IniciaCancelamentoVendaRef (int idTransacao, const char *pdv, const char *valorTotal, const char *dataHora, const char *nsu, char **retorno) |
| int | IniciaOperacaoAdministrativaRef (int idTransacao, const char *pdv, int operacao, char **retorno) |
| int GetServerRef | ( | char ** | retorno | ) |
Função utilizada para obter configuração do servidor
| retorno | - parametro passado por referência que ira armazenar os dados de retorno ao fim da transação. Exemplo: {"e1_bridge_code":0,"e1_bridge_msg":"192.168.0.1|3000|3001"}
|
| int SetServerRef | ( | const char * | ipTerminal, |
| int | portaTransacao, | ||
| int | portaStatus, | ||
| char ** | retorno | ||
| ) |
Configura servidor onde serão processadas as transações.
| 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. |
| retorno | - parametro passado por referência que ira armazenar os dados de retorno ao fim da transação. Exemplo: {"e1_bridge_code":0,"e1_bridge_msg":"Sucesso"}
|
| int SetSenhaRef | ( | const char * | senha, |
| bool | habilitada, | ||
| char ** | retorno | ||
| ) |
Configura as senhas que a dll vai enviar para o terminal para as transações.
| 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. |
| retorno | - parametro passado por referência que ira armazenar os dados de retorno ao fim da transação. |
| int GetTimeoutRef | ( | char ** | retorno | ) |
Obtem o timeout definido para as transações em segundos;
O valor padrão é de 180 segundos (3 minutos);
| retorno | - parametro passado por referência que ira armazenar os dados de retorno ao fim da transação. Exemplo: {"e1_bridge_code":0,"e1_bridge_msg":"180000"}
|
| int SetTimeoutRef | ( | int | timeout, |
| char ** | retorno | ||
| ) |
Configura um timeout para as funções de transação.
O valor padrão é de 180 segundos (3 minutos);
| timeout | - Valor em segundos a ser definido. |
| retorno | - parametro passado por referência que ira armazenar os dados de retorno ao fim da transação. Exemplo: {"e1_bridge_code":0,"e1_bridge_msg":"Sucesso"}
|
| int ConsultarStatusRef | ( | char ** | retorno | ) |
Obtém o status do terminal SmartPOS.
Essa função disponibiliza o status de transação e de tela.
| retorno | - Alocação de memória que receberá o JSON de retorno da função, conforme descrito em ConsultarStatus. |
| BIT | STATUS | DESCRIÇÃO |
|---|---|---|
| 0 | LIGADO | Indica terminal ocupado |
| DESLIGADO | Indica terminal livre | |
| 1 | LIGADO | Indica tela bloqueada |
| DESLIGADO | Indica tela desbloqueada |
| int ConsultarUltimaTransacaoRef | ( | const char * | pdv, |
| char ** | retorno | ||
| ) |
Retorna ultima transação processada pelo terminal.
Deve ser utilizada casos de timeout.
| pdv | - Identificação do PDV utilizada nas transações. Consulte a sessão retorno para ter um exemplo de um json de saída e todos os dados. |
| retorno | - parametro passado por referência que ira armazenar os dados de retorno ao fim da transação. |
| int ImprimirCupomSatRef | ( | const char * | xml, |
| char ** | retorno | ||
| ) |
Imprimir Cupom Sat de acordo com a especificação da Sefaz para bobina de 55mm.
| xml | - Dados do XML retornado da operação de venda do SAT. |
| retorno | - parametro passado por referência que ira armazenar os dados de retorno ao fim da transação. |
| int ImprimirCupomSatCancelamentoRef | ( | const char * | xml, |
| const char * | assQRCode, | ||
| char ** | retorno | ||
| ) |
Imprimir Cupom de cancelamento SAT de acordo com a especificação da Sefaz para bobina de 55mm.
| xml | - Dados do XML retornado da operação de cancelamento do SAT. |
| assQRCode | - Assinatura do QRcode retornado na venda cancelada. |
| retorno | - parametro passado por referência que ira armazenar os dados de retorno ao fim da transação. |
| int ImprimirCupomNfceRef | ( | const char * | xml, |
| int | indexcsc, | ||
| const char * | csc, | ||
| char ** | retorno | ||
| ) |
Imprimir Cupom NFCe de acordo com a especificação da Sefaz para bobina de 55mm.
| 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).
|
| csc | - Código de Segurança do Contribuinte.
|
| retorno | - parametro passado por referência que ira armazenar os dados de retorno ao fim da transação. Exemplo: {"e1_bridge_code":0,"e1_bridge_msg":"Sucesso"}
|
| int SetSenhaServerRef | ( | const char * | senha, |
| bool | habilitada, | ||
| char ** | retorno | ||
| ) |
configura a senha do terminal remotamente.
| 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 |
| retorno | - parametro passado por referência que ira armazenar os dados de retorno ao fim da transação. |
| int IniciaVendaRef | ( | int | idTransacao, |
| const char * | pdv, | ||
| const char * | valorTotal, | ||
| char ** | retorno | ||
| ) |
Inicia um operação de venda.
O tipo da operação será definido pelo operador como débito ou crédito.
| 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 |
| retorno | - parametro passado por referência que ira armazenar os dados de retorno ao fim da transação. |
| int IniciaVendaDebitoRef | ( | int | idTransacao, |
| const char * | pdv, | ||
| const char * | valorTotal, | ||
| char ** | retorno | ||
| ) |
Inicia uma venda no débito.
| 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 |
| retorno | - parametro passado por referência que ira armazenar os dados de retorno ao fim da transação. |
| int IniciaVendaCreditoRef | ( | int | idTransacao, |
| const char * | pdv, | ||
| const char * | valorTotal, | ||
| int | tipoFinanciamento, | ||
| int | numParcelas, | ||
| char ** | retorno | ||
| ) |
Inicia Venda no Crédito.
| 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. |
| retorno | - parametro passado por referência que ira armazenar os dados de retorno ao fim da transação. |
| int IniciaCancelamentoVendaRef | ( | int | idTransacao, |
| const char * | pdv, | ||
| const char * | valorTotal, | ||
| const char * | dataHora, | ||
| const char * | nsu, | ||
| char ** | retorno | ||
| ) |
Inicia um cancelamento de venda.
| 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. |
| retorno | - parametro passado por referência que ira armazenar os dados de retorno ao fim da transação. |
| int IniciaOperacaoAdministrativaRef | ( | int | idTransacao, |
| const char * | pdv, | ||
| int | operacao, | ||
| char ** | retorno | ||
| ) |
Inicia uma operação administrativa.
| 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:
|
| retorno | - parametro passado por referência que ira armazenar os dados de retorno ao fim da transação. |