This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

ONAYLARIM PrimeApi Entegrasyon Dokümantasyonu - Sunucu Katmanı

Bu dokümanda PrimeApi ile entegre olarak web uygulamanıza e-imza atma özelliğinin eklenmesi için gerekli adımlar anlatılır. İstek gönderilecek endpoint adresi ve kullanılması gereken ApiKey bilgisi firma tarafından iletilecektir.

Cades ya da Pades İmza İşlemi İlk Adımı

PrimeApi ile imzalama işlemine başlanacak ilk adımdır. Cades ya da Pades formatta imzalama yapılabilmek için gerekli parametreler ve metot isimleri aşağıdaki gibidir. Oluşacak istekler imza türlerine göre değişiklik gösterir.

CAdES Request (SignStepOneCadesCoreRequest)

{
    // Guid.NewGuid().ToString().Replace("-", "").Substring(0, 21), formatında bir Guid
    "RequestId": "d8aaba7f4928-44ee-827", 

    // Dönen hata mesajlarının hangi dilde dönmesi gerektiğini belirtir, olası değerler en ve tr'dir.   
    "DisplayLanguage": "en", 

    // Son kullanıcı bilgisayarında bulunana e-İmza Aracı vasıtasıyla alınan, e-imza atarken kullanılacak sertifikadır
    "CerBytes": "", 

    // İmzalanacak dosyadır
    "FileData": [],

    // Dosya üzerinde kaçıncı imza olduğu bilgisidir. Dosya üzerinde hiç imza yok ise 0 değeri atanır.
    "SignatureIndex": 0, 

    // Son kullanıcının geolocation bilgisidir. API bu alanı şimdilik kullanmamaktadır. Bu nedenle null olarak atanabilir.
    "Coordinates": null, 

    // Her bir istek için tekil bir GUID değeri verilmelidir. Bu değer aynı e-imza işlemi ile ilgili olarak daha sonraki metodlarda kullanılır.
    "OperationId": "5ee45c97-5e62-4394-9dc9-fa7b70443c86", 
   
}

CAdES Response (SignStepOneCadesCoreResult)

{
    // e-İmza aracına iletilecek, e-imza state'idir.
    "State" : "", 

    //Mevcut e-imza işlemine ait ID değeridir. e-İmza aracına iletilir.
    "KeyAdı" : "",

    //Mevcut e-imza işlemine ait KeySecret değeridir. e-İmza aracına iletilir.
    "KeySecret":"",
}

PAdES Request (SignStepOnePadesCoreRequest)

