Ürün ve API rehberi

Varlıklar

Varlık yükleme

Logo, imza ve yazı tipi bir kez yüklenir, sonra kimliğiyle kullanılır. İstek multipart; dosya file adlı alana konur, altText isteğe bağlıdır.

İstek
curl -X POST https://api.pdfgine.com/api/v1/assets \
  -H "X-PDFgine-Key: $PDFGINE_KEY" \
  -F "file=@logo.png" \
  -F "altText=Şirket logosu"
HTTP 201
{
  "assetId": "ast_985f87e2b22d486db2d6d8bacd29288e",
  "fileName": "logo.png",
  "contentType": "image/png",
  "length": 20184,
  "altText": "Şirket logosu",
  "createdAt": "2026-09-26T15:29:44.8420041+00:00",
  "expiresAt": null,
  "fontEmbedding": null
}

Tür, gönderdiğiniz Content-Type'tan değil dosyanın ilk baytlarından okunur: aslında PDF olan bir .png reddedilir. PNG, JPEG, WebP, TTF ve OTF kabul edilir; dosya başına en çok 10 MB.

Belgede kullanma

Şablonun görsel beklediği yere kimliği gönderin. Aynı alan data: URI de kabul eder ama yüklenmiş varlık hem hatta daha küçüktür hem de yeniden kullanılabilir.

İstek
curl -X POST https://api.pdfgine.com/api/v1/render \
  -H "X-PDFgine-Key: $PDFGINE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "templateCode": "invoice",
        "format": "pdf",
        "data": { "logo": "ast_985f87e2b22d486db2d6d8bacd29288e" }
      }'

Geçici varlıklar, listeleme ve silme

Tek bir belge için gereken görseli elle temizlemek gerekmiyor: expiresInMinutes değerini 1 ile 10080 (yedi gün) arasında verin, varlık kendini siler.

İstek
curl -X POST https://api.pdfgine.com/api/v1/assets \
  -H "X-PDFgine-Key: $PDFGINE_KEY" \
  -F "file=@signature.png" \
  -F "expiresInMinutes=60"

# Listeleme, tek varlığın içeriği ve silme
curl https://api.pdfgine.com/api/v1/assets -H "X-PDFgine-Key: $PDFGINE_KEY"
curl https://api.pdfgine.com/api/v1/assets/ast_985f87e2b22d486db2d6d8bacd29288e/content \
  -H "X-PDFgine-Key: $PDFGINE_KEY" -o logo.png
curl -X DELETE https://api.pdfgine.com/api/v1/assets/ast_985f87e2b22d486db2d6d8bacd29288e \
  -H "X-PDFgine-Key: $PDFGINE_KEY"

Yazı tipleri ve neyin gömülebileceği

Bir yazı tipi dosyası, kendi fsType bitlerinde belgenin onunla ne yapabileceğini söyler. PDFgine bunu yükleme anında okur ve fontEmbedding ile yanıtlar; böylece cevabı belgeyi ürettikten sonra değil, önce öğrenirsiniz.

fontEmbedding Belge ne yapabilir
installableKısıt yok; hem PDF'e hem Word'e gömülür.
editableHem PDF'e hem Word'e gömülür.
preview-printPDF'e gömülür. Word'e gömülmez, çünkü Word belgesi düzenlenebilir; Word kendi ikamesini koyar.
restrictedHiçbir yere gömülmez. Belge yine üretilir, okuyanın kendi yazı tipi kullanılır.
bitmap-onlyYalnız bitmap gömmeye izin veriyor; belge bunu kullanamaz. Gömülmez.
unstatedDosya bir izin beyan etmiyor. Gömülebilir sayılır; OpenType belirtiminin istediği de budur.

WOFF ve WOFF2 yüklemede reddedilir. Word belgesine gömülemiyorlar ve aynı şablon PDF'te doğru, Word'de yanlış çıkardı — belgeyi gönderdikten sonra fark edeceğiniz bir fark.

Hazır yazı tipleri

