CoreApiPadesMobile (v4.0)

CoreApiPadesMobile V4, mobil imza operatörleri (Turkcell/Vodafone/AVEA) üzerinden PAdES imzalama işlemini başlatır. V2'ye kıyasla Baseline seviyeler (B-B, B-T, B-LT, B-LTA) ve profil desteği (sadece P4) sunulur. Mobil imzada işlem tek adımda tamamlanır; ayrı bir "signStepThree" adımı yoktur.

Temel kavramlar

  • OperationId: İmzalanacak PDF dosyasını temsil eden işlem kimliği. Önceki adımlardan (dosya yükleme) elde edilir.
  • Profiller: PAdES'te yalnızca P4 (OCSP tabanlı) ve None (profilsiz) desteklenir.
  • Auth: Tüm uç noktalar ApiKey gerektirir.
  • Zarf: Tüm yanıtlar ApiResult<T> tipindedir:
    • result: T
    • error: string (hata durumunda dolar)

Enum: SignatureLevelForPadesV4

DeğerKodAçıklama
BB1PAdES Baseline-B
BT2PAdES Baseline-T — Zaman damgalı
BLT3PAdES Baseline-LT — Uzun vadeli doğrulama bilgisi
BLTA4PAdES Baseline-LTA — Arşiv zaman damgalı

Enum: PadesProfileV4

DeğerKodAçıklamaGeçerli SeviyelerRevocation
None0Profil yokBB—
P44EPES + BLT/BLTA, ÇİSDuP (OCSP)BLT, BLTAOCSP

Not: PAdES'te P1, P2, P3 profilleri desteklenmez; yalnızca None ve P4 kullanılabilir.

POST/v4/CoreApiPadesMobile/SignStepOnePadesMobileCore

SignStepOnePadesMobileCore — Mobil imzayı başlat

Mobil imza işlemini başlatır. İşlem sırasında operatör ile iletişim kurulur ve parmak izi (fingerprint) üretilir. İstemci bu fingerprint'i CoreApiFingerPrint ile sorgulayabilir.

Gerekli/opsiyonel alanlar

  • Name
    operationId
    Type
    uuid
    Description

    İmzalanacak PDF dosyasının işlem kimliği (önceki adımdan elde edilir).

  • Name
    phoneNumber
    Type
    string
    Description

    Mobil imza telefon numarası (örn. 5XXXXXXXXX).

  • Name
    operator
    Type
    string
    Description

    Operatör adı (TURKCELL | VODAFONE | AVEA).

  • Name
    userPrompt
    Type
    string
    Description

    Kullanıcıya gösterilecek mesaj.

  • Name
    citizenshipNo
    Type
    string?
    Description

    (Opsiyonel) İmza sahibinin TCKN doğrulaması için.

  • Name
    signatureLevel
    Type
    SignatureLevelForPadesV4
    Description

    PAdES imza seviyesi. Olası değerler: BB, BT, BLT, BLTA.

  • Name
    profile
    Type
    PadesProfileV4
    Description

    İmza profili. Olası değerler: None, P4.

  • Name
    requestId
    Type
    string
    Description

    21 karakter uzunluğunda benzersiz bir string. Her istek için farklı olmalıdır.

  • Name
    displayLanguage
    Type
    string
    Description

    Dil tercihi (ör. "tr").

Not: PAdES mobile V4'te serialOrParallel ve signaturePath alanları bulunmaz. PAdES imzaları her zaman paralel olarak eklenir.

Request

POST
/v4/CoreApiPadesMobile/SignStepOnePadesMobileCore
curl -X POST "https://apitest.onaylarim.com/v4/CoreApiPadesMobile/SignStepOnePadesMobileCore" \
  -H "X-API-KEY: {api_key}" \
  -H "Content-Type: application/json" \
  -d '{
        "operationId": "11111111-1111-1111-1111-111111111111",
        "phoneNumber": "5XXXXXXXXX",
        "operator": "TURKCELL",
        "userPrompt": "İmzalamayı onaylıyor musunuz?",
        "citizenshipNo": null,
        "signatureLevel": 1,
        "profile": 0,
        "requestId": "aaaaaaaaaaaaaaaaaaaaa",
        "displayLanguage": "tr"
      }'

Response

{
  "result": {
    "isSuccess": true,
    "operationId": "22222222-2222-2222-2222-222222222222"
  },
  "error": null
}

Örnek akış (PAdES Mobile V4)

  1. PDF dosya yükleme: CoreApiFile/UploadFile veya parça/parça: ChunkInit → ChunkUpload → ChunkComplete
  2. v4/CoreApiPadesMobile/SignStepOnePadesMobileCore → mobil operatör akışı başlatılır, fingerprint üretilir (yeni operationId gelebilir).
  3. (Opsiyonel) CoreApiFingerPrint/GetFingerPrintCore ile operationId üzerinden fingerprint alınır ve kullanıcıya gösterilir.
  4. Operatör onayı sonrası imzalama tamamlanır; ek bir adım gerekmez.
  5. CoreApiFile/DownloadCore ile imzalı PDF indirilir.

V2'den V4'e geçiş

Endpoint değişiklik özeti

AmaçV2 endpointV4 endpoint
Mobil imzayı başlatPOST /v2/CoreApiPadesMobile/SignStepOnePadesMobileCorePOST /v4/CoreApiPadesMobile/SignStepOnePadesMobileCore

V2 → V4 request alanı dönüşümleri

  • V2'de vardı, V4'te kaldırıldı
    • coordinates: V4'te bu alan kaldırılmıştır.
    • signatureTurkishProfile: Yerine profile (enum) kullanılır.
    • signatureLevel (string): V4'te sayısal enum'a dönüştürüldü.
  • V4'te yeni
    • profile: Enum tabanlı profil seçimi (None=0, P4=4).
    • signatureLevel: Yeni Baseline enum (BB=1, BT=2, BLT=3, BLTA=4).
  • Aynı kalanlar
    • operationId, phoneNumber, operator, userPrompt, citizenshipNo, requestId, displayLanguage

Notlar

  • URL prefix: /v2/ → /v4/ olarak güncelleyin.
  • signatureLevel: V2'de string ("BES"), V4'te Baseline enum (BB=1, BT=2, BLT=3, BLTA=4). Her iki format da kabul edilir.
  • Profil: V2'de signatureTurkishProfile (string), V4'te profile (enum). PAdES'te yalnızca None ve P4 geçerlidir.

Was this page helpful?