{
    {
        // Son kullanıcı bilgisayarında bulunana e-İmza Aracı vasıtasıyla alınan, e-imza atarken kullanılacak sertifikadır
        "CerBytes": "Base64EncodedCertificateData",

        // İmzalanacak dosyadır
        "FileData": [],

        // Son kullanıcının geolocation bilgisidir. API bu alanı şimdilik kullanmamaktadır. Bu nedenle null olarak atanabilir.
        "Coordinates": "",

        // Dönen hata mesajlarının hangi dilde dönmesi gerektiğini belirtir, olası değerler en ve tr'dir.   
        "DisplayLanguage": "en", 

        // Guid.NewGuid().ToString().Replace("-", "").Substring(0, 21), formatında bir Guid
        "EequestId": "d8aaba7f4928-44ee-827", 

        // Her bir istek için tekil bir GUID değeri verilmelidir. Bu değer aynı e-imza işlemi ile ilgili olarak daha sonraki metodlarda kullanılır.
        "OperationId": "123e4567-e89b-12d3-a456-426614174000",

        // İmzalanacak doküman üzerinde eklenecek cümleyle ilgili bilgileri içerir
        "VerificationInfo": {

                // Doğrulama cümlesidir. Yeni satır için \r\n değeri girilebilir.
                // Örnek: "Satır 1\r\nSatır2"
                "Text": "Satır 1\r\nSatır 2",

                // İmzalama cümlesi kutusunun sayfa genişliğine oranıdır.
                // Örneğin, sayfa genişliği 1000 olan bir sayfa için 0.8 değeri 800 genişlik oluşturur.
                "Width": 0.8,

                // İmzalama cümlesi kutusunun sayfa yüksekliğine oranıdır.
                // Örneğin, sayfa yüksekliği 1000 olan bir sayfa için 0.1 değeri 100 yükseklik oluşturur.
                "Height": 0.1,

                // İmzalama cümlesi kutusunun sayfanın solundan olan uzaklığıdır.
                // Sayfa genişliği 1000 olan bir sayfa için 0.1 değeri 100 uzaklık oluşturur.
                // Left ve Right aynı anda kullanılmamalıdır; sadece biri kullanılmalıdır.
                "Left": 0.1,

                // İmzalama cümlesi kutusunun sayfanın sağından olan uzaklığıdır.
                // Left ve Right aynı anda kullanılmamalıdır; sadece biri kullanılmalıdır.
                // Örneğin, sağa dayalı olarak kullanmak için bu alanı doldurabilirsiniz.
                "Right": null,

                // İmzalama cümlesi kutusunun sayfanın üstünden olan uzaklığıdır.
                // Sayfa yüksekliği 1000 olan bir sayfa için 0.1 değeri 100 uzaklık oluşturur.
                // Top ve Bottom aynı anda kullanılmamalıdır; sadece biri kullanılmalıdır.
                "Top": 0.1,

                // İmzalama cümlesi kutusunun sayfanın altından olan uzaklığıdır.
                // Top ve Bottom aynı anda kullanılmamalıdır; sadece biri kullanılmalıdır.
                "Bottom": null,

                // İmzalama cümlesi kutusunun lokasyonu için hangi parametrelerin kullanılması gerektiğini belirtir.
                // Örnekler: "left top", "right top"
                "TransformOrigin": "left top"
        },

        // İmzalanacak doküman üzerinde eklenecek QRCode ilgili bilgileri içerir
        "QrCodeInfo": {

                // QR kod içinde yazacak URL bilgisidir
                "Text": "https://example.com",

                // Karekodun genişliğinin sayfa genişliğine oranıdır.
                // Örneğin, sayfa genişliği 1000 olan bir sayfa için 0.8 değeri 800 genişlik oluşturur.
                // Karekodun genişliği ve yüksekliği eşittir.
                "Width": 0.2,

                // Karekodun sayfanın solundan olan uzaklığıdır.
                // Örneğin, sayfa genişliği 1000 olan bir sayfa için 0.1 değeri 100 uzaklık oluşturur.
                // Left ve Right aynı anda kullanılmamalıdır; sadece biri kullanılmalıdır.
                "Left": 0.1,

                // Karekodun sayfanın sağından olan uzaklığıdır.
                // Left ve Right aynı anda kullanılmamalıdır; sadece biri kullanılmalıdır.
                // Örneğin, sağa dayalı olarak kullanmak için bu alanı doldurabilirsiniz.
                "Right": null,

                // Karekodun sayfanın üstünden olan uzaklığıdır.
                // Örneğin, sayfa yüksekliği 1000 olan bir sayfa için 0.1 değeri 100 uzaklık oluşturur.
                // Top ve Bottom aynı anda kullanılmamalıdır; sadece biri kullanılmalıdır.
                "Top": 0.1,

                // Karekodun sayfanın altından olan uzaklığıdır.
                // Top ve Bottom aynı anda kullanılmamalıdır; sadece biri kullanılmalıdır.
                "Bottom": null,

                // Karekodun lokasyonu için hangi parametrelerin kullanılması gerektiğini belirtir.
                // Örnekler: "left top", "right top"
                "TransformOrigin": "left top"
        },

        // Sayfa üzerine eklenecek imza görseli bilgisidir
        "SignatureWidgetInfo": {

                    // İmzanın pixel olarak genişliğidir
                    "Width": 150.0,

                    // İmzanın pixel olarak yüksekliğidir
                    "Height": 75.0,

                    // İmzanın sayfanın solundan olan uzaklığıdır. Left ve Right aynı anda kullanılmamalıdır.
                    // Örneğin, sayfa genişliği 1000 olan bir sayfa için 0.1 değeri 100 uzaklık oluşturur.
                    "Left": 0.1,

                    // İmzanın sayfanın sağından olan uzaklığıdır. Left ve Right aynı anda kullanılmamalıdır.
                    // Örneğin, sağa dayalı olarak kullanmak için bu alanı doldurabilirsiniz.
                    "Right": null,

                    // İmzanın sayfanın üstünden olan uzaklığıdır. Top ve Bottom aynı anda kullanılmamalıdır.
                    // Örneğin, sayfa yüksekliği 1000 olan bir sayfa için 0.1 değeri 100 uzaklık oluşturur.
                    "Top": 0.1,

                    // İmzanın sayfanın altından olan uzaklığıdır. Top ve Bottom aynı anda kullanılmamalıdır.
                    "Bottom": null,

                    // İmzanın lokasyonu için hangi parametrelerin kullanılması gerektiğini belirtir.
                    // Örnekler: "left top", "right top"
                    "TransformOrigin": "left top",

                    // İmza görselinde arka plan olarak kullanılacak imajın datasıdır (Base64 olarak kodlanmış JPG formatında).
                    "ImageBytes": "Base64EncodedImageData",

                    // İmza görselinin hangi sayfalara yerleştirileceği bilgisidir. 0’dan başlar.
                    "PagesToPlaceOn": [0, 2, 4],

                    // İmza görseli içerisinde yazılacak ifadelerdir.
                    "Lines": {

                    // Satır içerisinde yazacak ifadedir
                    "Text": "Örnek İfade",

                    // Satırın sol marjinidir (piksel olarak)
                    "LeftMargin": 10,

                    // Satırın üst marjinidir (piksel olarak)
                    "TopMargin": 5,

                    // Satırın alt marjinidir (piksel olarak)
                    "BottomMargin": 5,

                    // Satırın sağ marjinidir (piksel olarak)
                    "RightMargin": 10,

                    // Satırın hangi font ile yazılacağını belirtir; örneğin, Arial veya Tahoma gibi
                    "FontName": "Arial",

                    // Satırın hangi font büyüklüğü ile yazılacağını belirtir
                    "FontSize": 12.0,

                    // Satırın hangi font tipi ile yazılacağını belirtir. Örnekler: Regular, Bold, Italic, Underline, Strikeout
                    "FontStyle": "Bold",

                    // Satırın hangi renkle yazılacağını belirtir (HTML renk kodu olarak). Örnek: #FF00FF
                    "ColorHtml": "#FF00FF"
                  }
        }
    }   
}

