Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/api/djmonitor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Integração com DJMonitor

## Configurações necessárias no DJMonitor

1. **Liberação de módulo**: Solicite ao setor financeiro a liberação do módulo TEF IP para o cliente em questão;
2. **Forma de aprovação**: Altere a forma de aprovação para TEF IP nas formas de pagamentos que serão utilizadas juntamente com o TEF IP conforme print abaixo:

!!! warning "Atenção!"
Para a forma de pagamento PIX, é necessário estar configurado como “tipo pagto: 17 - dinâmico” e com o campo “CNPJ da instituição do pagamento” preenchido

![Configuração da forma de pagamento no DJMonitor](../assets/images/screenshot-djmonitor-forma-pagto.png){ style="width: 420px; display: block; margin: 0 auto;"}


## Configurações necessárias no DJPDV


**Endereço IP:** A única configuração necessária no PDV é apontar o IP do TEF IP, essa configuração está disponível na aba T.E.F do PDV, conforme print abaixo:
![Configuração da forma de endereço no DJPDV](../assets/images/screenshot-pdv-endereco.png){ style="width: 420px; display: block; margin: 0 auto;"}
17 changes: 17 additions & 0 deletions docs/api/xpos.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Integração com Xpos

## Configurações necessárias no Xpos

1. **Habilitar módulo TEF IP**: Nas configurações do Xpos, acesse a aba “Módulos” e habilite o parâmetro “Módulo TEF IP”.
![Parâmetro do módulo TEF IP no Xpos](../assets/images/screenshot-xpos-modulo.png){ style="width: 420px; display: block; margin: 0 auto;"}

2. **Endereço IP**: Acesse a aba TEF IP e configure o IP do terminal TEF IP.
![Configuração do TEF IP no Xpos](../assets/images/screenshot-xpos-parametros.png){ style="width: 420px; display: block; margin: 0 auto;"}

3. **Tipo aprovação TEF**: Acesse a aba “Parâmetros de Vendas” e na seção “Parâmetros de pagamentos” habilite o parâmetro “Integração com TEF” e em seguida altere o tipo de aprovação para TEF IP.
![Configuração do tipo de aprovação TEF no Xpos](../assets/images/screenshot-xpos-parametro-venda.png){ style="width: 420px; display: block; margin: 0 auto;"}


### Configuração Adicional (impressão)
- **Impressão**: Com esse parâmetro de impressão você consegue escolher se a impressão será realizada diretamente na maquininha (TEF IP) ou pelo próprio dispositivo (POS), como por exemplo um totem de autoatendimento que possui uma impressora própria.
![Configuração do tipo de impressão no Xpos](../assets/images/screenshot-xpos-impressao.png){ style="width: 420px; display: block; margin: 0 auto;"}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/screenshot-pdv-endereco.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/screenshot-xpos-impressao.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/screenshot-xpos-modulo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/screenshot-xpos-parametros.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 15 additions & 0 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,21 @@ Este guia leva você da instalação até a primeira resposta real do terminal d
- **Hardware:** terminal Android compatível (Stone, Getnet ou Rede) **ou** computador com Windows 10 ou superior
- **Rede local:** o PDV e o terminal devem estar na mesma rede (ou usar `localhost` quando o TEF IP rodar na mesma máquina)


### No Terminal Adquirente (SmartPOS)

1. **Conectividade**: O terminal deve estar na mesma rede Wi-Fi que o PDV.
2. **IP Estático**: Recomenda-se configurar um IP fixo para o terminal no roteador para evitar que o PDV perca a conexão.
3. **Apps de Apoio**: Garanta que as dependências externas listadas na tabela acima estejam instaladas e atualizadas.
4. **Permissões**: Ao abrir o TEF IP pela primeira vez, aceite todas as permissões de rede, telefone e armazenamento.

### No Windows (Emulador)

1. **Porta 9050**: Certifique-se de que a porta `9050` está aberta no Firewall do Windows para conexões de entrada.
2. **Basic Auth**: Configure o usuário e senha desejados no arquivo de configurações do app.
3. **Visual C++ Redistributable**: Pode ser necessário para a execução do app em algumas versões do Windows.

---
## Instalação

### Terminais Android (Adquirentes)
Expand Down
33 changes: 16 additions & 17 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,23 @@

Aceite pagamentos com qualquer adquirente usando uma única API HTTP local. Instale no terminal e comece a processar.

