Guias
Visão geral
Seção intitulada “Visão geral”Os guias conectam o NextPDF ao ambiente em que seu código é executado. Esta aba começa com a lista de verificação de operações em produção e depois cobre cinco áreas na ordem em que elas costumam ser adotadas: integrações com frameworks e renderizadores, o servidor NextPDF Connect, o SDK Python, a extensão do motor e a solução de problemas. Cada seção abaixo começa pelo respectivo hub e, em seguida, lista as páginas que você tende a usar com mais frequência.
Para uma receita orientada a tarefas e pronta para copiar, use o Cookbook. Para consultar a superfície verificada da Application Programming Interface (API) e as matrizes de suporte, use a Referência.
Integrações
Seção intitulada “Integrações”Oito pacotes conectam o motor central a frameworks, renderizadores de navegador, serviços de borda, ferramentas de build e caminhos de migração de sistemas legados. A seção de cada pacote segue a mesma estrutura no manual — visão geral, instalação, início rápido, configuração, API, guia do desenvolvedor, uso em produção, segurança e solução de problemas — então, quando você entende um deles, entende os demais.
| Página | Use para |
|---|---|
| Integrações | O mapa das extensões e o guia de seleção. Leia primeiro para escolher um pacote. |
| Índice das APIs de integração | Indica qual página da API de extensão cobre cada superfície de framework, renderizador, transporte e ferramenta de build. |
| NextPDF para Laravel | O adaptador para o framework Laravel. |
| NextPDF para Symfony | O adaptador para o framework Symfony. |
| NextPDF para CodeIgniter | O adaptador para o framework CodeIgniter. |
| NextPDF Artisan | A ponte com o Chrome para renderizar HTML com qualidade de navegador. |
| NextPDF Cloudflare | O caminho de implantação na borda com a Cloudflare. |
| NextPDF Gotenberg | A ponte de renderização Gotenberg. |
| Compatibilidade com TCPDF | A camada de compatibilidade para bases de código que estão migrando do TCPDF. |
| NextPDF Backport Builder | A ferramenta de build voltada para runtimes PHP mais antigos. |
NextPDF Connect
Seção intitulada “NextPDF Connect”O pacote nextpdf/server executa o motor como um serviço de longa duração: um registro determinístico de ferramentas, servido por meio do Model Context Protocol (MCP), Representational State Transfer (REST) e gRPC, e protegido por uma barreira de confirmação com humano no circuito para ferramentas de alto risco.
| Página | Use para |
|---|---|
| NextPDF Connect | O hub da seção: conceitos, configuração e operações do servidor. |
| Visão geral do Connect | O escopo do pacote e seus três transportes. |
| Início rápido do Connect | Um handshake MCP inicial executável e a requisição REST de renderização correspondente. |
| Configuração do Connect | O arquivo YAML do MCP e as variáveis de ambiente NEXTPDF_*. |
| Referência da API do Connect | Cada ferramenta registrada, símbolo gRPC, entrada do modelo de erros e limite de taxa. |
| Implantação do Connect | Perfis de worker do RoadRunner, Docker e armazenamentos baseados em Redis. |
| Segurança e operações do Connect | Autenticação, segurança no transporte e o modelo de ameaças. |
Cada transporte tem sua própria página de referência.
| Página | Use para |
|---|---|
| Transporte MCP | Enquadramento JSON-RPC 2.0 por entrada e saída padrão. |
| Transporte REST | O contrato OpenAPI 3.1, autenticação bearer e rotas restritas por nível. |
| Transporte gRPC | O serviço nextpdf.connect.v1, streaming do servidor e autenticação por metadados. |
SDK Python
Seção intitulada “SDK Python”Extração de PDF pronta para citação em aplicações Python, agentes e na linha de comando, apoiada por um endpoint NextPDF Connect.
| Página | Use para |
|---|---|
| SDK para Python | O hub da seção para o pacote Python nextpdf. |
| Visão geral do SDK Python | O que o SDK faz e como ele se relaciona com o Connect. |
| Início rápido do SDK para Python | Instale com pip install nextpdf e aponte um cliente para o seu servidor. |
| Referência da API do SDK para Python | As classes de cliente, os métodos e os resultados tipados. |
| CLI do Python | A interface de linha de comando para fluxos de trabalho de extração. |
| Servidor MCP em Python | Como expor o SDK a agentes que usam MCP. |
Estender o motor
Seção intitulada “Estender o motor”A Service Provider Interface (SPI) pública permite adicionar capacidades sem precisar fazer fork: contratos para fontes, motores de layout, ouvintes de eventos e back ends de assinatura, cada um com uma promessa explícita de estabilidade.
| Página | Use para |
|---|---|
| Criação de extensões | O que você pode estender e a promessa de estabilidade associada a esse contrato. |
| Regras de estabilidade da SPI | O contrato de compatibilidade retroativa em que sua extensão pode confiar. |
| Fontes personalizadas: o contrato FontRegistry | Registrar e distribuir suas próprias fontes. |
| Motores de layout personalizados e interceptação de texto | Substituir ou interceptar o comportamento de layout. |
| Gatilhos de ação e ouvintes de evento | Observar e reagir ao ciclo de vida do documento. |
| Contrato de provedor de KMS | Fornecer chaves usando seu próprio Key Management Service (KMS). |
Solução de problemas
Seção intitulada “Solução de problemas”Entradas que vão do sintoma à resolução, fundamentadas na própria taxonomia de exceções do motor. Comece pelo que você observa, não por um nome de classe.
| Página | Use para |
|---|---|
| Solução de problemas | O hub da base de conhecimento: como as entradas são estruturadas e por onde começar. |
| Solução de problemas: fontes e marcação | Falhas na incorporação de fontes e na marcação de estrutura. |
| Solução de problemas: criptografia e permissões | Falhas de criptografia, senha e permissão. |
| Solução de problemas: memória e desempenho | Limites de memória e problemas de throughput. |
| Solução de problemas: validação de PDF/A e PDF/UA | Falhas de validação para arquivamento e acessibilidade. |
| Solução de problemas: assinaturas e carimbos de tempo | Falhas de validação de assinatura e carimbo de tempo. |
Veja também
Seção intitulada “Veja também”- Cookbook — receitas orientadas a tarefas para PHP, Connect e integrações.
- Referência — a superfície verificada da API, as matrizes de suporte e a referência de erros.
- Migração para o NextPDF — como migrar de outra biblioteca de PDF, na aba Começar.
- Por dentro do NextPDF — os ensaios Insider_ que explicam por que o motor se comporta como se comporta.