PAdES Response (SignStepOnePadesCoreResult)

{
    // e-İmza aracına iletilecek, e-imza state'idir.
    "State" : "", 

    //Mevcut e-imza işlemine ait ID değeridir. e-İmza aracına iletilir.
    "KeyAdı" : "",

    //Mevcut e-imza işlemine ait KeySecret değeridir. e-İmza aracına iletilir.
    "KeySecret":"",
}

PAdES isteği oluşturulurken VerificationInfo, SignatureWidgetInfo ve QrCodeInfo alanları isteğe bağlıdır. İstek oluşturulurken gönderilmesi zorunlu değildir.

Sunucuya Dosya Yükleme

Büyük dosyaların SignStepOnePadesCore metoduna json içerisinde gönderilmesi mümkün değildir. Bu nedenle, büyük dosyalar imzalanmak istendiğinde, önce SignStepOneUploadFile metodu ile dosya sunucuya yüklenir. Yükleme başarılı ise SignStepOnePadesCore metodu ile işleme devam edilir. Burada önemli olan, her iki metod için de aynı operationId değerini kullanmak gerekir Bu şekilde bir kullanım yapılması durumunda, SignStepOnePadesCoreRequest objesindeki FileData parametresi boş byte array olarak gönderilmelidir.

SignStepOneUploadFile metoduna multipart body olarak yüklenmek istenilen belge gönderilmelidir.

Cades ya da Pades İmza İşlemi Son Adımı

PrimeApi ile sunucu katmanında imzalama için son adımdır. CAdES ve PAdES için oluşturulacak isteklerdeki metot isimleri ve parametler aşağıdaki gibidir.

CAdES Request (SignStepThreeCadesCoreRequest)

{
    // e-İmza aracı tarafından imzalanmış veri
    "SignedData" : "", 

    //Mevcut e-imza işlemine ait ID değeridir. e-İmza aracına iletilir.
    "KeyAdı" : "",

    // Guid.NewGuid().ToString().Replace("-", "").Substring(0, 21), formatında bir Guid
    "requestId": "d8aaba7f4928-44ee-827", 

    //Mevcut e-imza işlemine ait KeySecret değeridir. e-İmza aracına iletilir.
    "KeySecret":"",

    // Her bir istek için tekil bir GUID değeri verilmelidir. Bu değer aynı e-imza işlemi ile ilgili olarak daha sonraki metodlarda kullanılır.
    "OperationId": "5ee45c97-5e62-4394-9dc9-fa7b70443c86",

    // Dönen hata mesajlarının hangi dilde dönmesi gerektiğini belirtir, olası değerler en ve tr'dir.   
    "DisplayLanguage": "en", 
}

