Certyneo (Önizleme)
eIDAS uyumlu elektronik imza için belge gönderin, şablonlardan zarflar oluşturun ve gönderilen, imzalanan, tamamlanan ve reddedilen gibi imza olaylarında akışları tetikler.
Bu bağlayıcı aşağıdaki ürün ve bölgelerde kullanılabilir:
| Hizmet | Class | Regions |
|---|---|---|
| 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 | Standard | 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) |
| Contact | |
|---|---|
| Name | Certyneo Desteği |
| URL | https://certyneo.com/fr/contact |
| support@certyneo.com |
| Bağlayıcı Meta Verileri | |
|---|---|
| Publisher | Certyneo |
| Web Sitesi | https://certyneo.com |
| Gizlilik ilkesi | https://certyneo.com/fr/legal/privacy |
| Kategoriler | BT İşlemleri; Verimli -lik |
Certyneo
Certyneo, eIDAS uyumlu bir elektronik imza hizmetidir. Bu bağlayıcı, bir akışın imza için belge göndermesine, imzalayan kişi hareket ettiğinde gerçek zamanlı tepkiler göndermesine ve imzalı PDF'yi ve kanıt dosyasını işletmenin geri kalanının kayıtlarını tuttuğu her yerde dosyalamasına olanak tanır.
Tipik akış üç adımdır: belge bir yere (belge kitaplığı, posta kutusu, form gönderimi) iner, akış bir zarf oluşturup gönderir ve imzalı PDF'yi indirip depolar envelope.completed .
Publisher
Certyneo
Prerequisites
API erişimi içeren bir planda Certyneo hesabına ihtiyacınız vardır. Ücretsiz ve Kişisel planlar API anahtarları oluşturabilir ve olaylara abone olabilir, ancak yalnızca korumalı alan zarfları için olay alır. Aşağıdaki Bilinen sorunlar ve sınırlamalar bölümüne bakın.
Kimlik bilgilerini alma
Bağlayıcı bir Certyneo API anahtarıyla kimlik doğrulaması yapar.
- Certyneo'da oturum açın ve Ayarlar → API Anahtarları'nı açın.
- Bir anahtar oluşturun. Canlı anahtarlar ile
sk_live_başlar, ilesk_test_korumalı alan anahtarları. - Bağlayıcı API anahtarını istediğinde, sözcüğünü
Bearer, bir boşluk ve ardından anahtarı yapıştırın; örneğinBearer sk_live_abc123. Certyneo sözcüğüBeareranahtarın önünde bekler ve kendi başına yapıştırılan bir anahtar 401 ile reddedilir.
Anahtar kapsamları taşır. Oluşturma veya gönderme işlemi yapılamayan envelopes:write bir anahtar ve tetikleyiciyi geri veremeyen bir anahtar webhooks:write . Akışın ihtiyaç duyduğu kapsamları verin.
Kimseye e-posta göndermeden test etme
Korumalı alan anahtarı (sk_test_), tek bir davet e-postası göndermeden işlem hattının tamamını çalıştırır. Hiçbir şey gerçek bir gelen kutusuna ulaşmaz; bu da kimsenin e-postadan imzalama sayfasına ulaşamaması anlamına gelir; bu nedenle Zarf oluştur ve Zarf gönder , her alıcı için bir Erişim belirteci döndürür. Test zarfını kendiniz imzalamak için açın https://certyneo.com/sign/<access token> .
Bu belirteci kimlik bilgisi olarak değerlendirin: bu belirteci tutan herkes bu alıcı olarak imzalayabilir. Günlüğe kaydetmeyin ve elektronik tabloya bırakmayın.
Desteklenen işlemler
Trigger
Bir zarf olayı gerçekleştiğinde , seçtiğiniz olaylar üzerinde, yoklama yerine gerçek bir web kancası tarafından yedeklenerek tetikler. Kullanılabilir olaylar:
envelope.created, envelope.sent, , envelope.completed, envelope.declined, envelope.voided, envelope.expired, envelope.returned_to_sender, , envelope.resubmitted, recipient.signedrecipient.viewed, recipient.approved.
Her yük hem zarf hem de alıcı olaylarında Zarf Kimliği taşır. Bu, aşağıdaki eylemlere beslenen değerdir.
Teslimatlar üst bilgideki X-Certyneo-Signature HMAC-SHA256 ile imzalanır. Bu, ham JSON gövdesinin onaltılık özetidir ve abonelik gizli dizisiyle anahtarlanır. Bir akış yük üzerinde hareket etmeden önce bunu doğrulayın.
Actions
| Eylem | Ne işe yarıyor? |
|---|---|
| Liste şablonları | Kayıtlı zarf şablonlarınız. Şablon seçiciyi çalıştırır. |
| Zarf oluştur | Şablondan veya karşıya yüklenen belgelerden taslak zarf oluşturur. |
| Zarf gönder | Alıcılarına bir TASLAK zarfı sevk eder. |
| Zarfı al | Geçerli durum ve alıcı ayrıntıları. |
| Zarfları listeleme | Duruma göre filtrelenebilir sayfalandırılmış liste. |
| Belgeyi karşıya yükleme | PDF veya görüntü yükler ve bir belge kimliği döndürür. |
| İmzalı belgeyi indirme | İmzalı PDF, sertifika sayfası dahil. |
| Denetim kaydını indirme | Kanıt dosyası: kimin imzaladığı, ne zaman, hangi IP'den, hangi faktörlerle. |
| Taslak zarfı sil | Hiç gönderilmemiş bir zarfı siler. |
Bilinen sorunlar ve sınırlamalar
Gönderilen zarf akıştan geri çağrılamaz.Taslak zarfı sil seçeneği, yalnızca taslakta kalan zarfları kabul eder; yarı yolda başarısız olan bir akış, yanlış bir belge. Zarf çıktıktan sonra 409 döndürür ve bugün API'de iptal işlemi yoktur.
son imzalayan için de dahil olmak üzere imzalı PDF var olmadan önce tetiklenir.recipient.signed Son belgenin derlenmesi ve mühürlenmesi bu olaydan sonra gerçekleşir, bu nedenle her seferinde tetiklenen recipient.signed ve hemen İmzalanan belgeyi indir'i çağıran bir akış 409 alır. Bu, gecikmeyle kazanabileceğiniz bir yarış değildir; bunun yerine tetiklenir envelope.completed ve PDF diske eklendikten sonra tetiklenir.
Ücretsiz ve Kişisel planlar yalnızca korumalı alan olaylarını alır. Her ikisi de abonelik oluşturabilir ve tetikleyici sağlıklı olarak görünür, ancak canlı zarflar buna asla ulaşmaz. Bir tetikleyici gerçek trafik üzerinde hiçbir şey yapmaz gibi görünüyorsa, planı başka bir şeyden önce denetleyin.
Bir şablon veya belge kullanın, her ikisini birden kullanmayın. Şablon kendi belgelerini ve kendi imza alanlarını getirir. Bunun yerine karşıya yüklenen belgelerden derleme yaparken, imzalayan kişinin hiçbir yerde imzalaması olmayan bir zarf olan Alanlar'ı oluşturma zamanında değil, gönderme zamanında 409 signer_without_fieldile reddedilir.
Koordinatlar yerine tutturucu metni tercih edin. Belgeden bir tümceciği alıntılayarak bir alan yerleştirmek ("signature du client") düzen değişikliğinden sonra kalır ve ölçülmesi gerekmez. X ve Y bir geri dönüş olarak kalır, böylece yer işareti bulunmayan bir alan kaybolmak yerine sabit bir konum tutar.
Karşıya yüklemeler belge başına 50 MB olarak eşlenir .
Temizlenir belge 409 değil 410 döndürür. 409 , "henüz hazır değil, sonra envelope.completedgeri dön" anlamına gelir. 410, imzalanan belgenin bekletme ilkesi kapsamında kasıtlı olarak silindiği ve asla geri dönmeyeceğini gösterir. Yeniden deneme döngüsü 410'da bırakılmalıdır.
Yaygın hatalar ve çözümler
| Response | Cause | Çare |
|---|---|---|
| 401 | Anahtar eksik veya önünde olmadan Bearer yapıştırılmış |
Bağlantıyı yeniden girin Bearer sk_live_... |
| 403 | Anahtar, bu işlemin kapsamına sahip değil | Anahtarı akışın ihtiyaç duyduğu kapsamlarla yeniden verme |
| İndirmede 409 | Zarf henüz TAMAMLANMADı | Yoklama yerine tetikleme açık envelope.completed |
| 409 göndermede |
signer_without_field — imzalayanda imza alanı yok |
Alan ekleme veya şablondan derleme |
| Silmede 409 | Zarf zaten gönderildi | Gönderilen zarflar silinemez veya geri çekilemez |
| 410 indirilirken | Belge bekletme ilkesi kapsamında temizlendi | Yeniden denemeyi durdur; dosya kayboldu |
Hatalar hem insan tarafından error okunabilir bir ileti hem de kararlı codebir ileti taşır. Dallanma: code İleti yeniden oluşturulabilir.
Support
- Dokümantasyon: https://certyneo.com/developers
- Web kancası başvurusu: https://certyneo.com/developers/webhooks
- Destek: https://certyneo.com/support
Bağlantı oluşturma
Bağlayıcı aşağıdaki kimlik doğrulama türlerini destekler:
| Varsayılan | Bağlantı oluşturmak için parametreler. | Tüm bölgeler | Paylaşılamaz |
Temerrüt
Geçerli: Tüm bölgeler
Bağlantı oluşturmak için parametreler.
Bu, paylaşılabilir bir bağlantı değildir. Power app başka bir kullanıcıyla paylaşılıyorsa, başka bir kullanıcıdan açıkça yeni bağlantı oluşturması istenir.
| Name | Türü | Description | Zorunlu |
|---|---|---|---|
| API Anahtarı | securestring | Bu API için API Anahtarı | True |
Eylemler
| Belgeyi karşıya yükleme |
PDF veya görüntü yükleyin (en fazla 50 MB). Bir belge kimliği döndürür; belgeyi "Belgeler" altındaki "Zarf oluştur"a geçirin. |
| Denetim kaydını indirme |
Tamamlanmış bir zarfın kanıt dosyasını alın; imzalayan, ne zaman, hangi IP'den, hangi kimlik doğrulama faktörleriyle. İmzalı PDF ile birlikte arşivle: eIDAS anlaşmazlığının açtığı şey budur. |
| İmzalı belgeyi indirme |
İmzalı PDF, sertifika sayfasını dahil edin. Zarf TAMAMLANDıktan yalnızca bir kez ( 409 değerini döndürmeden önce) yoklama yerine "Zarf tamamlandı" seçeneğini tetikler. |
| Liste şablonları |
Kaydedilen zarf şablonlarınızı döndürür. "Zarf oluştur" üzerinde şablon seçiciyi etkinleştirmek için kullanılır. |
| Taslak zarfı sil |
Hiç gönderilmemiş bir zarfı (yarı yolda başarısız olan bir akış, yanlış belge) silin. Yalnızca TASLAK: Bir zarf dışarı çıktıktan sonra, bu bir hata döndürür ve bunu bir akıştan geri çağıramazsınız. |
| Zarf gönder |
Alıcılarına imza için taslak zarf gönderin; bu, e-postayı gerçekten gönderen adımdır. "Zarf oluştur" yalnızca taslak olarak kaydeder; kendi başına hiçbir şey göndermez. Bu eylemi akışınızda "Zarf oluştur"un hemen ardından döndüren zarf kimliğini kullanarak her zaman zincirleyin. |
| Zarf oluştur |
Kaydedilmiş bir şablondan veya doğrudan "Belgeyi karşıya yükle" ile yüklediğiniz belgelerden TASLAK durumunda yeni bir zarf oluşturun. Tam olarak "Şablon" veya "Belgeler" yazın. Belgelerle, her imzalayanın imzalayacak bir yeri olması için "Alanlar" ekleyin; en basit yol, koordinatları çözmek yerine belgedeki bir tümceciği "Tutturma metni" içinde alıntı yapmaktır. ÖNEMLİ: Bu eylem yalnızca zarfı oluşturur; henüz e-posta gönderilmez. "Zarf gönder" eylemini akışınıza bundan hemen sonra ekleyerek alıcılara gönderin. |
| Zarfları listeleme |
Sayfalandırılmış zarf listesini alın. |
| Zarfı al |
Zarfın geçerli durumunu ve ayrıntılarını alın. |
Belgeyi karşıya yükleme
PDF veya görüntü yükleyin (en fazla 50 MB). Bir belge kimliği döndürür; belgeyi "Belgeler" altındaki "Zarf oluştur"a geçirin.
Parametreler
| Veri Akışı Adı | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Dosya
|
file | True | file |
Karşıya yüklenecek PDF veya görüntü, en fazla 50 MB. |
|
Belge adı
|
name | string |
Belgenin altında dosyaya ek olarak adlandırın. Varsayılan olarak karşıya yüklenen dosyanın kendi adını kullanır. |
Döndürülenler
- Body
- Document
Denetim kaydını indirme
Tamamlanmış bir zarfın kanıt dosyasını alın; imzalayan, ne zaman, hangi IP'den, hangi kimlik doğrulama faktörleriyle. İmzalı PDF ile birlikte arşivle: eIDAS anlaşmazlığının açtığı şey budur.
Parametreler
| Veri Akışı Adı | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Zarf Kimliği
|
id | True | string |
Denetim kaydını indirmek istediğiniz zarfın tanımlayıcısı. |
Döndürülenler
- response
- binary
İmzalı belgeyi indirme
İmzalı PDF, sertifika sayfasını dahil edin. Zarf TAMAMLANDıktan yalnızca bir kez ( 409 değerini döndürmeden önce) yoklama yerine "Zarf tamamlandı" seçeneğini tetikler.
Parametreler
| Veri Akışı Adı | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Zarf Kimliği
|
id | True | string |
İmzalı belgesini indirmek istediğiniz zarfın tanımlayıcısı. |
Döndürülenler
- response
- binary
Liste şablonları
Kaydedilen zarf şablonlarınızı döndürür. "Zarf oluştur" üzerinde şablon seçiciyi etkinleştirmek için kullanılır.
Döndürülenler
- Body
- TemplateList
Taslak zarfı sil
Hiç gönderilmemiş bir zarfı (yarı yolda başarısız olan bir akış, yanlış belge) silin. Yalnızca TASLAK: Bir zarf dışarı çıktıktan sonra, bu bir hata döndürür ve bunu bir akıştan geri çağıramazsınız.
Parametreler
| Veri Akışı Adı | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Zarf Kimliği
|
id | True | string |
Silinecek taslak zarfın tanımlayıcısı. |
Döndürülenler
- Body
- DeleteResult
Zarf gönder
Alıcılarına imza için taslak zarf gönderin; bu, e-postayı gerçekten gönderen adımdır. "Zarf oluştur" yalnızca taslak olarak kaydeder; kendi başına hiçbir şey göndermez. Bu eylemi akışınızda "Zarf oluştur"un hemen ardından döndüren zarf kimliğini kullanarak her zaman zincirleyin.
Parametreler
| Veri Akışı Adı | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Zarf Kimliği
|
id | True | string |
Alıcılarına göndermek için taslak zarfın tanımlayıcısı. |
Döndürülenler
- Body
- Envelope
Zarf oluştur
Kaydedilmiş bir şablondan veya doğrudan "Belgeyi karşıya yükle" ile yüklediğiniz belgelerden TASLAK durumunda yeni bir zarf oluşturun. Tam olarak "Şablon" veya "Belgeler" yazın. Belgelerle, her imzalayanın imzalayacak bir yeri olması için "Alanlar" ekleyin; en basit yol, koordinatları çözmek yerine belgedeki bir tümceciği "Tutturma metni" içinde alıntı yapmaktır. ÖNEMLİ: Bu eylem yalnızca zarfı oluşturur; henüz e-posta gönderilmez. "Zarf gönder" eylemini akışınıza bundan hemen sonra ekleyerek alıcılara gönderin.
Parametreler
| Veri Akışı Adı | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Subject
|
subject | True | string |
Zarf konusu / başlığı. |
|
Message
|
message | string |
Alıcılara gösterilen ileti. |
|
|
Template
|
templateId | string |
Kaydedilmiş bir şablon seçin. Her ikisini birden değil, bu VEYA "Belgeler"i kullanın; bir şablon kendi belgelerini ve imza alanlarını getirir. |
|
|
Documents
|
documentIds | array of string |
"Belgeyi karşıya yükle"den belge kimlikleri. Her ikisini birden değil, bu VEYA "Şablon" kullanın. Belgeleri kullandığınızda, imzalayanı imza alanı olmayan bir zarfı gönderme zamanında reddedilen bir zarf olan "Alanlar" da ekleyin. |
|
|
İmzalayan e-postası
|
recipientEmail | True | string |
Yukarıdaki alıcılardan biriyle tam olarak eşleşmelidir. |
|
Belge numarası
|
documentIndex | integer |
Yukarıda verilen sırayla 0'dan sayarak bu alanı taşıyan belge. Yalnızca bir belge olduğunda boş bırakın. |
|
|
Sayfa
|
pageNumber | True | integer | |
|
Alan türü
|
fieldType | True | string | |
|
Tutturucu metin (önerilen)
|
anchorText | string |
Belgede aranacak metin— alan yanına yerleştirilir, bu nedenle koordinatlara ihtiyacınız yoktur. Büyük/küçük harfe duyarlı değildir ve PDF tümceciği çalıştırmalar arasında böldüğünde bile bulunur. Bunun yerine X/Y kullanmak için boş bırakın. |
|
|
Yer işareti yerleştirme
|
anchorPlacement | string |
Alanın yer işareti metnine göre yerleştirileceği yer. |
|
|
Yer işareti oluşumu
|
anchorIndex | integer |
Tutturucu metni birkaç kez göründüğünde 0'dan sayarak hangi oluşumun kullanılacağı. |
|
|
X
|
x | True | number |
Sol kenardan puanlar. Yer işareti bulunduğunda yoksayılır; geri dönüş olarak tutulur, böylece alan hiçbir zaman kaybolmaz. |
|
Y
|
y | True | number |
ÜST kenardan puanlar. Yer işareti bulunduğunda yoksayılır; geri dönüş olarak tutulur. |
|
Genişlik
|
width | True | number | |
|
Yükseklik
|
height | True | number | |
|
Alıcı e-postası
|
True | string | ||
|
Alıcı adı
|
name | string | ||
|
Role
|
role | string | ||
|
status
|
status | string | ||
|
signedAt
|
signedAt | string | ||
|
Erişim belirteci
|
accessToken | string |
Bu alıcının imzalama sayfasını belirteçte https://certyneo.com/sign/<>açar. Korumalı alanda hiçbir davet e-postası dışarı çıkmadığından, test zarfı bu şekilde imzalanır. "Zarf oluştur" ve "Zarf gönder" ile döndürülür; boş kaldığı "Zarfı al" ile değil. Bunu kimlik bilgisi olarak değerlendirin: Onu tutan herkes bu alıcı olarak imzalayabilir, bu nedenle günlüğe kaydetmeyin veya elektronik tabloya bırakmayın. |
|
|
İmza düzeyi
|
signatureLevel | string | ||
|
Son kullanma tarihi:
|
expiresAt | date-time | ||
|
Kategori
|
category | string |
Zarf listesinde gösterilen iş sınıflandırması. Boş bırakın ve Certyneo, konudan bir tane çıkarsın. |
|
|
Etiketler
|
tags | array of string |
Serbest biçimli etiketler — proje kodu, müşteri başvurusu, iç durum. Her birinde en fazla 40 karakter olmak üzere en fazla 10 karakter. Küçük harfli ve yinelenenleri kaldırılmış sunucu tarafı. |
|
|
Language
|
locale | string |
İmzalayanın gördüğü her şeyin dili: imzalama sayfası, davet, anımsatıcılar, tamamlama e-postası. BCP-47 kodu, örneğin nl, nl-BE, en-GB, de, fr. Zarfı gönderen Certyneo hesabının dilini devralmak için boş bırakın. Desteklenmeyen bir kod 400 ile reddedilir. |
|
|
Yönlendirme URL’si
|
redirectUrl | string |
İmzalayanın imzaladıktan sonra gönderildiği yer. Varsayılan Certyneo eylem çağrısını buraya işaret eden tek bir "Devam" düğmesiyle değiştirir. https:// ile başlamalıdır; diğer her şey 400 ile reddedilir. |
|
|
Her sayfada baş harfler
|
initialsOnEveryPage | boolean |
İmzalayanın baş harflerini, kendi yerleştirdiğiniz alanlara ek olarak her belgenin her sayfasının en altına otomatik olarak damgalayın. Sayfa başına kurulum gerekmez; imzalayan kişi baş harflerini bir kez doldurur ve her yere uygulanır. İmzalayanın zaten bir alanı (örneğin, son sayfadaki imza) bulunduğu bir sayfayı atlar. |
|
|
Workspace
|
workspaceId | string |
Paylaşılan bir çalışma alanında zarfı oluşturun; böylece bu çalışma alanının tüm üyeleri bu zarfı görebilir ve izleyebilir. Kendi hesabınızda tutmak için boş bırakın. Çalışma alanının sahibi olmanız veya çalışma alanının üyesi olmanız gerekir. |
Döndürülenler
- Body
- Envelope
Zarfları listeleme
Sayfalandırılmış zarf listesini alın.
Parametreler
| Veri Akışı Adı | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Sayfa
|
page | integer |
Döndürülecek sonuç sayfası. 1'de başlar. |
|
|
Sayfa Boyutu
|
limit | integer |
Sayfa başına kaç zarf döndürülecek? |
|
|
Statü
|
status | string |
Yalnızca bu durumdaki zarfları iade edin. Her durumu döndürmek için boş bırakın. |
Döndürülenler
- Body
- EnvelopeList
Zarfı al
Zarfın geçerli durumunu ve ayrıntılarını alın.
Parametreler
| Veri Akışı Adı | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Zarf Kimliği
|
id | True | string |
Alınacak zarfın tanımlayıcısı. |
Döndürülenler
- Body
- Envelope
Tetikleyiciler
| Zarf olayı gerçekleştiğinde |
Seçili olaylardan biri zarflarınızdan birinde her gerçekleştiğinde (imzalanmış, tamamlandı, reddedildi gibi) bir akışı tetikler. Gerçek zamanlı bir web kancası tarafından yedeklenmiştir; yoklama yoktur. |
Zarf olayı gerçekleştiğinde
Seçili olaylardan biri zarflarınızdan birinde her gerçekleştiğinde (imzalanmış, tamamlandı, reddedildi gibi) bir akışı tetikler. Gerçek zamanlı bir web kancası tarafından yedeklenmiştir; yoklama yoktur.
Parametreler
| Veri Akışı Adı | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Events
|
events | True | array of string |
Bu akışı tetikleyen zarf/alıcı olayları. |
Döndürülenler
X-Certyneo-Signature üst bilgisinde HMAC-SHA256 ile imzalanan teslim edildi (aboneliğin gizli anahtarıyla anahtarlanan ham JSON gövdesinin onaltılık özeti). Üzerinde hareket eden bir akıştaki yüke güvenmeden önce doğrulayın (bkz. /developers/web kancaları).
- Body
- WebhookEventPayload
Tanımlar
DeleteResult
| Veri Akışı Adı | Yol | Tür | Description |
|---|---|---|---|
|
Success
|
success | boolean |
Kaynak silindiğinde true. |
Pagination
| Veri Akışı Adı | Yol | Tür | Description |
|---|---|---|---|
|
toplam
|
total | integer | |
|
sayfa
|
page | integer | |
|
pageSize
|
pageSize | integer | |
|
pages
|
pages | integer |
Template
| Veri Akışı Adı | Yol | Tür | Description |
|---|---|---|---|
|
kimlik
|
id | string | |
|
name
|
name | string | |
|
description
|
description | string | |
|
signerCount
|
signerCount | integer | |
|
documentCount
|
documentCount | integer |
TemplateList
| Veri Akışı Adı | Yol | Tür | Description |
|---|---|---|---|
|
data
|
data | array of Template | |
|
sayfalandırma
|
pagination | Pagination |
Recipient
| Veri Akışı Adı | Yol | Tür | Description |
|---|---|---|---|
|
Alıcı e-postası
|
string | ||
|
Alıcı adı
|
name | string | |
|
Role
|
role | string | |
|
status
|
status | string | |
|
signedAt
|
signedAt | string | |
|
Erişim belirteci
|
accessToken | string |
Bu alıcının imzalama sayfasını belirteçte https://certyneo.com/sign/<>açar. Korumalı alanda hiçbir davet e-postası dışarı çıkmadığından, test zarfı bu şekilde imzalanır. "Zarf oluştur" ve "Zarf gönder" ile döndürülür; boş kaldığı "Zarfı al" ile değil. Bunu kimlik bilgisi olarak değerlendirin: Onu tutan herkes bu alıcı olarak imzalayabilir, bu nedenle günlüğe kaydetmeyin veya elektronik tabloya bırakmayın. |
Belge
| Veri Akışı Adı | Yol | Tür | Description |
|---|---|---|---|
|
kimlik
|
id | string | |
|
name
|
name | string | |
|
MIME türü
|
mimeType | string | |
|
size
|
size | integer | |
|
status
|
status | string |
Zarf
| Veri Akışı Adı | Yol | Tür | Description |
|---|---|---|---|
|
kimlik
|
id | string | |
|
subject
|
subject | string | |
|
message
|
message | string | |
|
status
|
status | string | |
|
signatureLevel
|
signatureLevel | string | |
|
recipients
|
recipients | array of Recipient | |
|
expiresAt
|
expiresAt | string | |
|
createdAt
|
createdAt | string | |
|
completedAt
|
completedAt | string |
Zarf Listesi
| Veri Akışı Adı | Yol | Tür | Description |
|---|---|---|---|
|
data
|
data | array of Envelope | |
|
sayfalandırma
|
pagination | Pagination |
WebhookEventPayload
X-Certyneo-Signature üst bilgisinde HMAC-SHA256 ile imzalanan teslim edildi (aboneliğin gizli anahtarıyla anahtarlanan ham JSON gövdesinin onaltılık özeti). Üzerinde hareket eden bir akıştaki yüke güvenmeden önce doğrulayın (bkz. /developers/web kancaları).
| Veri Akışı Adı | Yol | Tür | Description |
|---|---|---|---|
|
event
|
event | string | |
|
timestamp
|
timestamp | date-time | |
|
Zarf Kimliği
|
data.envelopeId | string |
Her zaman var. "Zarfı al" veya "İmzalı belgeyi indir" olarak besleyin. |
|
Subject
|
data.subject | string |
Yalnızca zarf olaylarında sunulur. |
|
Statü
|
data.status | string | |
|
İmza düzeyi
|
data.signatureLevel | string |
Zarfta var.tamamlandı ve alıcı.imzalandı. |
|
Kişisel anahtarla gelişmiş imza imzalayanlar
|
data.aesSignerCount | integer |
zarf.yalnızca GELİşMİş zarfta tamamlandı. |
|
Gelişmiş imza sertifikası seri
|
data.aesCertificateSerial | string |
alıcı.imzalı, imzalayan kişisel bir gelişmiş imza anahtarıyla imzaladığında. |
|
Gelişmiş imza sertifikası SHA256
|
data.aesCertificateSha256 | string |
alıcı.imzalı, imzalayan kişisel bir gelişmiş imza anahtarıyla imzaladığında. |
|
Gelişmiş imza bildirimi SHA256
|
data.aesManifestSha256 | string |
alıcı.imzalı, imzalayan kişisel bir gelişmiş imza anahtarıyla imzaladığında. |
|
Gelişmiş imza zaman damgası
|
data.aesTimestamped | boolean |
alıcı.imzalı, imzalayan kişisel bir gelişmiş imza anahtarıyla imzaladığında. |
|
Alıcı sayısı
|
data.recipientCount | integer |
Yalnızca zarf olaylarında sunulur. |
|
İmzalı sayı
|
data.signedCount | integer |
Yalnızca zarf olaylarında sunulur. |
|
Alıcı Kimliği
|
data.recipientId | string |
Yalnızca alıcı olaylarında sunulur. |
|
Alıcı e-postası
|
data.email | string |
Yalnızca alıcı olaylarında sunulur. |
|
Alıcı adı
|
data.name | string |
Yalnızca alıcı olaylarında sunulur. |
|
Alıcı rolü
|
data.role | string |
Yalnızca alıcı olaylarında sunulur. |
|
İmzalanan yer
|
data.signedAt | date-time |
Yalnızca alıcı olaylarında sunulur. |
|
Görüntülendiği yer:
|
data.viewedAt | date-time |
Yalnızca alıcı olaylarında sunulur. |
binary
Bu, 'ikili' temel veri türüdür.