Panduan
Sekilas pandang
Bagian berjudul “Sekilas pandang”Panduan ini menghubungkan NextPDF dengan lingkungan tempat kode Anda berjalan. Tab ini dimulai dengan daftar periksa operasi produksi, lalu mencakup lima area dalam urutan adopsi: integrasi framework dan renderer, server NextPDF Connect, Python SDK, pengembangan ekstensi mesin, dan pemecahan masalah. Setiap bagian di bawah dimulai dari halaman pusatnya, lalu mencantumkan halaman yang kemungkinan paling sering Anda gunakan.
Untuk resep berorientasi tugas yang siap disalin, gunakan Buku resep. Untuk permukaan Application Programming Interface (API) yang sudah terverifikasi dan matriks dukungan, gunakan Referensi.
Integrasi
Bagian berjudul “Integrasi”Delapan paket ini menghubungkan mesin inti dengan framework, renderer peramban, layanan edge, alat build, dan jalur migrasi warisan. Bagian tiap paket mengikuti struktur manual yang sama — ikhtisar, pemasangan, mulai cepat, konfigurasi, API, panduan pengembang, penggunaan produksi, keamanan, dan pemecahan masalah — sehingga setelah memahami satu bagian, Anda dapat mengikuti bagian lainnya.
| Halaman | Gunakan untuk |
|---|---|
| Integrasi | Peta ekstensi dan panduan pemilihan. Baca ini terlebih dahulu untuk memilih paket. |
| Indeks API integrasi | Peta halaman API ekstensi yang mencakup setiap permukaan framework, renderer, transport, dan alat build. |
| NextPDF untuk Laravel | Adapter untuk framework Laravel. |
| NextPDF untuk Symfony | Adapter untuk framework Symfony. |
| NextPDF untuk CodeIgniter | Adapter untuk framework CodeIgniter. |
| NextPDF Artisan | Jembatan renderer Chrome untuk perenderan HTML yang setara dengan peramban. |
| NextPDF Cloudflare | Jalur deployment edge di Cloudflare. |
| NextPDF Gotenberg | Jembatan renderer Gotenberg. |
| Kompatibilitas TCPDF | Shim kompatibilitas untuk basis kode yang sedang beralih dari TCPDF. |
| NextPDF Backport Builder | Alat build yang menargetkan runtime PHP yang lebih lama. |
NextPDF Connect
Bagian berjudul “NextPDF Connect”Paket nextpdf/server menjalankan mesin sebagai layanan yang terus berjalan: satu registri alat deterministik yang disajikan melalui Model Context Protocol (MCP), Representational State Transfer (REST), dan gRPC, dengan gerbang konfirmasi human-in-the-loop untuk alat berisiko tinggi.
| Halaman | Gunakan untuk |
|---|---|
| NextPDF Connect | Pusat bagian untuk konsep, konfigurasi, dan operasi server. |
| Ikhtisar Connect | Batas paket dan ketiga transport-nya. |
| Panduan cepat Connect | Handshake MCP pertama yang dapat dijalankan beserta permintaan render REST yang sesuai. |
| Konfigurasi Connect | Berkas YAML MCP dan variabel lingkungan NEXTPDF_*. |
| Referensi API Connect | Semua alat yang terdaftar, simbol gRPC, entri model kesalahan, dan batas laju. |
| Deployment Connect | Profil worker RoadRunner, Docker, dan penyimpanan berbasis Redis. |
| Keamanan dan operasi Connect | Autentikasi, keamanan transport, dan model ancaman. |
Setiap transport memiliki halaman referensi tersendiri.
| Halaman | Gunakan untuk |
|---|---|
| Transport MCP | Framing JSON-RPC 2.0 melalui standard input dan standard output. |
| Transport REST | Kontrak OpenAPI 3.1, autentikasi bearer, dan rute yang dibatasi berdasarkan tingkatan. |
| Transport gRPC | Layanan nextpdf.connect.v1, server streaming, dan autentikasi metadata. |
Python SDK
Bagian berjudul “Python SDK”Ekstraksi PDF yang siap disitasi untuk aplikasi Python, agen, dan baris perintah, dengan dukungan endpoint NextPDF Connect.
| Halaman | Gunakan untuk |
|---|---|
| SDK Python | Halaman pusat bagian untuk paket Python nextpdf. |
| Ikhtisar SDK Python | Fungsi SDK serta hubungannya dengan Connect. |
| Panduan mulai cepat Python SDK | Pasang dengan pip install nextpdf dan arahkan klien ke server Anda. |
| Referensi API SDK Python | Kelas klien, metode, dan hasil bertipe. |
| CLI Python | Antarmuka baris perintah untuk alur kerja ekstraksi. |
| Server MCP Python | Mengekspos SDK ke agen yang berkomunikasi melalui MCP. |
Memperluas mesin
Bagian berjudul “Memperluas mesin”Service Provider Interface (SPI) publik memungkinkan Anda menambahkan kapabilitas tanpa melakukan fork: kontrak untuk font, mesin tata letak, pendengar peristiwa, dan back end penandatanganan, masing-masing dengan jaminan stabilitas eksplisit.
| Halaman | Gunakan untuk |
|---|---|
| Pengembangan ekstensi | Apa yang dapat Anda perluas dan jaminan stabilitas yang mendasarinya. |
| Aturan stabilitas SPI | Kontrak kompatibilitas mundur yang dapat diandalkan oleh ekstensi Anda. |
| Fon kustom: kontrak FontRegistry | Mendaftarkan dan menyertakan font milik Anda sendiri. |
| Mesin tata letak khusus dan intersepsi teks | Mengganti atau mengintersepsi perilaku tata letak. |
| Pemicu aksi dan pendengar peristiwa | Mengamati dan merespons siklus hidup dokumen. |
| Kontrak penyedia KMS | Menyediakan kunci dari Key Management Service (KMS) Anda sendiri. |
Pemecahan masalah
Bagian berjudul “Pemecahan masalah”Entri gejala-ke-solusi ini didasarkan pada taksonomi eksepsi milik mesin itu sendiri. Mulailah dari apa yang Anda amati, bukan dari nama kelas.
| Halaman | Gunakan untuk |
|---|---|
| Pemecahan masalah | Pusat basis pengetahuan: cara entri disusun dan dari mana memulai. |
| Pemecahan masalah fon dan penandaan | Kegagalan penyematan font dan penandaan struktur. |
| Pemecahan masalah enkripsi dan izin | Kegagalan enkripsi, kata sandi, dan izin. |
| Pemecahan masalah memori dan performa | Batas memori dan masalah throughput. |
| Pemecahan masalah validasi PDF/A dan PDF/UA | Kegagalan validasi arsip dan aksesibilitas. |
| Pemecahan masalah tanda tangan dan stempel waktu | Kegagalan validasi tanda tangan dan stempel waktu. |
Lihat juga
Bagian berjudul “Lihat juga”- Buku resep — resep yang berorientasi tugas untuk PHP, Connect, dan integrasi.
- Referensi — permukaan API yang terverifikasi, matriks dukungan, dan referensi kesalahan.
- Migrasi ke NextPDF — beralih dari pustaka PDF lain di tab Get started.
- Memahami NextPDF dari Dalam — esai Insider_ yang menjelaskan mengapa mesin berperilaku seperti itu.