CAdES Result (SignStepThreeCadesCoreResult)

{
    // İşlemin başarıyla tamamlanıp tamamlanmadığını gösterir 
    "IsSuccess" : true, 
}

PAdES Request (SignStepThreePadesCoreRequest)

{
    // e-İmza aracı tarafından imzalanmış veri
    "SignedData" : "", 

    //Mevcut e-imza işlemine ait ID değeridir. e-İmza aracına iletilir.
    "KeyAdı" : "",

    // Guid.NewGuid().ToString().Replace("-", "").Substring(0, 21), formatında bir Guid
    "RequestId": "d8aaba7f4928-44ee-827", 

    //Mevcut e-imza işlemine ait KeySecret değeridir. e-İmza aracına iletilir.
    "KeySecret":"",

    // Her bir istek için tekil bir GUID değeri verilmelidir. Bu değer aynı e-imza işlemi ile ilgili olarak daha sonraki metodlarda kullanılır.
    "OperationId": "5ee45c97-5e62-4394-9dc9-fa7b70443c86",

    // İmza işlemi sonrası imzanın LTV'ye upgrade edilip edilmeyeceğini belirler. Belgede N imza olacaksa, 1, 2, 3 ... , N-1 inci imzalar için True, sadece son imza için False gönderilmelidir.
    "DontUpgradeToLtv": true,

    // Dönen hata mesajlarının hangi dilde dönmesi gerektiğini belirtir, olası değerler en ve tr'dir.   
    "DisplayLanguage": "en", 
}

PAdES Response (SignStepThreePadesCoreResult)

{
    // İşlemin başarıyla tamamlanıp tamamlanmadığını gösterir. 
    "IsSuccess" : true, 
}

Moil İmza İşlemleri

PrimeApi ile TURKCELL, VODAFONE ve TURK TELEKOM operatörleri ile mobil imzalama işlemi yapılabilmektedir. Bu işlemleri yapabilmek için kullanılacak metotlar ve metotlardaki parametreler aşağıdaki gibidir.

CAdES Mobil Sign Request (SignStepOneCadesMobileCoreRequest)

{
    // Son kullanıcıya ait e-imza atarken kullanılacak sertifikadır
    "CerBytes" : "" ,

    // İmzalanacak dosyadır
    "FileData" : "" ,

    // Guid.NewGuid().ToString().Replace("-", "").Substring(0, 21), formatında bir Guid
    "RequestId": "d8aaba7f4928-44ee-827", 

    // Dönen hata mesajlarının hangi dilde dönmesi gerektiğini belirtir, olası değerler en ve tr'dir.   
    "DisplayLanguage": "en", 

    // Dosya üzerinde kaçıncı imza olduğu bilgisidir. Dosya üzerinde hiç imza yok ise 0 değeri atanır.
    "SignatureIndex" : ,

    // Son kullanıcının geolocation bilgisidir. API bu alanı şimdilik kullanmamaktadır. Bu nedenle null olarak atanabilir.
    "Coordinates": ,

    // Her bir istek için tekil bir GUID değeri verilmelidir. Bu değer aynı e-imza işlemi ile ilgili olarak daha sonraki metodlarda kullanılır.
    "OperationId": "5ee45c97-5e62-4394-9dc9-fa7b70443c86",

    // İmza atarken kullanılacak mobil imzaya ait telefon numarasıdır. Örnek: 5446786666
    "PhoneNumber" :"5331233212" ,

    // İmza atarken kullanılacak mobil imzaya ait telefon numarasının bağlı olduğu operatördür. Örnek: TURKCELL, VODAFONE, AVEA
    "Operator" : "",

    // İmza atarken kullanıcıya gösterilecek mesaj
    "UserPrompt" : "",

    // Mobil imza sahibi kişinin TC'si verilmesi durumunda, mobil imza sertifikası içindeki TC ile kontrol yapılır. (Opsiyonel)
    "CitizenshipNo" : ""

}

CAdES Mobile Sign Response (SignStepOneCoreInternalForCadesMobileResult)

{
    // İşlemin başarıyla tamamlanıp tamamlanmadığını gösterir. 
    "IsSuccess" : true, 
}

