CoreApiPdf (v2.0)

CoreApiPdf, PrimeAPI’de PDF odaklı iki temel işlemi sağlar: farklı formatları PDF’e dönüştürme ve PDF’e doğrulama yazısı (law string) ile QR code katmanı ekleme. Çıktılar yeni bir OperationId ile takip edilir.

Temel kavramlar

OperationId: İşlem kimliği. Bir adım yeni çıktı üretiyorsa yanıt içinde yeni OperationId döner ve takip eden adımlarda bu yeni değer kullanılmalıdır.
Auth: Tüm uç noktalar ApiKey gerektirir.
Zarf: Tüm yanıtlar ApiResult<T> tipindedir:
- result: T
- error: string (hata durumunda dolar)

VerificationInfo modeli

PDF üzerine eklenecek doğrulama cümlesinin içeriğini ve konumlandırma parametrelerini tanımlar. Genişlik/yükseklik ve konum değerleri sayfa boyutuna göre oransal (0–1 arası) verilir.

Properties

Name
text
Type
string
Description
Doğrulama cümlesi. Yeni satır için \r\n kullanılabilir.
Name
width
Type
float
Description
Kutunun sayfa genişliğine oranı (0–1). Örn. 0.8 → sayfa genişliğinin %80’i.
Name
height
Type
float
Description
Kutunun sayfa yüksekliğine oranı (0–1). Örn. 0.1 → sayfa yüksekliğinin %10’u.
Name
left
Type
float?
Description
Kutunun sayfanın solundan uzaklığı (0–1). left ve right birlikte verilmemelidir.
Name
right
Type
float?
Description
Kutunun sayfanın sağından uzaklığı (0–1). right ve left birlikte verilmemelidir.
Name
top
Type
float?
Description
Kutunun sayfanın üstünden uzaklığı (0–1). top ve bottom birlikte verilmemelidir.
Name
bottom
Type
float?
Description
Kutunun sayfanın altından uzaklığı (0–1). bottom ve top birlikte verilmemelidir.
Name
transformOrigin
Type
string
Description
Konumlama referansı. Örn. "left top", "right top", "left bottom".

Örnek

{
  "text": "Bu belge 5070 sayılı kanuna göre elektronik olarak imzalanmıştır.",
  "width": 0.8,
  "height": 0.1,
  "left": 0.1,
  "top": 0.1,
  "transformOrigin": "left top"
}

QrCodeInfo modeli

PDF üzerine eklenecek QR kodun içeriğini ve konumlandırma parametrelerini tanımlar. Genişlik ve konum değerleri sayfa boyutuna göre oransal (0–1 arası) verilir. QR kod kare olduğundan genişlik ve yükseklik eşittir; width değeri her iki boyutu da belirler.

Properties

Name
text
Type
string
Description
QR kod içinde yer alacak metin/URL.
Name
width
Type
float
Description
Karekodun kenar uzunluğunun sayfa genişliğine oranı (0–1). Örn. 0.12 → sayfa genişliğinin %12’si.
Name
left
Type
float?
Description
Karekodun sayfanın solundan uzaklığı (0–1). left ve right birlikte verilmemelidir.
Name
right
Type
float?
Description
Karekodun sayfanın sağından uzaklığı (0–1). right ve left birlikte verilmemelidir.
Name
top
Type
float?
Description
Karekodun sayfanın üstünden uzaklığı (0–1). top ve bottom birlikte verilmemelidir.
Name
bottom
Type
float?
Description
Karekodun sayfanın altından uzaklığı (0–1). bottom ve top birlikte verilmemelidir.
Name
transformOrigin
Type
string
Description
Konumlama referansı. Örn. "left top", "right top", "left bottom".

Örnek

{
  "text": "https://doğrulama.ornek.com/abc123",
  "width": 0.12,
  "right": 0.08,
  "top": 0.08,
  "transformOrigin": "right top"
}

POST/v2.0/CoreApiPdf/ConvertToPdfCore

ConvertToPdfCore — PDF’e dönüştür

Ofis/dosya formatlarını (docx, xlsx, pptx, jpg/png/gif/tiff vb.) PDF’e dönüştürür. Dönüşüm tamamlandığında yeni bir operationId döner.

Gerekli alanlar

Name
operationId
Type
uuid
Description
Orijinal dosyaya ait işlem kimliği (yüklendikten sonra oluşan id).
Name
fileExtension
Type
string
Description
Orijinal dosyanın uzantısı: .docx .doc .xlsx .xls .pptx .ppt .jpeg .jpg .png .gif .tiff .tifs
Name
requestId
Type
string
Description
İsteğin tekil kimliği (BaseRequest).
Name
displayLanguage
Type
string
Description
Dil tercihi (BaseRequest).

Request

POST

/v2.0/CoreApiPdf/ConvertToPdfCore

curl -X POST "https://apitest.onaylarim.com/v2.0/CoreApiPdf/ConvertToPdfCore" \
  -H "X-API-KEY: {api_key}" \
  -H "Content-Type: application/json" \
  -d '{
        "operationId": "11111111-1111-1111-1111-111111111111",
        "fileExtension": ".docx",
        "requestId": "aaaaaaaaaaaaaaaaaaaaa",
        "displayLanguage": "tr"
      }'

Response

{
  "result": {
    "operationId": "44444444-4444-4444-4444-444444444444"
  },
  "error": null
}

POST/v2.0/CoreApiPdf/AddLayersCore

AddLayersCore — PDF’e katman ekle

PDF üzerine doğrulama cümlesi (law string) ve/veya QR code katmanı ekler. Çıktı yeni bir PDF olup yeni operationId döner.

Gerekli/opsiyonel alanlar

Name
operationId
Type
uuid
Description
Katman eklenecek PDF’in işlem kimliği.
Name
verificationInfo
Type
object
Description
(Opsiyonel) Doğrulama cümlesi metni ve yerleşimi (text, width, top/bottom, left/right, transformOrigin).
Name
qrCodeInfo
Type
object
Description
(Opsiyonel) QR code metni ve yerleşimi (text, width, top/bottom, left/right, transformOrigin).
Name
requestId
Type
string
Description
İsteğin tekil kimliği (BaseRequest).
Name
displayLanguage
Type
string
Description
Dil tercihi (BaseRequest).

Request

POST

/v2.0/CoreApiPdf/AddLayersCore

curl -X POST "https://apitest.onaylarim.com/v2.0/CoreApiPdf/AddLayersCore" \
  -H "X-API-KEY: {api_key}" \
  -H "Content-Type: application/json" \
  -d '{
        "operationId": "44444444-4444-4444-4444-444444444444",
        "verificationInfo": { "text": "Doğrulama için ...", "width": 0.8, "top": 0.1, "left": 0.1 },
        "qrCodeInfo": { "text": "https://..." , "width": 0.12, "right": 0.1, "top": 0.1 },
        "requestId": "aaaaaaaaaaaaaaaaaaaaa",
        "displayLanguage": "tr"
      }'

Response

{
  "result": {
    "operationId": "55555555-5555-5555-5555-555555555555"
  },
  "error": null
}

Örnek akış (PDF)

Dosya yükleme: CoreApiFile/UploadFile veya parça/parça: ChunkInit → ChunkUpload → ChunkComplete
CoreApiPdf/ConvertToPdfCore ile PDF’e dönüştür → dönen operationId ile devam edilir.
(Opsiyonel) CoreApiPdf/AddLayersCore ile doğrulama yazısı/QR code katmanı eklenir → dönen operationId ile devam edilir.