Hızlı Başlangıç

Bu rehber, PrimeAPI ile ilk isteğinizi yapmanız, X-API-KEY ile kimlik doğrulamanız ve OperationId akış mantığını görmeniz için kısa bir yol sunar. cURL örnekleriyle ilerleyeceğiz.

İstek yapmadan önce bir API anahtarı edinin ve isteklerinizi X-API-KEY başlığı ile yetkilendirin. Ayrıntılar için: Kimlik Doğrulama.

Tarayıcı → Yerel İmza Aracı → Sunucu → ONAYLARIM API

Son kullanıcı e‑imza süreci, aşağıdaki uçtan uca akışla işler. Tarayıcı yerel imza aracıyla konuşur; tüm PrimeAPI çağrıları yalnız sunucunuzdan yapılır. Her adım başarıyla tamamlandığında yeni bir operationId oluşur ve bir sonraki adıma aktarılır.

Tarayıcı, yerel imza aracı, sizin sunucunuz ve ONAYLARIM API arasındaki uçtan uca e-imza akışı

İstemciyi seçin

İlk API isteği için cURL kullanacağız. Dilerseniz projelerinizde HTTP istemci kütüphaneleri (fetch, axios, requests vb.) ile aynı başlık ve gövde formatlarını uygulayabilirsiniz.

# cURL sürümünüzü kontrol edin
curl --version

İlk API isteğiniz

Önce bir dosyayı yükleyelim ve bir operationId alalım. Bu operationId sonraki adımlarda (PDF’e dönüştürme, imzalama, indirme) kullanılacak.

POST
/v2.0/CoreApiFile/UploadFile
curl -X POST "https://apitest.onaylarim.com/v2.0/CoreApiFile/UploadFile" \
  -H "X-API-KEY: {api_key}" \
  -H "Content-Type: multipart/form-data" \
  -F "file=@/path/to/document.pdf"

Artık aynı operationId ile diğer kaynakları kullanabilirsiniz:

  • PDF’e dönüştürme: POST /v2.0/CoreApiPdf/ConvertToPdfCore
  • PDF’e katman ekleme: POST /v2.0/CoreApiPdf/AddLayersCore
  • İmzalama başlat (PAdES/CAdES/XAdES): SignStepOne...
  • İmzayı bitir (PAdES/CAdES/XAdES): signStepThree...
  • Dosya indirme: POST /v2.0/CoreApiFile/DownloadCore
CoreApiFile dokümantasyonuna git

OperationId zinciri ve örnek akış

PrimeAPI’de çoğu işlem bir dosya yükleme ile başlar. Her başarılı adım yeni bir operationId üretir ve bu değer bir sonraki adımda kullanılmalıdır. Böylece işlemler zincirlenir ve tek bir belge üzerinde ardışık işlemler izlenebilir.

Örnek senaryo:

  • Yükle → operationId (op1)
  • Katman ekle → yeni operationId (op2)
  • PAdES imza başlat → operationId (op3)
  • PAdES imza tamamla → operationId (op4)
  • Aynı dosyaya ikinci imza (tekrar başlat/tamamla) → operationId (op5)
  • İlk imzayı yükselt (Upgrade) → operationId (op6)
# 1) Upload → op1 döner
curl -X POST "https://apitest.onaylarim.com/v2.0/CoreApiFile/UploadFile" \
  -H "X-API-KEY: {api_key}" \
  -H "Content-Type: multipart/form-data" \
  -F "file=@/path/to/document.pdf"
# => op1

# 2) AddLayers → op1 kullanılır, op2 döner
curl -X POST "https://apitest.onaylarim.com/v2.0/CoreApiPdf/AddLayersCore" \
  -H "X-API-KEY: {api_key}" \
  -H "Content-Type: application/json" \
  -d '{ "operationId": "{op1}", "layers": [ /* ... */ ] }'
# => op2

# 3) PAdES Sign Step One → op2 kullanılır, op3 döner
curl -X POST "https://apitest.onaylarim.com/v2.0/CoreApiPades/SignStepOnePadesCore" \
  -H "X-API-KEY: {api_key}" \
  -H "Content-Type: application/json" \
  -d '{ "operationId": "{op2}", /* sertifika/algoritma bilgileri */ }'
# => op3

# 4) PAdES Sign Step Three → op3 kullanılır, op4 döner
curl -X POST "https://apitest.onaylarim.com/v2.0/CoreApiPades/signStepThreePadesCore" \
  -H "X-API-KEY: {api_key}" \
  -H "Content-Type: application/json" \
  -d '{ "operationId": "{op3}", /* imzalı değerler */ }'
# => op4

# 5) İkinci imza için 3-4 adımlarını tekrarlayın (op4 → op5)

# 6) Upgrade → op5 kullanılır, op6 döner
curl -X POST "https://apitest.onaylarim.com/v2.0/CoreApiPades/UpgradePadesCore" \
  -H "X-API-KEY: {api_key}" \
  -H "Content-Type: application/json" \
  -d '{ "operationId": "{op5}", "upgradeType": "LTA" }'
# => op6

Her adımda dönen operationId değerini bir sonraki adımın isteğinde kullanın. Böylece tek belge üzerindeki tüm işlemler birbirine bağlanır.

op1Yükleop1op2Katman Ekleop2op3PAdES Başlat

Her satırda soldan gelen istek yeni bir operationId üretir ve sağ tarafa geçer.

Mimari: İstemci → Sizin Sunucunuz → PrimeAPI

Son kullanıcı web uygulamaları PrimeAPI’ye doğrudan erişmemelidir. X-API-KEY yalnızca sunucu katmanında tutulur ve tüm PrimeAPI çağrıları sunucunuz üzerinden yapılır.

  • İstemci: Kendi backend’inize istek atar (dosyayı da size gönderir veya zaten sunucudadır).
  • Sizin Sunucunuz: X-API-KEY ile PrimeAPI’yi çağırır; operationId üretir ve istemciye döner.
  • Güvenlik: API anahtarı tarayıcıya sızmaz; kota/oran sınırlama, loglama ve doğrulama sunucuda yapılır.
curl -X POST "https://app.example.com/api/upload" \
  -H "Content-Type: multipart/form-data" \
  -F "file=@/path/to/document.pdf"

İstemci tarafında X-API-KEY gönderilmez. Chunked upload gerekiyorsa, istemci dosyayı sizin sunucunuza parça parça yükler; sunucunuz da PrimeAPI’nin chunk endpoint’lerini sunucu tarafından çağırır.

Sırada ne var?

Tebrikler, ilk isteğinizi yaptınız. Aşağıdaki bağlantılar PrimeAPI’nin temel parçalarını kapsar:

Kaynaklar:

Was this page helpful?