PAdES Mobil Sign Request (SignStepOnePadesMobileCoreRequest)

{
    // Son kullanıcıya ait e-imza atarken kullanılacak sertifikadır
    "CerBytes" : "" ,

    // İmzalanacak dosyadır
    "FileData" : "" ,

    // Guid.NewGuid().ToString().Replace("-", "").Substring(0, 21), formatında bir Guid
    "RequestId": "d8aaba7f4928-44ee-827", 

    // Dönen hata mesajlarının hangi dilde dönmesi gerektiğini belirtir, olası değerler en ve tr'dir.   
    "DisplayLanguage": "en", 

    // Dosya üzerinde kaçıncı imza olduğu bilgisidir. Dosya üzerinde hiç imza yok ise 0 değeri atanır.
    "SignatureIndex" : ,

    // Son kullanıcının geolocation bilgisidir. API bu alanı şimdilik kullanmamaktadır. Bu nedenle null olarak atanabilir.

    "Coordinates": ,

    // Her bir istek için tekil bir GUID değeri verilmelidir. Bu değer aynı e-imza işlemi ile ilgili olarak daha sonraki metodlarda kullanılır.
    "OperationId": "5ee45c97-5e62-4394-9dc9-fa7b70443c86",

    // İmza atarken kullanılacak mobil imzaya ait telefon numarasıdır. Örnek: 5446786666
    "PhoneNumber" :"5331233212" ,

    // İmza atarken kullanılacak mobil imzaya ait telefon numarasının bağlı olduğu operatördür. Örnek: TURKCELL, VODAFONE, AVEA
    "Operator" : "",

    // İmza atarken kullanıcıya gösterilecek mesaj
    "UserPrompt" : "",

    // Mobil imza sahibi kişinin TC'si verilmesi durumunda, mobil imza sertifikası içindeki TC ile kontrol yapılır. (Opsiyonel)
    "CitizenshipNo" : "",

    // İmzalanacak doküman üzerinde eklenecek cümleyle ilgili bilgileri içerir
    "VerificationInfo" : [],

    //İmzalanacak doküman üzerinde eklenecek QRCode ilgili bilgileri içerir
    "QrCodeInfo" : [],

}

PAdES Mobile Sign Response (SignStepOneCoreInternalForPadesMobileResult)

{
    // İşlemin başarıyla tamamlanıp tamamlanmadığını gösterir. 
    "IsSuccess" : true, 
}

İmzalı Dokumanların İndirilmesi

PrimeApi ile imzalanmış dokumanları indirebilirsiniz. Bu işlemi yapacağınız metot ve parametreler aşağıdaki gibidir.

Download File Request (DownloadSignedFileCoreRequest)

{
    // Her bir istek için tekil bir GUID değeri verilmelidir. Bu değer aynı e-imza işlemi ile ilgili olarak daha sonraki metodlarda kullanılır.
    "OperationId": "5ee45c97-5e62-4394-9dc9-fa7b70443c86", 

    // Guid.NewGuid().ToString().Replace("-", "").Substring(0, 21), formatında bir Guid
    "RequestId": "d8aaba7f4928-44ee-827", 

    // Dönen hata mesajlarının hangi dilde dönmesi gerektiğini belirtir, olası değerler en ve tr'dir.   
    "DisplayLanguage": "en", 
}

Download File Response (DownloadSignedFileCoreResult)

{
    // Her bir istek için tekil bir GUID değeri verilmelidir. Bu değer aynı e-imza işlemi ile ilgili olarak daha sonraki metodlarda kullanılır.
    "OperationId": "5ee45c97-5e62-4394-9dc9-fa7b70443c86", 

    // Dosya verisidir.
    "FileData": [], 

    // Dosyanın adıdır.  
    "FileName": "", 
}

PDF'e Dönüştürme

PrimeApi ile Word,Excel,PowerPoint ya da resim dosyalarınızı PDF formatına dönüştürebilirsiniz. Bu işlemi yapabilmek için aşağıdaki metodu ve parametler aşağıdaki gibidir.

ConvertToPdf Request (ConvertToPdfCore)

