Skip to content

README.md

Latest commit

 

History

History
109 lines (77 loc) · 3.7 KB

README.md

File metadata and controls

109 lines (77 loc) · 3.7 KB

TEF IP Docs

Documentação MkDocs Material

Site de documentação pública da API do TEF IP — um app Flutter que roda um servidor HTTP embarcado para integrar terminais de pagamento (Stone, Getnet, Rede) a sistemas de PDV/POS.

Conteúdo da documentação

Página Descrição
Início Visão geral do TEF IP e como ele funciona
Primeiros passos Instalação, configuração e primeira requisição
API — Perguntas Exibir perguntas interativas e coletar respostas no terminal
API — Display Exibir imagens, texto e carrossel na tela do terminal
API — Venda Gerenciar carrinho de venda (itens, pagamentos, finalização)
API — Impressão Imprimir imagens, comprovantes formatados e cupons fiscais
API — Status Consultar status, informações do app e reiniciar o servidor
API — Transações Processar pagamentos, consultar histórico e realizar estornos
API — Swagger Documentação OpenAPI interativa disponível no próprio terminal

Todos os exemplos de integração estão disponíveis em cURL, Dart, JavaScript, PHP e Ruby.

Pré-requisitos

  • Python 3.9+
  • pip

Instalação

pip install mkdocs-material

Desenvolvimento local

mkdocs serve
# → http://127.0.0.1:8000

Build

mkdocs build
# gera o site estático em site/

Estrutura

mkdocs.yml                  configuração do MkDocs Material
docs/
  index.md                  página inicial
  getting-started.md        instalação e primeira requisição
  emulator.md               emulador local para testes sem hardware
  assets/                   imagens, GIFs e diagramas
  api/
    ask.md                  POST /ask · /ask/form · /ask/cancel
    display.md              POST /display/image · text · carousel · clear · pop
    sale.md                 POST/PATCH /sale · item · payment · finalize · cancel
    print.md                POST /print/image · text · xml
    status.md               GET /status · /info · POST /restart
    transaction.md          POST/GET /transaction · reversal
    swagger.md              GET /docs · /openapi.bundle.yaml

Como contribuir

  1. Clone o repositório e instale as dependências (pip install mkdocs-material).
  2. Rode mkdocs serve para visualizar as mudanças em tempo real.
  3. Edite ou crie arquivos em docs/. Veja CLAUDE.md para convenções de estilo e o template de tabs de integração.
  4. Rode mkdocs build para verificar se o build passa sem erros antes de abrir um PR.

Contato

Mantido por

Desenvolvido e mantido por DJSYSTEM.

(Voltar ao topo)