Ürün ve API rehberi

Kimlik doğrulama

Anahtar ne işe yarar

Her çağrı tek bir anahtar taşır ve anahtar kişiye değil çalışma alanına aittir; biri ayrıldığında çalışmaya devam eder. Hesap, API anahtarları altından oluşturursunuz: gizli değer bir kez gösterilir, neyi yapabileceğini ise kapsamları belirler.

Her istek bir API anahtarı taşır. Anahtarı hesabınızdaki API anahtarları ekranından oluşturursunuz; oluşturulduğu anda bir kez gösterilir, sonra saklanmaz.

X-PDFgine-Key: pdfgine_live_xxxxxxxxxxxxxxxxxxxxxxxx

Anahtarı tarayıcıya veya mobil uygulamaya gömmeyin. Çağrıları kendi sunucunuzdan yapın.

Her anahtara yetki kapsamı verirsiniz; örneğin yalnız belge üretimi yapan bir anahtar şablon değiştiremez.

templates:read   templates:write   documents:render
previews:manage  assets:read       assets:write
usage:read       api-keys:manage

Çalışan bir çağrı ve çalışmayan bir çağrı

İlk çağrı şablonlarınızı listeler. İkincisi iptal edilmiş bir anahtar gönderiyor ve yanıt bunu açıkça söylüyor.

cURL 
# Anahtar kodun içinde değil, ortamda durur
export PDFGINE_KEY="pdfgine_live_..."

curl -i https://api.pdfgine.com/api/v1/templates \
  -H "X-PDFgine-Key: $PDFGINE_KEY"
Cevap 
HTTP/1.1 401 Unauthorized
Content-Type: application/problem+json

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.2",
  "title": "Unauthorized request",
  "status": 401,
  "detail": "The API key is invalid.",
  "correlationId": "0123b82d0a59e8b196a783af0e0e86bc"
}

Her hata gövdesi bir correlationId taşır. Destek ekibine yazarken onu iletin; istek kütüklerde tahmin edilmeden bulunur.

Sık takılınan yerler

  • Anahtar X-PDFgine-Key başlığında gider. Authorization: Bearer jetonu hiç okunmaz, yani anahtar geçerli olsa bile çağrı 401 alır.
  • 401 ile 403 aynı şey değil. 401 "kim olduğunu bilmiyorum", 403 ise "seni tanıyorum ama bu anahtarın böyle bir kapsamı yok" demektir; templates:write kapsamı olmayan bir anahtar şablon kaydedemez. Kapsamlar anahtar oluşturulurken belirlenir.
  • Gizli değer bir kez gösterilir. Kaybolduysa yeniden okumanın yolu yok; o anahtarı iptal edip yenisini oluşturun.
  • Anahtarın tarayıcıda ya da mobil uygulamada yeri yoktur. Cihaza giden her şey oradan okunabilir; PDFgine'i kendi sunucunuzdan çağırın.
  • İptal, bir sonraki çağrıda geçerli olur. Önce yeni anahtarı dağıtın, sonra eskisini iptal edin; yoksa yoldaki çağrılar düşer.