1) Usuários
1.1 Autenticação
POST
/api/usuario/autenticar
Body
{ "email": "[email protected]", "senha": "102030" }
Resposta: TODO (ex.:
{ token, usuario }
)
1.2 Recuperar senha
POST
/api/usuario/recuperar-senha
Body
{ "email": "[email protected]" }
Resposta: TODO (ex.: status do envio)
1.3 Atualizar unidade padrão
PATCH
/api/usuario/unidade-padrao/id/{USUARIO_ID}
Body
{ "unidadePadraoId": 1 }
Resposta: TODO
1.4 Cadastrar usuário
POST
/api/usuario/cadastrar
Body
{ "unidadePadraoId": 1, "nome": "Meu Nome", "cpf": "111.111.111-23", "sexo": "M", "dataNascimento": "2000-01-01", "aceitoInfoOfertas": "S", "aceitoBrindesAmostras": "S", "email": "[email protected]", "celular": "(99) 99999-9991", "senha": "102030", "cep": "74415-220", "endereco": "Rua C14", "numero": "SN", "complemento": "", "bairro": "Vila Canaa", "cidade": "Goiania", "estado": "GO", "codIbge": "" }
Validações sugeridas (app-side):
email
válido;senha
≥ 6 chars;cpf
no padrão;sexo
∈ {M,F};aceito*
∈ {"S","N"}; datas ISOYYYY-MM-DD
.
Resposta: TODO (ex.:
{ id, ... }
)
1.5 Enviar e-mail de validação
POST
/api/usuario/enviar-email-validação
Body
{ "email": "[email protected]" }
Resposta: TODO
1.6 Enviar SMS/WhatsApp de validação
POST
/api/usuario/enviar-mensagem-validação
Body
{ "celular": "41999999999" }
Resposta: TODO
1.7 Validar e-mail
POST
/api/usuario/validar-email
Body
{ "email": "[email protected]", "token": "506424" }
Resposta: TODO
1.8 Validar celular
POST
/api/usuario/validar-celular
Body
{ "celular": "41999999999", "token": "742852" }
Resposta: TODO
1.9 Listar notificações do usuário
GET
/api/usuario/notificacoes/id/{USUARIO_ID}
Query: —
Resposta: TODO (ex.: array de notificações)
1.10 Excluir usuário
DELETE
/api/usuario/excluir/id/{USUARIO_ID}
Resposta:
204 No Content
(sugerido) ou TODO
1.11 Atualizar dados do usuário
PUT
/api/usuario/atualizar/id/{USUARIO_ID}
Body (mesmo shape do cadastro, exceto campos opcionais)
{ "unidadePadraoId": 1, "nome": "Meu Nome", "sexo": "M", "dataNascimento": "2000-01-01", "aceitoInfoOfertas": "S", "aceitoBrindesAmostras": "S", "email": "[email protected]", "celular": "(99) 99999-9991", "senha": "102030", "cep": "74415-220", "endereco": "Rua C14", "numero": "SN", "complemento": "", "bairro": "Vila Canaa", "cidade": "Goiania", "estado": "GO", "codIbge": "" }
Resposta: TODO
1.12 Foto do usuário — upload
POST
/clientes/set-foto-usuário
Form-data (multipart):
usuarioId
(text)arquivo
(file)
Resposta: TODO (ex.: URL da imagem)
1.13 Foto do usuário — obter
GET
/clientes/get-foto-usuario?usuario={ID}
Resposta: binário (imagem) ou JSON com URL (TODO confirmar)
1.14 Foto do usuário — remover
DELETE
/clientes/remover-foto-usuario?usuario={ID}
Resposta:
204 No Content
(sugerido) ou TODO
1.15 Buscar dados do usuário (por identificador)
POST
/clientes/get-dados-cliente
Body
{ "identificador": "47893028220" }
Resposta: TODO (ex.: dados cadastrais)
1.16 Transferência de crédito entre usuários
POST
/clientes/set-transferencia-credito-convenio
Body
{ "usuarioOrigem": 64, "usuarioDestino": 71, "valor": 0.01 }
Resposta: TODO (ex.: comprovante/lançamento)
2) Produtos
2.1 Listagem de produtos (paginada)
POST
/api/produtos/listagem?pagina=1&quantidade=10
Body (filtros opcionais)
{ "unidade": 1, "ean": null, "descricao": null, "categoria": null }
Resposta: TODO (ex.:
{ itens: [...], pagina, quantidade, total }
)
2.2 Produto individual (por EAN)
GET
/api/produtos/produto?unidade=12&ean=07896007540624
Resposta: TODO (dados do produto)
2.3 Produto fiscal (por ID)
GET
/api/produtos/produto-fiscal?unidade=12&id=1103
Resposta: TODO (dados fiscais)
3) Parâmetros / Finalizadoras / Ações
3.1 Parâmetros gerais
GET
/api/index/parametros?unidade=12&mobile=true
Resposta: TODO (chaves/flags de configuração do app)
3.2 Listagem de finalizadoras
POST
/api/finalizadoras/listagem?pagina=1&quantidade=1
(o exemplo mostra body ⇒ método POST sugerido; confirmar)Body (filtros)
{ "id": null, "unidade": null, "appAtivo": null, "pdvAtivo": null }
appAtivo
epdvAtivo
podem ser true/false.Resposta: TODO (lista paginada)
3.3 Ícone da finalizadora (imagem)
GET
/api/finalizadoras/icone/imagem/1715223207.png
Resposta: binário da imagem
3.4 Abrir porta (ação por usuário)
POST
/api/index/abrir-porta/id/{USUARIO_ID}
Body
{ "qrCode": "10008e9178" }
Resposta: TODO (confirmação/registro)
4) Banners
WSF_BANNER.PHP
curl --location 'https://show.e4sistemas.com.br:17083/wsf_banner.php' \
--form 'id="22"'
5) Ofertas
WSF_OFERTAS.PHP
curl --location 'https://show.e4sistemas.com.br:17083/wsf_ofertas.php' \
--form 'id="22"' \
--form 'idLicenca="2"'
WSF_OFERTA_DET.PHP
curl --location 'https://show.e4sistemas.com.br:17083/wsf_oferta_det.php' \
--header 'Cookie: PHPSESSID=3dhll3t7n18s0qltfp0otgpnhk' \
--form 'id="22"' \
--form 'idOferta="812"'
WSF_OFERTA_VALIDA.PHP
curl --location 'https://show.e4sistemas.com.br:17083/wsf_oferta_valida.php' \
--header 'Content-Type: application/json' \
--data '{
"unidadeId": "1",
"cupomDescontoId": "0",
"clienteId": 22,
"valorCompra": 64.00,
"produtos": [
{
"id": "1942",
"valor": 32.00,
"quantidade": 2
},
{
"id": "1280",
"valor": 32.00,
"quantidade": 2
}
],
"idLicenca": "699231"
}'
6) Carteira Digital / Extrato / Últimas Compras
WSF_EXTRATO.PHP
curl --location 'https://show.e4sistemas.com.br:17083/wsf_extrato.php' \
--form 'id="22"' \
--form 'idLicenca="2"'
WSF_EXTRATOZ.PHP
curl --location 'https://show.e4sistemas.com.br:17083/wsf_extratoz.php' \
--form 'id="22"' \
--form 'idLicenca="2"'
WSF_COMPRAS.PHP
curl --location 'https://show.e4sistemas.com.br:17083/wsf_compras.php' \
--form 'id="22"' \
--form 'idLicenca="2"'
IMPRIMIR-DANFE
https://show.e4sistemas.com.br/basico/webservice/imprimir-danfe/id/12105634/x-cliente-id/2
7) Cupom de Desconto
WSF_CUPONS.PHP
curl --location 'https://show.e4sistemas.com.br:17083/wsf_cupons.php' \
--header 'Cookie: PHPSESSID=3dhll3t7n18s0qltfp0otgpnhk' \
--form 'idLicenca="2"' \
--form 'user="22"'
VALIDA-CUPOM-DESCONTO
curl --location 'https://show.e4sistemas.com.br/actus/valida-cupom-desconto' \
--header 'X-Cliente-Id: 2' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer a5b3c7d8e7' \
--header 'Cookie: PHPSESSID=3dhll3t7n18s0qltfp0otgpnhk' \
--data '{"unidadeId":"12","cupomDescontoId":"wddssd","clienteId":74,"valorCompra":2.19,"produtos":[{"id":"1050","valor":2.19}],"idLicenca":"2"} '
8) Validações/Finalizações de Vendas
PARÂMETROS
curl --location 'https://show.e4sistemas.com.br/api/index/parametros?unidade=12&mobile=true' \
--header 'X-Cliente-Id: 2' \
--header 'X-Produto: mercado-app' \
--header 'Authorization: Bearer Qu,TdD6?}rQyG\Wja@;;4,BsF4L={[h*' \
--header 'Cookie: PHPSESSID=6rfisu7jmag69dubolbqhrbebk'
CEP
https://viacep.com.br/ws/{cep}/json
LOJAS
curl --location 'https://show.e4sistemas.com.br:17083/wsf_lojas_nome.php' \
--form 'idLicenca="2"'
WSF_ID_PEDIDO.PHP
curl --location 'https://show.e4sistemas.com.br:17083/wsf_id_pedido.php' \
--header 'Cookie: PHPSESSID=3dhll3t7n18s0qltfp0otgpnhk' \
--form 'idLicenca="2"'
SET-CUPOM-V2
curl --location 'https://show.e4sistemas.com.br/actus/set-cupom-v2/cupom/805' \
--header 'X-Cliente-Id: 2' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer a5b3c7d8e7' \
--header 'Cookie: PHPSESSID=6rfisu7jmag69dubolbqhrbebk' \
--data '{"id":805,"id_lojas":2,"id_pdvs":15,"id_ecfs":1,"id_funcionarios":3,"id_funcionarios_desconto":"","id_funcionarios_cancelamento":"","id_motivos_desconto":"","id_motivos_cancelamento":"","id_clientes":"","id_contas":1,"id_plano_contas_contas":204,"id_centro_custo":0,"ws_operacoes_fiscais":99,"ws_tipo_documentos":3,"codigo_loja":"2","nome_fantasia":"JOAO BETTEGA HOME CLUB","cod_pdv":"1","ecf_serie":"","data_inicio":"2024-11-19 14:50:38","data_efetivacao":"2024-11-19 14:51:08","data_fim":"2024-11-19 14:51:32","tipo_preco_padrao":0,"tipo_preco_cliente":"","documento":"","email":"","valor_total":15.48,"valor_desconto":0,"valor_acrescimo":0,"valor_liquido":15.48,"valor_troco":0,"cancelado":false,"produtos":[{"id":"890","id_categorias":174,"id_funcionarios_desconto":"","id_funcionarios_cancelamento":"","id_motivos_desconto":"","id_motivos_cancelamento":"","id_figura_fiscal":8,"id_figura_fiscal_pis_cofins":1,"id_tipo_ofertas":"","ws_operacoes_fiscais":"165","ws_cst_icms":13,"ws_cst_pis_cofins_pis":1,"ws_cst_pis_cofins_cofins":1,"sequencia":1,"ean":"07891962036984","codigo":"0107233-1","descricao":"BISC. WAFER BAUDUCCO 140G CHOC","unidade":"Un","tipo_preco":0,"quantidade":1,"valor_varejo":5.49,"valor_unitario":5.49,"valor_total":5.49,"valor_desconto":0,"valor_acrescimo":0,"valor_liquido":5.49,"aliquota":{"vl_aliquota_icms":0,"vl_aliquota_pis":1.65,"vl_aliquota_cofins":7.6},"custo":{"vl_custo_nf":2.98,"vl_custo_sem_icms_nf":2.98,"vl_custo_margem_zero_nf":0},"composicao":null,"tipo_coleta":"0","cancelado":false},{"id":"980","id_categorias":106,"id_funcionarios_desconto":"","id_funcionarios_cancelamento":"","id_motivos_desconto":"","id_motivos_cancelamento":"","id_figura_fiscal":7,"id_figura_fiscal_pis_cofins":1,"id_tipo_ofertas":"","ws_operacoes_fiscais":"99","ws_cst_icms":13,"ws_cst_pis_cofins_pis":1,"ws_cst_pis_cofins_cofins":1,"sequencia":2,"ean":"07891000336281","codigo":"0110468-3","descricao":"CHOCOLATE NESTLE ALPINO BLACK TOP 85G","unidade":"Un","tipo_preco":0,"quantidade":1,"valor_varejo":9.99,"valor_unitario":9.99,"valor_total":9.99,"valor_desconto":0,"valor_acrescimo":0,"valor_liquido":9.99,"aliquota":{"vl_aliquota_icms":0,"vl_aliquota_pis":1.65,"vl_aliquota_cofins":7.6},"custo":{"vl_custo_nf":5.79,"vl_custo_sem_icms_nf":5.79,"vl_custo_margem_zero_nf":6.38},"composicao":null,"tipo_coleta":"0","cancelado":false}],"finalizadoras":[{"id":"6","id_clientes":"","id_funcionarios":"","id_convenios":"","id_ramo_atividades":"","id_plano_negociacoes":"","id_plano_contas_contas":"206","id_plano_contas_contas_pre_pago":null,"id_centro_custo":"2","id_cupom_desconto":"","ws_bandeiras":"1","ws_tipo_operadora_cartoes":"132","codigo":"104","nome":"DÉBITO","forma_pagamento":"3","gera_titulo":"N","gera_cheque":"N","valor_pago":15.48,"valor_troco":0,"cliente_tipo_credito":"","cliente_limite_geral_disponivel":0,"cliente_limite_diario_disponivel":0,"cliente_limite_mensal_disponivel":0,"cliente_nome":"","cliente_documento":"","cliente_data_vencimento":"","cliente_banco":"","cliente_agencia":"","cliente_conta":"","cliente_cheque":"","tef_codigo_resposta":"00","tef_nsu":"000001","tef_nsu_host":"000000001","tef_autorizacao":"303838","tef_cartao_bin":"514815","tef_cartao_numero":"","tef_cartao_ultimos_digitos":"2753","tef_cartao_validade":"3205","tef_cliente":"","tef_nome_produto":"Maestro ","tef_codigo_rede_autorizadora":"00125","tef_codigo_bandeira":"20001","tef_data_autorizacao":"20241119145108","tef_numero_parcelas":"","tef_primeira_parcela_data":"","tef_primeira_parcela_valor":"","tef_demais_parcelas_valor":"","tef_demais_parcelas_intervalo_dias":"","tef_estabelecimento":"028954468430001","tef_comprovante_cliente":" EKO MARKET LTDA\n \n PREPAGO MASTERCARD\n CIELO\n MAESTRO\n 514815******2753\n1a VIA-CLIENTE AUT=303838\nDOC=000001 19/11/24 14:51 ONL-L\nVENDA A DEBITO\nVALOR: 15,48\n \n SiTef from Fiserv\n","tef_comprovante_estabelecimento":" EKO MARKET LTDA\n \n PREPAGO MASTERCARD\n CIELO\n MAESTRO\n 514815******2753\n2a VIA-ESTABELECIMENTO AUT=303838\n0028954468430001/PDV=41253387\nDOC=000001 19/11/24 14:51 ONL-L\nVENDA A DEBITO\nVALOR: 15,48\n \n A0000000043060-972D9E28C18B3E57\n Debito\n \n SiTef from Fiserv\n","habilitar_impressao":"N"}]}'
9) Pagamentos/Cartões
CARTÕES/LISTAGEM
curl --location 'https://show.e4sistemas.com.br/api/cartoes/listagem?cliente=8' \
--header 'X-Cliente-Id: 2' \
--header 'X-Produto: mercado-app' \
--header 'Authorization: Bearer Qu,TdD6?}rQyG\Wja@;;4,BsF4L={[h*' \
--header 'Cookie: PHPSESSID=6rfisu7jmag69dubolbqhrbebk'
CARTÕES/ADICIONAR
curl --location 'https://show.e4sistemas.com.br/api/cartoes/adicionar' \
--header 'X-Cliente-Id: 2' \
--header 'X-Produto: mercado-app' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer Qu,TdD6?}rQyG\Wja@;;4,BsF4L={[h*' \
--header 'Cookie: PHPSESSID=6rfisu7jmag69dubolbqhrbebk' \
--data '{
"cliente": 8,
"cartaoNumero": "4242",
"cartaoExpiracaoMes": "10",
"cartaoExpiracaoAno": "54",
"cartaoCodigo": "222",
"bandeira": "Visa",
"processadorPagamento": "P",
"token": "10"
}'
CARTÕES/EXCLUIR
curl --location --request DELETE 'https://show.e4sistemas.com.br/api/cartoes/excluir?id=37' \
--header 'X-Cliente-Id: 2' \
--header 'X-Produto: mercado-app' \
--header 'Authorization: Bearer Qu,TdD6?}rQyG\Wja@;;4,BsF4L={[h*' \
--header 'Cookie: PHPSESSID=6rfisu7jmag69dubolbqhrbebk'
PAG-SEGURO/PAGAR
curl --location 'https://show.e4sistemas.com.br/api/pag-seguro/pagar' \
--header 'X-Cliente-Id: 2' \
--header 'X-Produto: mercado-app' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer Qu,TdD6?}rQyG\Wja@;;4,BsF4L={[h*' \
--header 'Cookie: PHPSESSID=6rfisu7jmag69dubolbqhrbebk' \
--data-raw '{ "tipo": "cartao", "unidade": 2, "cupomPagSeguro": { "reference_id": 3813, "customer": { "name": "YURI RAFFIC DA SILVA LIMA ", "email": "[email protected]", "tax_id": "61179858352" }, "items": [ { "reference_id": "672", "name": "Absorvente Interno Ob Medio 10un", "quantity": 1, "unit_amount": 1599 } ], "shipping": { "address": { "street": "RUA 01", "number": "7", "complement": "G", "locality": "TRIZIDELA DA MAIOBA", "city": "SãO JOSé DE RIBAMAR", "region_code": "MA", "country": "BRA", "postal_code": "65121075" } }, "charges": [ { "reference_id": "compra 3813", "description": "Compra no MercadoApp (MODELO-L0012 (CD001))", "amount": { "value": 1599, "currency": "BRL" }, "payment_method": { "type": "CREDIT_CARD", "installments": "1", "capture": true, "soft_descriptor": "MercadoApp", "card": { "store": true, "encrypted": "bThoAz2yhE2bOXd8VHYYAXalN0c3XzC2kgWraPaqh38oWVjiaZTQ9FdnRoaEpNWSoXKitMZ0HbdggZfGFFFGyv0E1Z8zLJHaUzmXtyiWDw12GmyeGC715/oRdJiU+TGEhqoFqcmdBbLoR+4JVfGINsFxS0SQxf2dyFOe4KBB7UKsWti2VTo1Fcawoc/Rj1ZLrhU9n1YJsZPoG2QnfRz7LphRtWNT2RdCzTNsotW/4I1xSd2z+L/yw/jekohYiY2VDRSqWibmj3ILnM1LCv+fFWg56HSaO9MUIzArLd14v/2GRboRpmsnbFEQ11gy1M3lm9i4VDrYYbZZXNchDsUXCA==" }, "holder": { "name": "pagseguro ", "tax_id": "61179858352" } } } ] }, "cupomMercatus": { "cupom": { "id": 3813, "id_lojas": "12", "id_pdvs": "32", "id_ecfs": 1, "id_clientes": 84, "id_contas": 4, "id_plano_contas_contas": 204, "id_centro_custo": null, "ws_operacoes_fiscais": 99, "ws_tipo_documentos": 3, "codigo_loja": "12", "nome_fantasia": "MODELO-L0012 (CD001)", "cod_pdv": "10", "data_inicio": "2025-08-24 00:49:32", "data_efetivacao": "2025-08-24 00:49:32", "data_fim": "2025-08-24 00:49:32", "tipo_preco_padrao": 1, "documento": "61179858352", "email": "[email protected]", "valor_total": 15.99, "valor_desconto": 0.0, "valor_acrescimo": 0.0, "valor_liquido": 15.99, "valor_troco": 0.0, "cancelado": false, "produtos": [ { "id": "672", "id_categorias": 485, "id_funcionarios_desconto": "", "id_funcionarios_cancelamento": "", "id_motivos_desconto": "", "id_motivos_cancelamento": "", "id_figura_fiscal": 8, "id_figura_fiscal_pis_cofins": 1, "id_tipo_ofertas": 0, "ws_operacoes_fiscais": "165", "ws_cst_icms": 19, "ws_cst_pis_cofins_pis": 1, "ws_cst_pis_cofins_cofins": 1, "sequencia": 1, "ean": "07891010886547", "codigo": "0109711-3", "descricao": "ABSORVENTE INTERNO OB MEDIO 10UN", "unidade": "Un", "tipo_preco": 1, "quantidade": 1, "valor_varejo": 15.99, "valor_unitario": 15.99, "valor_total": 15.99, "valor_desconto": 0.0, "valor_acrescimo": 0.0, "valor_liquido": 15.99, "aliquota": { "vl_aliquota_icms": 0.0, "vl_aliquota_pis": 1.65, "vl_aliquota_cofins": 7.6 }, "custo": { "vl_custo_nf": 7.54, "vl_custo_sem_icms_nf": 6.84, "vl_custo_margem_zero_nf": 7.54 }, "composicao": null, "tipo_coleta": "0", "cancelado": false } ], "finalizadoras": [ { "codigo": "103", "id": "5", "nome": "CREDITO", "forma_pagamento": "2", "valor_pago": 15.99, "valor_troco": 0.0, "cliente_tipo_credito": "O", "cliente_limite_geral_disponivel": 0.0, "cliente_limite_mensal_disponivel": 0.0, "cliente_limite_diario_disponivel": 0.0, "cliente_nome": "YURI RAFFIC DA SILVA LIMA ", "cliente_documento": "61179858352", "cliente_data_vencimento": "", "cliente_banco": "", "cliente_agencia": "", "cliente_conta": "", "cliente_cheque": "", "tef_codigo_resposta": "", "tef_nsu": "", "tef_nsu_host": "", "tef_autorizacao": "", "tef_cartao_bin": "", "tef_cartao_numero": "", "tef_cartao_ultimos_digitos": "", "tef_cartao_validade": "", "tef_cliente": "", "tef_nome_produto": "", "tef_codigo_rede_autorizadora": "", "tef_codigo_bandeira": "", "tef_data_autorizacao": "", "tef_numero_parcelas": "", "tef_primeira_parcela_data": "", "tef_primeira_parcela_valor": "", "tef_demais_parcelas_valor": "", "tef_demais_parcelas_intervalo_dias": "", "tef_estabelecimento": "", "tef_comprovante_cliente": "", "tef_comprovante_estabelecimento": "", "habilitar_impressao": "N" } ], "versao": "1.1.72" }, "log": "" } }'
PAG-SEGURO/TOKEN
curl --location 'https://show.e4sistemas.com.br/api/pag-seguro/token?unidade=2' \
--header 'X-Cliente-Id: 2' \
--header 'X-Produto: mercado-app' \
--header 'Authorization: Bearer Qu,TdD6?}rQyG\Wja@;;4,BsF4L={[h*' \
--header 'Cookie: PHPSESSID=6rfisu7jmag69dubolbqhrbebk'
PAG-SEGURO/CONSULTAR
curl --location 'https://show.e4sistemas.com.br/api/pag-seguro/consultar?unidade=2&transacao=69D049F0-8FE5-4450-A4DB-EA66CA1BAC3D' \
--header 'X-Cliente-Id: 2' \
--header 'X-Produto: mercado-app' \
--header 'Authorization: Bearer Qu,TdD6?}rQyG\Wja@;;4,BsF4L={[h*' \
--header 'Cookie: PHPSESSID=6rfisu7jmag69dubolbqhrbebk'