Skip to main content

Índice da Documentação

Acesse o índice completo da documentação em: https://developers.nortgraf.com.br/llms.txt\ Utilize este arquivo para descobrir todas as páginas disponíveis antes de explorar o conteúdo.

Nortgraf · Documentação para Desenvolvedores

Bem-vindo à documentação oficial da Nortgraf, a plataforma SaaS para gráficas e lojas virtuais, construída sobre o nortOS.
Aqui você encontra tudo o que precisa para entender, operar, integrar e evoluir a Nortgraf: catálogo, pedidos, produção, estoque, pagamentos, multi-tenancy, infraestrutura e automações.

Comece por aqui

Entenda rapidamente como o sistema funciona e como tudo se conecta.

Guia rápido

Coloque a documentação em funcionamento e entenda a estrutura do projeto em poucos minutos.

Visão geral da arquitetura

Como a Nortgraf é organizada: Control Plane, tenants, serviços, storage e gateways.

Tenancy & provisionamento

Como lojas são criadas, isoladas, versionadas e atualizadas com segurança.

Ambiente & deploy

Padrões de deploy, releases, migrations e boas práticas operacionais.

Convenções do projeto

Padrões de código, nomenclaturas, estrutura de pastas e regras arquiteturais.

Módulos principais

Os pilares funcionais da plataforma, do catálogo à produção.

Catálogo & precificação

Precificação por quantidade, metro quadrado e demanda — regras e exibição.

Pedidos & checkout

Criação de pedidos, cálculo de totais, frete, cupons, créditos e status.

Produção (OP / Kanban)

Ciclo da OP, workflows configuráveis, eventos, QR Code e chão de fábrica.

Estoque & custos

Insumos, movimentações, fornecedores, custos diretos e rentabilidade.

Pagamentos & integrações

Arquitetura de gateways, fluxos de pagamento e integrações externas.

Arquitetura de pagamentos

Estratégia de gateways (Strategy + Factory) e separação entre pedido e pagamento.

PagBank Connect (OAuth)

Fluxo OAuth, escopos, sandbox e erros comuns (415, invalid_token).

Asaas

PIX, boletos, headers, regras de origem e observações da integração.

Stripe (notas e roadmap)

Assinaturas, prorrata, planos e migração de gateways.

Operação, infraestrutura e segurança

Como rodar a Nortgraf em produção com previsibilidade e segurança.

MySQL & grants

Containers, permissões mínimas, gestão de bancos por tenant e recuperação.

Backups & restauração

Estratégia de snapshots, dumps e recuperação completa do ambiente.

Arquivos & storage (R2)

Uploads, CDN, segregação por tenant e ciclo de vida dos arquivos.

Segurança & exposição

Firewall, Cloudflare, exposição de banco, incidentes e lições aprendidas.

Central de ajuda & interface administrativa

Documentação das telas administrativas e base de conhecimento do sistema.

Páginas da Central de Ajuda

Documentação das telas do admin, fluxos do sistema e conteúdos de suporte.

Precisa resolver um problema específico?

Comece pelos guias de diagnóstico e histórico de mudanças.

Troubleshooting

Padrões de erro, causas raiz e passos de correção.

Notas de versão & mudanças

Histórico de versões, migrations e impactos por tenant.