{
    // Her bir istek için tekil bir GUID değeri verilmelidir. Bu değer aynı e-imza işlemi ile ilgili olarak daha sonraki metodlarda kullanılır.
    "OperationId": "5ee45c97-5e62-4394-9dc9-fa7b70443c86", 

    // Guid.NewGuid().ToString().Replace("-", "").Substring(0, 21), formatında bir Guid
    "RequestId": "d8aaba7f4928-44ee-827", 

    // Dönen hata mesajlarının hangi dilde dönmesi gerektiğini belirtir, olası değerler en ve tr'dir.   
    "DisplayLanguage": "en", 

    // Dönüştürülecek dosya verisidir
    "FileData": [], 

    // Dönüştürülecek dosya adıdır 
    "FileName": "", 
}

ConvertToPdf Response (ConvertToPdfCoreResult)

{
   
    // Dönüştürülen dosya verisidir
    "FileData": []

}

PDF Dosyasına QR eklenmesi

PrimeApi ile bir PDF dosyasına doğrulama cümlesi ve karekod basabilirsiniz. Bu işlemi yapmak için gerekli metot ve parametreler aşağıdaki gibidir.

AddLayer Request (AddLayersCoreRequest)

{
    // Her bir istek için tekil bir GUID değeri verilmelidir. Bu değer aynı e-imza işlemi ile ilgili olarak daha sonraki metodlarda kullanılır.
    "OperationId": "5ee45c97-5e62-4394-9dc9-fa7b70443c86", 

    // Guid.NewGuid().ToString().Replace("-", "").Substring(0, 21), formatında bir Guid
    "RequestId": "d8aaba7f4928-44ee-827", 

    // Dönen hata mesajlarının hangi dilde dönmesi gerektiğini belirtir, olası değerler en ve tr'dir.   
    "DisplayLanguage": "en", 

    // Üzerine layer eklenecek dosya verisidir
    "FileData": [], 

    // Üzerine layer eklenecek dosya adıdır
    "FileName": "", 

    // Doküman üzerinde eklenecek QRCode ilgili bilgileri içerir
    "QrCodeInfo": {

                // QR kod içinde yazacak URL bilgisidir
                "Text": "https://example.com",

                // Karekodun genişliğinin sayfa genişliğine oranıdır.
                // Örneğin, sayfa genişliği 1000 olan bir sayfa için 0.8 değeri 800 genişlik oluşturur.
                // Karekodun genişliği ve yüksekliği eşittir.
                "Width": 0.2,

                // Karekodun sayfanın solundan olan uzaklığıdır.
                // Örneğin, sayfa genişliği 1000 olan bir sayfa için 0.1 değeri 100 uzaklık oluşturur.
                // Left ve Right aynı anda kullanılmamalıdır; sadece biri kullanılmalıdır.
                "Left": 0.1,

                // Karekodun sayfanın sağından olan uzaklığıdır.
                // Left ve Right aynı anda kullanılmamalıdır; sadece biri kullanılmalıdır.
                // Örneğin, sağa dayalı olarak kullanmak için bu alanı doldurabilirsiniz.
                "Right": null,

                // Karekodun sayfanın üstünden olan uzaklığıdır.
                // Örneğin, sayfa yüksekliği 1000 olan bir sayfa için 0.1 değeri 100 uzaklık oluşturur.
                // Top ve Bottom aynı anda kullanılmamalıdır; sadece biri kullanılmalıdır.
                "Top": 0.1,

                // Karekodun sayfanın altından olan uzaklığıdır.
                // Top ve Bottom aynı anda kullanılmamalıdır; sadece biri kullanılmalıdır.
                "Bottom": null,

                // Karekodun lokasyonu için hangi parametrelerin kullanılması gerektiğini belirtir.
                // Örnekler: "left top", "right top"
                "TransformOrigin": "left top"
        },

    // İmzalanacak doküman üzerinde eklenecek cümleyle ilgili bilgileri içerir
    "VerificationInfo": {

                // Doğrulama cümlesidir. Yeni satır için \r\n değeri girilebilir.
                // Örnek: "Satır 1\r\nSatır2"
                "Text": "Satır 1\r\nSatır 2",

                // İmzalama cümlesi kutusunun sayfa genişliğine oranıdır.
                // Örneğin, sayfa genişliği 1000 olan bir sayfa için 0.8 değeri 800 genişlik oluşturur.
                "Width": 0.8,

                // İmzalama cümlesi kutusunun sayfa yüksekliğine oranıdır.
                // Örneğin, sayfa yüksekliği 1000 olan bir sayfa için 0.1 değeri 100 yükseklik oluşturur.
                "Height": 0.1,

                // İmzalama cümlesi kutusunun sayfanın solundan olan uzaklığıdır.
                // Sayfa genişliği 1000 olan bir sayfa için 0.1 değeri 100 uzaklık oluşturur.
                // Left ve Right aynı anda kullanılmamalıdır; sadece biri kullanılmalıdır.
                "Left": 0.1,

                // İmzalama cümlesi kutusunun sayfanın sağından olan uzaklığıdır.
                // Left ve Right aynı anda kullanılmamalıdır; sadece biri kullanılmalıdır.
                // Örneğin, sağa dayalı olarak kullanmak için bu alanı doldurabilirsiniz.
                "Right": null,

                // İmzalama cümlesi kutusunun sayfanın üstünden olan uzaklığıdır.
                // Sayfa yüksekliği 1000 olan bir sayfa için 0.1 değeri 100 uzaklık oluşturur.
                // Top ve Bottom aynı anda kullanılmamalıdır; sadece biri kullanılmalıdır.
                "Top": 0.1,

                // İmzalama cümlesi kutusunun sayfanın altından olan uzaklığıdır.
                // Top ve Bottom aynı anda kullanılmamalıdır; sadece biri kullanılmalıdır.
                "Bottom": null,

                // İmzalama cümlesi kutusunun lokasyonu için hangi parametrelerin kullanılması gerektiğini belirtir.
                // Örnekler: "left top", "right top"
                "TransformOrigin": "left top"
        }

}

