PKIsigning (Önizleme)
PKIsigning platform bağlayıcısı ile belge imzalama gereksinimlerinizi otomatikleştirin. BELGELERI PKIsigning platformuna gönderme; davet gönderin ve imzalı belgeleri alın.
Bu bağlayıcı aşağıdaki ürün ve bölgelerde kullanılabilir:
| Hizmet | Class | Bölgeler |
|---|---|---|
| Copilot Studio | Premium | Aşağıdakiler dışında tüm Power Automate bölgeleri : - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| Logic Apps | Standart | Aşağıdakiler dışında tüm Logic Apps bölgeleri : - Azure Kamu bölgeleri - Azure Çin bölgeleri - ABD Savunma Bakanlığı (DoD) |
| Power Apps | Premium | Aşağıdakiler dışında tüm Power Apps bölgeleri : - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| Power Automate | Premium | Aşağıdakiler dışında tüm Power Automate bölgeleri : - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| İletişim | |
|---|---|
| İsim | PKIsigning desteği |
| URL | https://pkisigning.nl/support |
| E-posta | support@pkisigning.nl |
| Bağlayıcı Meta Verileri | |
|---|---|
| Publisher | SBRS B.V. |
| Web sitesi | https://pkisigning.nl |
| Gizlilik ilkesi | https://pkisigning.nl/privacy |
| Kategoriler | Işbirliği; Verimli -lik |
PKIsigning, kuruluşların belgeleri onaylama, imzalama ve müşterilere ve üçüncü taraflara gönderme sürecini otomatikleştirmesine, basitleştirmesine ve güvenliğini sağlamasına olanak tanır. Platform, Felemenkçe Nitelikli Güvenilen Hizmet Sağlayıcılarının tüm eIDAS kişisel imzalama sertifikalarını destekler ve ISO27001 sertifikalıdır. Bu, PKIsigning'in yasal, finans ve sağlık kuruluşları ve hükümetler için ideal bir ortak olmasını sağlar. Belge imzalama işleminizi otomatikleştirmek, basitleştirmek ve güvenliğini sağlamak için PKisigning ile bağlantı kurun.
Önkoşullar
PKIsigning bağlayıcısını kullanmak için, "profesyonel" bir abonelik içinde PKIsigning platformuna bir hesap gerekir. Ücretli aboneliğe kaydolmak için lütfen PKIsigning ile iletişime geçin .
Kimlik bilgilerini alma
Aboneliğe kaydolan kullanıcılar, hesap ayarlama daveti içeren bir e-posta alır. Kaydoldıktan sonra, bu hesap doğrudan bu bağlayıcıyla kullanılabilir.
Bağlayıcınızı kullanmaya başlama
Belgeleri imzalamaya başlamak için varsayılan akış aşağıdaki gibidir:
- Dosya oluşturma
- Belge ekleme
- Aktör ekleme
- İş akışını başlat
- Durum değişiklikleri hakkında bildirim almak için tetikleyici kullanma
- Dosya indirme
Dosyaları
PKIsigning her zaman önce bir dosya oluşturucu oluşturmanızı bekler. Dosyalayıcı, belgeler ve aktörler için kapsayıcı görevi görür. Dossiers_Create eylemiyle bir dossier oluşturulabilir. Bir dossier oluşturulduktan sonra, gelecekteki eylemler için başvuru olarak lütfen döndürülen PkisId değerini kullanın.
Documents
Dosya oluşturulduktan sonra doğru dossierId değerini kullanarak Documents_Add eylemine sahip belgeler ekleyebilirsiniz. Eylem, belge dosyalarının dikkati dağıldığından başka parametreye ihtiyaç duymaz. Dosyalayıcıdaki belge sayısı için bir sınır yoktur. Eklenen tüm aktörler için tüm belgeler görüntülenebilir ve indirilebilir olacaktır.
Önemli: İmzanın nereye ve hangi aktöre göre yerleştirilmesi gerektiğini belirtmek için, belgenin imza sayısına bağlı olarak bir veya daha fazla benzersiz metin yer tutucusunun olması gerekir. Bu, belgedeki herhangi bir yerdeki herhangi bir metin olabilir. Aktör eklerken yer tutucuyu yer tutucu parametresiyle tanımlayabilirsiniz. Örneğin: signature1, signature2 vb...
Actors
Üçüncü adım, belgelere aktör eklemektir. Bu, doğru dossierId ve documentId kullanılarak Actor_Create Eylemi ile yapılır.
İş akışını başlat
bir iş akışı başlatmak ve belgeleri sağlanan sırayla imzalamak veya indirmek için tüm aktörlere etkin bir şekilde davet göndermek için doğru dossierId ile Dossiers_StartWorkflow eylemini kullanın.
Durum değişiklikleri hakkında bildirim almak için tetikleyici kullanma
Belge imzalandıktan sonra almak için tetikleyici kullanarak bildirimlere abone olun. Durum bildirimi almak için Olaylar alanında 'status' değerini belirtin.
Dosya indirme
Tetikleyiciye durum güncelleştirmesi bildirildiğinde, belgenin durumunun 'Tamamlandı' olup olmadığını denetleyin. Bu andan itibaren dosyadaki tüm belgeleri tek bir zipfile içinde indirmek mümkündür. PKIsigning platformundaki ayarlarda bir denetim tetkiki oluşturulması gerektiği belirtilirse, bu da dahil edilir.
Bilinen sorunlar ve sınırlamalar
Yayın sırasında hiçbir sorun bilinmez.
Yaygın hatalar ve çözümler
Tetikleyici aracılığıyla durum güncelleştirmesi yok
Tetikleyici durum güncelleştirmelerine yanıt vermiyorsa lütfen Olaylar alanında 'status' değerinin sağlandığını denetleyin.
HTTP hatası 402 Ödeme Gerekiyor
PKIsigning platformu eylemleri gerçekleştirmek için kredi gerektirdi. Aktörler eklendiğinde, eylemin gerçekleşebilmesini ve davetlilerin kullanılabilir kredi sayısının yetersizliğiyle ilgili sorunlarla karşılaşmamasını sağlamak için krediler ayrılır. Aktörlere çok fazla davet gönderilirse, kredi paketinde ayrılacak kredi kalmadığı ortaya çıkabilir. O anda bir HTTP 402 hatası döndürülür.
Bu sorunu çözmek için kredi bakiyesini artırmaya yönelik PKIsigning desteği veya platformdaki geri dönüşüm kutusundaki aktörlerle ilgili olmayan tüm dosya bileşenlerini temizleme desteği. Kullanılmayan krediler yeniden kullanılabilir hale gelir.
FAQ
Lütfen bilgi bankamıza bakın veya adresinden bizimle iletişime geçin support@pkisigning.nl
Azaltma Sınırları
| Name | Çağrılar | Yenileme Dönemi |
|---|---|---|
| Bağlantı başına API çağrıları | 100 | 60 saniye |
Eylemler
| Aktör oluşturma |
Yeni bir aktör oluşturur ve bunu belgeye ekler. |
| Aktör verilerini alma |
Belirli bir aktöre ilişkin tüm verileri döndürür. |
| Aktörü güncelleştirme |
Belirli bir aktörün verilerini değiştirir. |
| Aktörü sil |
Belirli bir aktörü kalıcı olarak siler. |
| Belge oluşturma |
Yeni bir belge oluşturur ve belirli bir isteğe ekler. |
| Belge verilerini alma |
Belirli bir belgenin tüm (meta) verilerini döndürür. |
| Belgeye göre aktör verileri alma |
Belirli bir belge için tüm aktörlerin tüm verilerini döndürür. |
| Belgeyi güncelleştirme |
Belirli bir belgenin verilerini değiştirir. |
| Belgeyi sil |
Belirli bir belgeyi kalıcı olarak siler. |
| Daveti geri alma |
Belirli bir istek için geçerli aktörün davetini geri alır. |
| Daveti yeniden gönder |
Belirli bir istek için geçerli aktörün davetini satır içinde yeniden gönderin. |
| İndirme isteği |
İstekleri ve içeriğini .zip dosyası olarak indirir. |
| İstek gönder |
İş akışını başlatır ve belirli bir istek doğrultusunda ilk aktöre bir davet gönderir. |
| İstek oluşturma |
Yeni bir istek oluşturun. |
| İstek verilerini alma |
Belirli bir istek için tüm (meta) verileri döndürür. |
| İsteğe göre aktör verilerini alma |
Belirli bir istek için tüm aktörlerin tüm verilerini döndürür. |
| İsteği güncelleştirme |
Belirli bir isteğin verilerini değiştirir. |
| İsteği silme |
Belirli bir isteği kalıcı olarak siler. |
| Kullanıcı için çalışma grupları alma |
Belirli bir kuruluşun belirli bir kullanıcısının tüm çalışma gruplarının listesini döndürür. |
| Organizasyon için çalışma grupları alma |
Belirli bir kuruluşun tüm çalışma gruplarının listesini döndürür. |
Aktör oluşturma
Yeni bir aktör oluşturur ve bunu belgeye ekler.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Talep Kimliği
|
requestId | True | guid |
İsteğin benzersiz kimliği. |
|
Belge Kimliği
|
documentId | True | guid |
Belgenin benzersiz kimliği. |
|
Eylem
|
action | True | string |
Aktörün gerçekleştirmesi gereken eylem. |
|
İsim
|
firstname | True | string |
Aktörün adı. |
|
Önek
|
prefix | string |
Aktörün ön eki. |
|
|
Soyadı
|
lastname | True | string |
Aktörün soyadı. |
|
E-posta adresi
|
True | string |
Aktörün e-posta adresi. |
|
|
Cep telefonu numarası
|
mobile | True | string |
Aktörün cep telefonu numarası. |
|
Deadline
|
deadline | True | date-time |
Eylemin aktör tarafından gerçekleştirilmesi gereken tarih ve saat. |
|
Language
|
language | True | string |
Davetin dili. |
|
Güçlü doğrulamayı kullanma
|
validateRealIdentity | True | boolean |
Bu aktör için daha güçlü bir tanımlama yöntemi kullanın. |
|
dossierPersonId
|
dossierPersonId | integer | ||
|
message
|
message | string | ||
|
İmzalama alanı
|
fieldName | string |
Bu aktörün imzalaması için belgede var olan bir imzalama alanının adı. |
|
|
Placeholder
|
placeholder | string |
Belgede, aktörün imza yerleştirmesi gereken belirli bir yer tutucunun metni. |
Döndürülenler
- Body
- ExtendedSignerModel
Aktör verilerini alma
Belirli bir aktöre ilişkin tüm verileri döndürür.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Talep Kimliği
|
requestId | True | guid |
İsteğin benzersiz kimliği. |
|
Belge Kimliği
|
documentId | True | guid |
Belgenin benzersiz kimliği. |
|
Aktör Kimliği
|
actorId | True | guid |
Aktörün benzersiz kimliği. |
Döndürülenler
- Body
- ExtendedSignerModel
Aktörü güncelleştirme
Belirli bir aktörün verilerini değiştirir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Talep Kimliği
|
requestId | True | guid |
İsteğin benzersiz kimliği. |
|
Belge Kimliği
|
documentId | True | guid |
Belgenin benzersiz kimliği. |
|
Aktör Kimliği
|
actorId | True | guid |
Aktörün benzersiz kimliği. |
|
Eylem
|
action | True | string |
Aktörün gerçekleştirmesi gereken eylem. |
|
İsim
|
firstname | True | string |
Aktörün adı. |
|
Önek
|
prefix | string |
Aktörün ön eki. |
|
|
Soyadı
|
lastname | True | string |
Aktörün soyadı. |
|
E-posta adresi
|
True | string |
Aktörün e-posta adresi. |
|
|
Cep telefonu numarası
|
mobile | True | string |
Aktörün cep telefonu numarası. |
|
Deadline
|
deadline | True | date-time |
Eylemin aktör tarafından gerçekleştirilmesi gereken tarih ve saat. |
|
Language
|
language | True | string |
Davetin dili. |
|
Güçlü doğrulamayı kullanma
|
validateRealIdentity | True | boolean |
Bu aktör için daha güçlü bir tanımlama yöntemi kullanın. |
|
dossierPersonId
|
dossierPersonId | integer | ||
|
message
|
message | string |
Döndürülenler
- Body
- ExtendedSignerModel
Aktörü sil
Belirli bir aktörü kalıcı olarak siler.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Talep Kimliği
|
requestId | True | guid |
İsteğin benzersiz kimliği. |
|
Belge Kimliği
|
documentId | True | guid |
Belgenin benzersiz kimliği. |
|
Aktör Kimliği
|
actorId | True | guid |
Aktörün benzersiz kimliği. |
Belge oluşturma
Yeni bir belge oluşturur ve belirli bir isteğe ekler.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Talep Kimliği
|
requestId | True | guid |
Bu belgenin ait olacağı isteğin benzersiz kimliği. |
|
Dosya
|
file | True | file |
İşlenecek dosya (yalnızca belirli dosya türleri). |
Döndürülenler
Belgenin genel meta verileri
Belge verilerini alma
Belirli bir belgenin tüm (meta) verilerini döndürür.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Talep Kimliği
|
requestId | True | guid |
İsteğin benzersiz kimliği. |
|
Belge Kimliği
|
documentId | True | guid |
Belgenin benzersiz kimliği. |
Döndürülenler
Belgenin genel meta verileri
Belgeye göre aktör verileri alma
Belirli bir belge için tüm aktörlerin tüm verilerini döndürür.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Talep Kimliği
|
requestId | True | guid |
İsteğin benzersiz kimliği. |
|
Belge Kimliği
|
documentId | True | guid |
Belgenin benzersiz kimliği. |
|
Eylem tamamlandı
|
hasActed | boolean |
Yalnızca eylemlerini tamamlamış veya tamamlamamış aktörleri döndürür, tüm aktörleri döndürmek için boş bırakın. |
Döndürülenler
- response
- array of ExtendedSignerModel
Belgeyi güncelleştirme
Belirli bir belgenin verilerini değiştirir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Talep Kimliği
|
requestId | True | guid |
İsteğin benzersiz kimliği. |
|
Belge Kimliği
|
documentId | True | guid |
Belgenin benzersiz kimliği. |
|
Belge adı
|
name | string |
Belirli bir belgenin adı |
|
|
Belge dosyası adı
|
filename | string |
Belirli bir belge için dosya adı |
|
|
Belge türü
|
documentType | True | string |
Belirli bir belgenin türü. (Ör. Normal PDF, mali beyan, denetçi raporu vb.). |
Döndürülenler
Belgenin genel meta verileri
Belgeyi sil
Belirli bir belgeyi kalıcı olarak siler.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Talep Kimliği
|
requestId | True | guid |
İsteğin benzersiz kimliği. |
|
Belge Kimliği
|
documentId | True | guid |
Belgenin benzersiz kimliği. |
Daveti geri alma
Belirli bir istek için geçerli aktörün davetini geri alır.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Talep Kimliği
|
requestId | True | guid |
İsteğin benzersiz kimliği. |
Daveti yeniden gönder
Belirli bir istek için geçerli aktörün davetini satır içinde yeniden gönderin.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Talep Kimliği
|
requestId | True | guid |
İsteğin benzersiz kimliği. |
İndirme isteği
İstekleri ve içeriğini .zip dosyası olarak indirir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Talep Kimliği
|
requestId | True | guid |
İsteğin benzersiz kimliği. |
Döndürülenler
- response
- file
İstek gönder
İş akışını başlatır ve belirli bir istek doğrultusunda ilk aktöre bir davet gönderir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Talep Kimliği
|
requestId | True | guid |
İsteğin benzersiz kimliği. |
İstek oluşturma
Yeni bir istek oluşturun.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
İstek adı
|
name | True | string |
Belirli bir isteğin adı. |
|
Çalışma Grubu Kimliği
|
workgroupId | guid |
Çalışma grubunun benzersiz kimliği. |
|
|
Güvenlik izni düzeyi
|
clearancelevel | True | integer |
Belirli bir istek için güvenlik izni düzeyi. |
|
İstek sahibi
|
owner |
Belirli bir isteğin sahibi olan kullanıcı. |
Döndürülenler
- Body
- RequestModel
İstek verilerini alma
Belirli bir istek için tüm (meta) verileri döndürür.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Talep Kimliği
|
requestId | True | guid |
İsteğin benzersiz kimliği. |
|
Kimlik doğrulama anahtarı
|
callbackAuthenticationKey | string |
Tetikleyici tarafından sağlanan kimlik doğrulama anahtarı. |
Döndürülenler
- Body
- RequestModel
İsteğe göre aktör verilerini alma
Belirli bir istek için tüm aktörlerin tüm verilerini döndürür.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Talep Kimliği
|
requestId | True | guid |
İsteğin benzersiz kimliği. |
|
Aktör istek üzerine harekete geçti mi?
|
hasActed | boolean |
Bir aktörün belge üzerinde zaten işlem yapmış olup olmadığını denetlemek için salt okunur değer. |
Döndürülenler
- response
- array of ExtendedSignerModel
İsteği güncelleştirme
Belirli bir isteğin verilerini değiştirir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Talep Kimliği
|
requestId | True | guid |
İsteğin benzersiz kimliği. |
|
İstek adı
|
name | True | string |
Belirli bir isteğin adı. |
|
Çalışma Grubu Kimliği
|
workgroupId | guid |
Çalışma grubunun benzersiz kimliği. |
|
|
Güvenlik izni düzeyi
|
clearancelevel | True | integer |
Belirli bir istek için güvenlik izni düzeyi. |
|
İstek sahibi
|
owner |
Belirli bir isteğin sahibi olan kullanıcı. |
Döndürülenler
- Body
- RequestModel
İsteği silme
Belirli bir isteği kalıcı olarak siler.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Talep Kimliği
|
requestId | True | guid |
İsteğin benzersiz kimliği. |
Kullanıcı için çalışma grupları alma
Belirli bir kuruluşun belirli bir kullanıcısının tüm çalışma gruplarının listesini döndürür.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Kuruluş Kimliği
|
organisationId | True | guid |
Bir kuruluşun benzersiz kimliği. |
|
Kullanıcı adı
|
username | True |
Kullanıcının e-posta adresi |
Döndürülenler
- response
- array of OrganisationWorkgroup
Organizasyon için çalışma grupları alma
Belirli bir kuruluşun tüm çalışma gruplarının listesini döndürür.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Kuruluş Kimliği
|
organisationId | True | guid |
Bir kuruluşun benzersiz kimliği. |
Döndürülenler
- response
- array of OrganisationWorkgroup
Tetikleyiciler
| İstekte bir olay oluştuğunda |
Bir durum değişikliğinde geri çağırma için bir URL kaydedin. PKIsigning platformu, bu kuruluş içindeki dosya sağlayıcılarının durum güncelleştirmelerini bu URL'ye bildirecektir. |
İstekte bir olay oluştuğunda
Bir durum değişikliğinde geri çağırma için bir URL kaydedin. PKIsigning platformu, bu kuruluş içindeki dosya sağlayıcılarının durum güncelleştirmelerini bu URL'ye bildirecektir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Olay tipleri
|
Events | True | array of string |
Bu tetikleyicinin bildirileceği bir istekte gerçekleşen olay türlerinin listesi |
|
Kuruluş Kimliği
|
organisationId | True | guid |
Bir kuruluşun benzersiz kimliği. |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Talep Kimliği
|
PkisId | guid |
İsteğin benzersiz kimliği. |
|
İstek durumu
|
DossierStatus | string |
Dosyasının durumu. |
|
Reason
|
Reason | string |
Değişikliğin nedeni. |
|
Kimlik doğrulama anahtarı
|
AuthenticationKey | string |
İstekte meta verileri almak için üst bilgi. |
Tanımlar
ExtendedSignerModel
| Name | Yol | Tür | Description |
|---|---|---|---|
|
İmzalama alanı
|
fieldName | string |
Bu aktörün imzalaması için belgede var olan bir imzalama alanının adı. |
|
Placeholder
|
placeholder | string |
Belgede, aktörün imza yerleştirmesi gereken belirli bir yer tutucunun metni. |
|
Eylem
|
action | string |
Aktörün gerçekleştirmesi gereken eylem. |
|
İsim
|
firstname | string |
Aktörün adı. |
|
Önek
|
prefix | string |
Aktörün ön eki. |
|
Soyadı
|
lastname | string |
Aktörün soyadı. |
|
E-posta adresi
|
string |
Aktörün e-posta adresi. |
|
|
Cep telefonu numarası
|
mobile | string |
Aktörün cep telefonu numarası. |
|
Deadline
|
deadline | date-time |
Eylemin aktör tarafından gerçekleştirilmesi gereken tarih ve saat. |
|
Language
|
language | string |
Davetin dili. |
|
Güçlü doğrulamayı kullanma
|
validateRealIdentity | boolean |
Bu aktör için daha güçlü bir tanımlama yöntemi kullanın. |
|
dossierPersonId
|
dossierPersonId | integer | |
|
message
|
message | string | |
|
Aktör Kimliği
|
id | guid |
Belirli bir aktörün benzersiz kimliği. |
|
Tamamlanma tarihi
|
signingDate | date-time |
Aktörün eylemini gerçekleştirdiği tarih ve saat. |
|
Eylem tamamlandı
|
hasSigned | boolean | |
|
Adı ve soyadı
|
fullName | string |
Aktörün birleştirilmiş adı, ön eki ve soyadı. |
|
Durum bilgileri
|
emailActivity | array of EmailActivity |
Aktör tarafından eylemi gerçekleştirme işlemiyle ilgili durum bilgileri. |
|
documentId
|
documentId | guid |
EmailActivity
Aktöre gönderilecek e-posta iletisinin meta verileri
| Name | Yol | Tür | Description |
|---|---|---|---|
|
E-posta etkinliği
|
event | string |
Belirli bir istek ve aktör için e-posta etkinliği. |
|
SMTP bilgileri
|
reason | string |
İsteğin bir parçası olarak belirli bir aktöre gönderilen e-postanın SMTP bilgileri. |
|
E-posta tarihi
|
timestamp | date-time |
İsteğin bir parçası olarak belirli bir aktöre gönderilen e-postanın tarihi. |
|
E-posta türü
|
pkisMessageType | string |
bir isteğin parçası olarak belirli bir aktöre gönderilen e-postanın türünü yazın (ör. Davet Et, Anımsatıcı vb.). |
|
E-posta isteği kimliği
|
pkisInviteId | string |
İsteğin bir parçası olarak belirli bir aktöre gönderilen e-postanın benzersiz kimliği. |
|
E-posta adresi
|
string |
İsteğin bir parçası olarak belirli bir aktöre gönderilen e-postanın e-posta adresi. |
SignerModel
Özel aktör türü
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Eylem
|
action | string |
Aktörün gerçekleştirmesi gereken eylem. |
|
İsim
|
firstname | string |
Aktörün adı. |
|
Önek
|
prefix | string |
Aktörün ön eki. |
|
Soyadı
|
lastname | string |
Aktörün soyadı. |
|
E-posta adresi
|
string |
Aktörün e-posta adresi. |
|
|
Cep telefonu numarası
|
mobile | string |
Aktörün cep telefonu numarası. |
|
Deadline
|
deadline | date-time |
Eylemin aktör tarafından gerçekleştirilmesi gereken tarih ve saat. |
|
Language
|
language | string |
Davetin dili. |
|
Güçlü doğrulamayı kullanma
|
validateRealIdentity | boolean |
Bu aktör için daha güçlü bir tanımlama yöntemi kullanın. |
|
dossierPersonId
|
dossierPersonId | integer | |
|
message
|
message | string | |
|
İmzalama alanı
|
fieldName | string |
Bu aktörün imzalaması için belgede var olan bir imzalama alanının adı. |
|
Placeholder
|
placeholder | string |
Belgede, aktörün imza yerleştirmesi gereken belirli bir yer tutucunun metni. |
DocumentMetaDataModel
Belgenin genel meta verileri
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Belge adı
|
name | string |
Belirli bir belgenin adı. |
|
Son belge güncelleştirmesi
|
lastUpdate | date-time |
Belirli bir belge için son güncelleştirme tarihi. |
|
Belge sayfası sayısı
|
pages | integer |
Belirli bir belgenin sayfa sayısı. |
|
Belge oluşturma tarihi
|
created | date-time |
Belirli bir belge için oluşturma tarihi. |
|
Belge Kimliği
|
id | guid |
Belgenin benzersiz kimliği. |
|
Belge durumu
|
status | string |
Belirli bir belgenin durumu. (Örn. yeni, tamamlandı vb.). |
|
Belge imza içeriyor
|
signed | boolean |
Belirli bir belgenin zaten bir veya daha fazla imza içerip içermediğini gösterir. |
|
Belge imzaları
|
signatures | array of SignatureData |
Belirli bir belge için tüm imzaların listesi. |
|
Boş imza alanlarını belgele
|
emptySignatureFields | array of SignatureField |
Belirli bir belge için tüm boş imza alanlarının listesi. |
|
Boş imza alanları
|
containsBlankSignatureFields | boolean |
Belirli bir belgenin boş imza alanları içerip içermediğini gösterir. |
|
Belge aktörleri
|
actors | array of ExtendedSignerModel |
Belirli bir belgenin tüm aktörlerinin listesi. |
|
Talep Kimliği
|
requestId | guid |
İsteğin benzersiz kimliği. |
|
İstek dizini
|
dossierIndex | integer |
Belirli bir isteğe ait tüm belgelerin dizini. |
|
documentSize
|
documentSize | integer |
Belirli bir isteğe ait belgenin boyutu. |
|
documentType
|
documentType | string |
Belirli bir isteğe ait belgenin türü. |
SignatureData
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Sertifika konu alanları
|
subject | array of KeyValuePairOfStringAndString |
Belirli bir imza için kullanılan sertifikanın konu satırındaki alanlar. |
|
Sertifika veren alanları
|
issuer | array of KeyValuePairOfStringAndString |
Belirli bir imza için kullanılan sertifikanın veren satırındaki alanlar. |
|
İmza tarihi
|
date | date-time |
Belirli bir imzanın yerleştirildiği tarih ve saat. |
|
İmzalama konumu
|
location | string |
İmzalama sırasında belirli bir aktörün coğrafi konumu. |
|
İmzalama nedeni
|
reason | string |
İmzalama sırasında belirli bir aktör tarafından sağlanan şekilde imzalamanın nedeni. |
|
Nitelikli Elektronik İmza
|
euQualified | boolean |
Belirli bir imzanın uygun olup olmadığını gösterir (QeS) eIDAS düzenlemelerine uygundur. |
|
Gelişmiş Elektronik İmza
|
advanced | boolean |
Belirli bir imzanın gelişmiş (AeS) eIDAS düzenlemelerine uygun olup olmadığını gösterir. |
|
Nitelikli eSeal
|
eSeal | boolean |
İmzalama veya mühürleme için kullanılan belirli bir sertifikanın Nitelikli eSeal uyumlu eIDAS düzenlemeleri olup olmadığını gösterir. |
|
Aktör IP adresi
|
ipAddress | string |
Belirli bir aktörün IP adresi |
|
İmza alanı
|
signatureField | string |
İmzalanmış alan |
|
İmza resmi
|
signatureImage | string |
Bir aktör tarafından seçilen belirli bir imza için kullanılan görüntü dosyası. |
KeyValuePairOfStringAndString
| Name | Yol | Tür | Description |
|---|---|---|---|
|
key
|
key | string | |
|
value
|
value | string |
SignatureField
| Name | Yol | Tür | Description |
|---|---|---|---|
|
İmza alanı adı
|
name | string |
Belirli bir imza alanının adı |
|
İmza alanı sayfası
|
page | integer |
Belirli bir belge için belirli bir imza alanının yerleştirildiği sayfa. |
|
İmza alanı genişlik koordinatı
|
x | double |
Belirli bir belgeye yerleştirildiği sayfaya göre belirli bir imza alanının konumunun genişlik değeri. |
|
İmza alanı üst koordinatı
|
y | double |
Belirli bir belgeye yerleştirildiği sayfaya göre belirli bir imza alanının konumunun yüksek değeri. |
|
İmza alanı üst
|
height | double |
Belirli bir imza alanı için yüksek değer. |
|
İmza alanı genişliği
|
width | double |
Belirli bir imza alanı için genişlik değeri. |
OrganisationWorkgroup
Dosya içinde kullanılan çalışma grubu
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Çalışma Grubu Kimliği
|
id | guid |
Çalışma grubunun benzersiz kimliği |
|
Çalışma grubu adı
|
name | string |
Belirli bir çalışma grubunun adı |
RequestModel
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Talep Kimliği
|
id | guid |
İsteğin benzersiz kimliği |
|
İstek adı
|
dossierName | string |
Belirli bir isteğin adı. |
|
Belge isteme
|
documents | array of DocumentModel |
Bu isteğe dahil edilen belgelerin listesi. |
|
İstek durumu
|
status | string |
Belirli bir isteğin durumu. (Örn. yeni, tamamlandı vb.). |
|
İstek aktörleri
|
actors | array of ExtendedSignerModel |
Belirli bir isteğin tüm aktörlerinin listesi. |
|
Belge imzaları
|
signatures | array of SignatureData |
Belirli bir isteğin tüm imzalarının listesi. |
|
İstek türü
|
dossierType | string |
Belirli bir isteğin türü. (E.g. PDF, SBR Güvencesi vb.). |
|
İptal nedeni
|
reasons | string |
Bir kullanıcı veya aktör tarafından yapılan belirli bir istek için iptal etme nedeni. |
|
İmzalayan notu
|
signerNote | string |
İşaretten başka eylemi olmayan bir veya daha fazla aktör için not. |
|
Alıcı Notu
|
recipientNote | string |
İndirme dışında hiçbir eylemi olmayan bir veya daha fazla aktör için not. |
|
Onaylayan notu
|
accorderNote | string |
İsteği onaylamaktan başka bir eylemi olmayan bir veya daha fazla aktör için not. |
|
İsteğin süresi dolma tarihi
|
expires | date-time |
Belirli bir istek için son kullanma tarihi ve saati. |
|
Durum bilgileri
|
emailActivity | array of EmailActivity |
Aktör tarafından eylemi gerçekleştirme işlemiyle ilgili durum bilgileri. |
|
İsteğim
|
myDossier | boolean |
Belirli bir isteğin sahibi olup olmadığınızı gösterir. |
|
Çalışma Grubu Kimliği
|
workgroup | guid |
Çalışma grubunun benzersiz kimliği. |
|
Güvenlik izni düzeyi
|
clearancelevel | integer |
Belirli bir istek için güvenlik izni düzeyi. |
DocumentModel
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Belge Kimliği
|
id | guid |
Belgenin benzersiz kimliği |
|
Belge adı
|
name | string |
Belirli bir belgenin adı |
|
Belge türü
|
documentType | string |
Belirli bir belge için yazın. |
|
İstek dizini
|
dossierIndex | integer |
Belirli bir isteğe ait tüm belgelerin dizini. |
|
Belge durumu
|
documentstatus | string |
Belirli bir belgenin durumu. (Örn. yeni, tamamlandı vb.). |
|
Belge aktörleri
|
actors | array of SignerModel |
Belirli bir belgenin tüm aktörlerinin listesi. |
file
Bu, 'file' temel veri türüdür.