Ürün ve API rehberi

Taslaklar, yayın ve sürümler

Kaydetmek ve yayınlamak farklıdır

Kaydetme, üzerinde çalıştığınız şablonun taslağını günceller. Yayınlama ise üretimde kullanılacak sürümü belirler. Bir şablonun yayınlanmış sürümü varken daha yeni bir taslak üzerinde çalışabilirsiniz; taslak değişikliğinin yayına geçtiğini varsaymayın.

Yayın öncesi kontrol

Örnek ve gerçekçi uzun verilerle önizleme alın; gereken çıktı biçimlerini kontrol edin. Geçmiş penceresinde etkin ve yayınlanmış sürümü karşılaştırın. Üretime geçirmek istediğiniz içerik hazır olduğunda yayınlayın.

Geçmişten geri yükleme

Geçmişteki bir sürümü geri yüklemek, o içeriği yeni etkin sürüm olarak kaydeder; eski geçmiş kayıtlarını silmez. Geri yükledikten sonra içeriği yeniden kontrol edin. Yayınlanmış sürümü değiştirmek istiyorsanız ayrıca yayınlama adımını uygulayın.

Sürüm okuma, geri yükleme ve yayımlama

Her elle kayıt yeni bir sürüm açar ve hiçbir şeyin üzerine yazılmaz. Eski bir sürüme dönmek yenilerini silmez — eski tanımı yeni bir sürüm olarak yazar, yani geçmiş eksiksiz kalır.

cURL

# Sürüm listesi - en yeni başta
curl -s https://api.pdfgine.com/api/v1/templates/invoice/history \
  -H "X-PDFgine-Key: $PDFGINE_KEY"

# Tek bir sürümün tanımı
curl -s https://api.pdfgine.com/api/v1/templates/invoice/history/3 \
  -H "X-PDFgine-Key: $PDFGINE_KEY"

# O sürüme geri dön - yeni bir sürüm olarak yazılır, eskisi silinmez
curl -X POST https://api.pdfgine.com/api/v1/templates/invoice/history/3/restore \
  -H "X-PDFgine-Key: $PDFGINE_KEY"

# Taslağı yayına al
curl -X POST https://api.pdfgine.com/api/v1/templates/invoice/publish \
  -H "X-PDFgine-Key: $PDFGINE_KEY"

HTTP 409

{
  "type": "https://pdfgine.dev/problems/template-conflict",
  "title": "Şablon çakışması",
  "status": 409,
  "detail": "Şablon başka bir işlem tarafından değiştirildi. Güncel sürümü yükleyip yeniden deneyin.",
  "templateCode": "invoice",
  "currentVersion": 19,
  "currentDraftRevision": 0
}

Bayat bir expectedVersion taşıyan yazma birleştirilmez, reddedilir. 409 gövdesi şablonu, güncel sürümünü ve taslak revizyonunu söylüyor — güncel tanımı okuyun, değişikliğinizi yeniden uygulayın ve tekrar yazın.

Çakışma ve bağlantı kodu

Başka bir oturum aynı şablonu değiştirdiyse eski sürüm üzerinden kaydetme çakışabilir. Güncel durumu ve geçmişi inceleyin; değişiklikleri körlemesine ezmeyin. Bağlantı kodu API isteklerinde şablonu bulmak için kullanılır. Kod değişikliğinde bu kodu kullanan entegrasyonları da güncellemeniz gerekir.

Uçtan uca rapor hazırlama →

Sık takılınan yerler

Kaydetmek yayımlamak değildir. Taslak günlerce kusursuz durabilir, üretim yine son yayımlanmış sürümü basar.
Geri yükleme hiçbir şeyi silmez. Eski tanımı yeni bir sürüm olarak yazar; geçmiş yerinde kalır ve sürüm numarası artmaya devam eder.
Aynı expectedVersion ile tekrarlanan 409 yine reddedilir. Güncel sürümü okuyun, değişikliğinizi onun üzerine uygulayın, sonra yazın.
purpose editor-test taslağı, production yayımlanmış sürümü kullanır. Birbirinin aynı görünen iki üretim, iki farklı tasarımdan gelmiş olabilir.
Geçmiş ucu sayfalıdır. limit vermezseniz en son sayfayı ve bir Link başlığı alırsınız; o sayfayı bütün geçmiş saymak eski revizyonları gizler.