---
## O que você pode fazer

- **Pagamentos** — Crédito, débito, PIX, dinheiro, voucher, cartão-presente; parcelamento pelo lojista ou pela emissora.
- **Vendas** — Monte um carrinho com itens e adicione múltiplas formas de pagamento; finalize com uma chamada.
- **Estornos** — Consulte e reverta transações por `referenceId`.
- **Display** — Exiba textos, imagens, carrosséis ou QR codes na tela do terminal em tempo real.
- **Perguntas** — Colete dados do cliente direto no terminal: CPF/CNPJ, texto livre, lista de opções, e-mail, CEP e mais.
- **Impressão** — Imprima imagens, comprovantes personalizados, layouts ACBr ou cupons fiscais (XML/DANFE).
- **Logs e alertas** — Consulte logs, acompanhe eventos em tempo real e dispare notificações locais ao operador.
- **Status** — Monitore saúde, tempo de atividade e reinicie o app remotamente.

Veja abaixo um pagamento sendo processado no emulador:

![GIF do terminal processando pagamento manual](assets/gif/emulador-terminal-pagamento-manual.gif){ style="display: block; margin: 0 auto;" }


---
## Como funciona

```mermaid
Expand All @@ -25,22 +40,6 @@ Seu sistema faz chamadas HTTP para o TEF IP. O TEF IP se comunica com o hardware
Você pode desenvolver e testar toda a integração sem nenhum terminal físico.
[Clique aqui para saber como usar o emulador](emulator.md)

Veja abaixo um pagamento sendo processado no emulador:

![GIF do terminal processando pagamento manual](assets/gif/emulador-terminal-pagamento-manual.gif){ style="display: block; margin: 0 auto;" }

---

## O que você pode fazer

- **Pagamentos** — Crédito, débito, PIX, dinheiro, voucher, cartão-presente; parcelamento pelo lojista ou pela emissora.
- **Vendas** — Monte um carrinho com itens e adicione múltiplas formas de pagamento; finalize com uma chamada.
- **Estornos** — Consulte e reverta transações por `referenceId`.
- **Display** — Exiba textos, imagens, carrosséis ou QR codes na tela do terminal em tempo real.
- **Perguntas** — Colete dados do cliente direto no terminal: CPF/CNPJ, texto livre, lista de opções, e-mail, CEP e mais.
- **Impressão** — Imprima imagens, comprovantes personalizados, layouts ACBr ou cupons fiscais (XML/DANFE).
- **Logs e alertas** — Consulte logs, acompanhe eventos em tempo real e dispare notificações locais ao operador.
- **Status** — Monitore saúde, tempo de atividade e reinicie o app remotamente.

---

Expand Down
40 changes: 0 additions & 40 deletions docs/suporte/versoes-requisitos.md

This file was deleted.

19 changes: 19 additions & 0 deletions docs/suporte/versoes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Versões

O TEF IP é distribuído em versões específicas para cada adquirente. Cada versão é otimizada para o hardware do adquirente correspondente. Escolher a versão correta é essencial para que a integração com o terminal funcione.

---

## Versões Disponíveis

| Adquirente | Hardware Alvo | Dependências Externas |
|------------|---------------|-----------------------|
| Stone | SmartPOS | App "Stone SDK" |
| Rede | SmartPOS | App "Pagamento Rede" |
| Getnet | SmartPOS | App "Global Payments" |
| Emulador | Windows / Android | Nenhuma (perfeito para testes) |


## Como Identificar a Versão

Ao abrir o aplicativo TEF IP, a versão e o adquirente configurado geralmente constam na tela "Sobre" ou no rodapé da tela inicial. Certifique-se de que o logotipo do adquirente no app corresponde ao terminal físico que você possui.
4 changes: 3 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,12 +67,14 @@ nav:
- Logs: api/logs.md
- Notificações: api/notification.md
- Especificação (Swagger): api/swagger.md
- Integração com DJMonitor: api/djmonitor.md
- Integração com Xpos: api/xpos.md
- SDKs:
- Visão geral: sdks.md
- Dart (Oficial): sdk-dart.md
- JavaScript: sdk-js.md
- PHP: sdk-php.md
- Ruby: sdk-ruby.md
- Suporte e Operações:
- Versões e Requisitos: suporte/versoes-requisitos.md
- Versões: suporte/versoes.md
- Resolução de Problemas: suporte/resolucao-de-problemas.md
Loading