AddLayer Response (AddLayersCoreResult)

{
   
    // Üzerine layer eklenmiş dosya verisidir
    "FileData": []

}

İmzalı Belgelerin Zenginleştirilmesi

PrimeApi ile daha önceden CAdES ya da PAdES imza atılmış belgeleri imza tiplerini ESA tipine dönüştürebilirsiniz. Bu işlemi aşağıdaki metot ve parametlere ile yapalirsiniz Bu metot kullanılmadan önce tavsiye edilen işlem SignStepOneUploadFile metodu ile dosyanın sunucuya yüklenmesidir.

UpgradeCades Request (UpgradePadesCoreRequest)

{
   
    // Her bir istek için tekil bir GUID değeri verilmelidir. Bu değer aynı e-imza işlemi ile ilgili olarak daha sonraki metodlarda kullanılır.
    //Burada SignStepOneUploadFile isteği oluşturulmuş ise OperationId değeri SignStepOneUploadFile metotdan dönen operationId değeri olacaktır.
    "OperationId": "5ee45c97-5e62-4394-9dc9-fa7b70443c86", 

    // Guid.NewGuid().ToString().Replace("-", "").Substring(0, 21), formatında bir Guid
    "RequestId": "d8aaba7f4928-44ee-827", 

    // Dönen hata mesajlarının hangi dilde dönmesi gerektiğini belirtir, olası değerler en ve tr'dir.   
    "DisplayLanguage": "en", 

}

UpgradeCades Response (UpgradeCadesCoreResult)

{
    // İşlemin başarıyla tamamlanıp tamamlanmadığını gösterir. 
    "IsSuccess" : true, 
}

UpgradePades Request (UpgradePadesCoreRequest)

{
   
    // Her bir istek için tekil bir GUID değeri verilmelidir. Bu değer aynı e-imza işlemi ile ilgili olarak daha sonraki metodlarda kullanılır.
    //Burada SignStepOneUploadFile isteği oluşturulmuş ise OperationId değeri SignStepOneUploadFile metotdan dönen operationId değeri olacaktır.
    "OperationId": "5ee45c97-5e62-4394-9dc9-fa7b70443c86", 

    // Guid.NewGuid().ToString().Replace("-", "").Substring(0, 21), formatında bir Guid
    "RequestId": "d8aaba7f4928-44ee-827", 

    // Dönen hata mesajlarının hangi dilde dönmesi gerektiğini belirtir, olası değerler en ve tr'dir.   
    "DisplayLanguage": "en", 

}

UpgradePades Response (UpgradePadesCoreResult)

{
    // İşlemin başarıyla tamamlanıp tamamlanmadığını gösterir. 
    "IsSuccess" : true, 
}

Son Bilgilendirme

Yapılacak olan tüm geliştirmeler için GitHub üzerinden örnek projeler ile yardımcı doküman sağlanacaktır bu nedenle PrimeApi ile uygulamanıza 1 gün gibi kısa bir sürede elektronik imza özelliği kazandırmış olacaksınız.