Bu aileler ürünle gelir; style.fontFamily ve page.defaultFont adlarıyla kullanılır. Aynı yüz PDF'e, Word'e ve editöre gider. Ailede olmayan ağırlık reddedilmez, en yakın yüzle basılır.

Aile Grup Ağırlıklar Yazı sistemleri
Inter sans 100, 200, 300, 400, 500, 600, 700, 800, 900 latin, latin-ext, greek, cyrillic, vietnamese
Roboto sans 100, 200, 300, 400, 500, 600, 700, 800, 900 latin, latin-ext, greek, cyrillic, vietnamese
Montserrat sans 100, 200, 300, 400, 500, 600, 700, 800, 900 latin, latin-ext, cyrillic, vietnamese
Poppins sans 100, 200, 300, 400, 500, 600, 700, 800, 900 latin
DM Sans sans 100, 200, 300, 400, 500, 600, 700, 800, 900 latin
Nunito sans 200, 300, 400, 500, 600, 700, 800, 900 latin, cyrillic, vietnamese
Manrope sans 200, 300, 400, 500, 600, 700, 800 latin, greek, cyrillic, vietnamese
Noto Sans sans 100, 200, 300, 400, 500, 600, 700, 800, 900 latin, latin-ext, greek, cyrillic, vietnamese
Plus Jakarta Sans sans 200, 300, 400, 500, 600, 700, 800 latin, vietnamese
Work Sans sans 100, 200, 300, 400, 500, 600, 700, 800, 900 latin, latin-ext, vietnamese
Roboto Condensed condensed 100, 200, 300, 400, 500, 600, 700, 800, 900 latin, latin-ext, greek, cyrillic, vietnamese
Oswald condensed 200, 300, 400, 500, 600, 700 latin, latin-ext, cyrillic, vietnamese
Noto Serif serif 100, 200, 300, 400, 500, 600, 700, 800, 900 latin, latin-ext, greek, cyrillic, vietnamese
EB Garamond serif 400, 500, 600, 700, 800 latin, latin-ext, greek, cyrillic, vietnamese
Newsreader serif 200, 300, 400, 500, 600, 700, 800 latin, vietnamese
Literata serif 200, 300, 400, 500, 600, 700, 800, 900 latin, greek, cyrillic, vietnamese
Tinos serif 400, 700 latin, latin-ext, greek, cyrillic, vietnamese
Rokkitt serif 100, 200, 300, 400, 500, 600, 700, 800, 900 latin, vietnamese
Inconsolata mono 200, 300, 400, 500, 600, 700, 800, 900 latin, vietnamese
Noto Sans Mono mono 100, 200, 300, 400, 500, 600, 700, 800, 900 latin, latin-ext, greek, cyrillic, vietnamese
Arial system 400, 700
Georgia system 400, 700

Yükleme reddedildiğinde

Her ret bir 400 ve gerekçe errors.file altında. O cümleyi yükleyen kişiye gösterin; ne yapılacağını zaten söylüyor.

HTTP 400
{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "errors": {
    "file": ["Word çıktısında kullanılabilmesi için TTF veya OTF yükleyin. WOFF ve WOFF2 dosyaları Word belgesine gömülemez."]
  },
  "correlationId": "505aac87e234a7b4669e6203ac7ffcd5"
}
Hatalar →

Sık takılınan yerler

  • Tür dosya adından değil ilk baytlardan okunur. Bir PDF'i .png diye adlandırmak onu görsel yapmaz; yükleme reddedilir.
  • WOFF ve WOFF2 bilerek reddedilir. Word'e gömülemezler; aynı şablon PDF'te doğru, Word'de yanlış çıkardı — TTF ya da OTF yükleyin.
  • Yükleme yanıtı fontEmbedding taşır. Onu görmezden gelmek, yazı tipinin değiştirildiğini belge çoktan gittikten sonra öğrenmek demektir.
  • data: URI her istekle birlikte yol alır. Her belgede görünen bir logoyu bir kez yükleyin ve kimliğini gönderin.
  • Tek belgelik bir görseli elle temizlemek gerekmez. expiresInMinutes verin, kendini silsin.