Taktikal Core (Önizleme)
Taktikal Core ile imzalama, mühürleme, kimlik doğrulaması yapma ve imzalama süreçlerinizle ilgili ayrıntılı bilgi edinme olanağına sahipsiniz.
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 | Taktikal |
| URL | https://docs.taktikal.com/ |
| E-posta | help@taktikal.com |
| Bağlayıcı Meta Verileri | |
|---|---|
| Publisher | Taktikal |
| Web sitesi | https://taktikal.com/ |
| Gizlilik ilkesi | https://www.taktikal.com/privacy |
| Kategoriler | Verimli -lik |
Taktikal Core API'leri, kendi arabiriminizde yeni çözümler oluşturmanın ve zaten çalışır durumda olan çözümlerle tümleştirmenin güçlü bir yoludur.
Belgeler doğrudan kendi sistemlerinizden imza için gönderilebilir ve imzalandıktan sonra belgeler ve ilgili meta veriler otomatik olarak belge sistemine geri gönderilebilir. Ayrıca, imzalama işlemindeki belgelerin durumunu izleyebilir ve kimlik numaralarına veya diğer benzersiz tanımlayıcılara göre durum çağrısı yapabilirsiniz.
Önkoşullar
Taktikal Core API'sini kullanmak için lütfen adresinden satış ekibimize sales@taktikal.is ulaşarak gerekli API kimlik bilgilerini alın.
Kimlik bilgilerini alma
Erişim oluşturmak ve API kimlik bilgilerinizi almak için Satış ekibimize ulaşın.
Bağlayıcınızı kullanmaya başlama
Çekirdek API belgeleri imzalayabilir, İzlanda e-kimliğini kullanarak kimlik doğrulaması yapabilir ve tüm imzalama işlemlerini yönetebilir
- Kimlik doğrulaması için /Auth/Start komutunu kullanarak bir kimlik doğrulama işlemi başlatın ve ardından /Auth/Poll komutunu kullanarak kimlik doğrulamasının durumunu denetleyin.
- Tek bir belge için tek bir belge çağrısı /management/imzalama ve birden çok belgenin toplu imzası için /management/signing/sıralı olarak imzalamak için.
- İmzalama işlemiyle ilgili ayrıntılı günlük almak için /signing/activity/{ProcessKey} çağrısı yapın.
Bilinen sorunlar ve sınırlamalar
- İsteklerin Temel Kimlik Doğrulaması için yetkilendirme üst bilgisine sahip olması gerekir. Bu companyKey ve API-Key
- Şu anda yalnızca Nitelikli imzalar İzlandaca bir e-kimlikle birlikte.
- PDF,ab Base64 dizesi olmalıdır.
- İmzalayanların geçerli bir e-posta adresi ve cep telefonu numarası olmalıdır.
Yaygın hatalar ve çözümler
Şu anda imza için yalnızca PDF kabul edilir.
FAQ
API hakkında daha fazla bilgi için https://docs.taktikal.com
İmzalama işlemi başlatmak tek bir POST isteğidir. İmzalama işlemi başlatmak için geçerli bir PDF belgesi ve belgeyi imzalaması gereken İmzalayanların listesi gerekir. Taktikal belgeyi imzalayana görüntülemeyi işler, ayrıca bir communicationDeliveryType seçilirse, Taktikal imzalayana bir SMS veya İmza bağlantısı içeren bir E-posta gönderir. Belge tüm katılımcılar tarafından imzalandıktan sonra Taktikal belgeyi kayıtlı olan ilgili teslim yollarına gönderir.
FlowKey, Taktikal tarafından sağlanan bir anahtardır. Bu anahtar Taktikal'a bu isteğin nasıl işleneceğini söyler. Bazı flowKey'ler için Taktikal belgeyi oluşturma işlemini üstlenir. ayrıca imzalanan belgenin imzalandıktan sonra teslim edildiği yeri de denetler.
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.
| İsim | Türü | Description | Gerekli |
|---|---|---|---|
| Şirket Anahtarı | securestring | Bu API için Şirket Anahtarı | Doğru |
| API Anahtarı | securestring | Bu API için API Anahtarı | Doğru |
Azaltma Sınırları
| Name | Çağrılar | Yenileme Dönemi |
|---|---|---|
| Bağlantı başına API çağrıları | 100 | 60 saniye |
Eylemler
| Belirli bir süre için kullanıcının etkinlik günlüğünü (e-posta) alır |
Bir süre için kullanıcının etkinlik günlüğünü alır. |
| Bir veya daha fazla imzalayanla yeni bir İmzalama işlemi oluşturur |
Bir veya daha fazla oturum açmış kişiyle yeni bir İmzalama işlemi oluşturur. |
| Bir Şirket için etkinlik günlüğünü alır |
Bir Şirket için etkinlik günlüğünü alır |
| İmzalama işlemi için etkinlik günlüğünü alır |
İmzalama işlemi için Etkinlik Günlüğü'nü alın. |
| İmzalama işlemini iptal etme |
Belirli bir İşlem Anahtarına göre İmzalama işlemini iptal edin. |
| İzlanda e-kimliği ile kimlik doğrulama işlemi başlatır |
İzlanda e-kimliği ile kimlik doğrulaması bir cep telefonu veya Audkenni uygulaması ile yapılabilir.
flowKey her zaman sağlanmalıdır ve Taktikal portalında erişilebilir. |
| İzlanda e-kimliğini kullanarak bir kullanıcı için kimlik doğrulamasının durumunu denetler |
/Auth/Start'tan başarılı bir yanıt aldıktan sonra bir AuthRequestId döndürülür ve kimlik doğrulamasının tamamlanıp tamamlanmadiğini denetlemek için kullanılır. Kimlik doğrulaması tamamlandıysa ve başarılı olursa, LookupType'a bağlı olarak müşteri nesnesi doldurulur. Arama türü, İzlanda Ulusal Kayıt Defteri için alınan bilgi türünü gösterir. LookupType'a bağlı olarak döndürülen üç farklı veri kümesi vardır:
'LookupType.NameAddressFamily' seçilirse, döndürülen ek değerler 'Meta' içinde döndürülür. Yanıtta hatalar varsa veya tamamlanmamışsa, müşteri nesnesi null olur ve StatusMessage ayrıntılı bir ileti içerir. |
| PDF belgesini mühürler |
Sağlanan bir PDF belgesini base64 dizesi olarak mühürler. |
|
process |
İşlem anahtarına ve signeeKey'e göre imzalama işlemini alın. |
| Sıralı İmzalama işlemini iptal etme |
Belirli bir Sıralı Anahtar için sıralı İmzalama işlemini iptal edin. Sıralı işlemi iptal eden bir kullanıcı (e-posta) sağlanabilir. |
| Sıralı imzalama işlemleri için İzlanda e-kimliği ile bir kimlik doğrulama işlemi başlatır |
İzlanda e-kimliği ile kimlik doğrulaması bir cep telefonu veya Audkenni uygulaması ile yapılabilir.
|
|
Verilen Process |
Signee özellikleri, ProcessKey ve SigneeKey sağlandıktan sonra güncelleştirilebilir. |
| XML belgesini mühürler |
Sağlanan bir XML belgesini base64 dizesi olarak mühürler. |
| Yeni Sıralı (Toplu) İmzalama işlemleri oluşturur |
Bir veya daha fazla İmzalama İşlemi ile yeni bir Sıralı İmzalama işlemi (Toplu) oluşturur. Bir dizideki her İmzalama işleminin bir veya daha fazla imzalayanı vardır. Örnek:
Ayrıntılı belgeleri şu adreste bulabilirsiniz: https://docs.taktikal.is/docs/api/using-the-signing-api/sequence-signing/ |
Belirli bir süre için kullanıcının etkinlik günlüğünü (e-posta) alır
Bir süre için kullanıcının etkinlik günlüğünü alır.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Kullanıcının e-posta adresi.
|
User | string |
Kullanıcının e-posta adresi. |
|
|
Aranacak günlüğün başlangıç tarihi EndDate değerinden daha küçük olmalıdır.
|
StartDate | True | date-time |
Aranacak günlüğün başlangıç tarihi EndDate değerinden daha küçük olmalıdır. |
|
Aranacak günlüğün bitiş tarihi, StartDate değerinden daha büyük bir tarih olmalıdır.
|
EndDate | True | date-time |
Aranacak günlüğün bitiş tarihi, StartDate değerinden daha büyük bir tarih olmalıdır. |
|
Tek bir imzalama işleminde filtrelenecekse kullanın.
|
ProcessKey | string |
Tek bir imzalama işleminde filtrelenecekse kullanın. |
|
|
Yalnızca belirli bir akış türü için etkinlik almak için kullanılabilir.
|
FlowType | string |
Yalnızca belirli bir akış türü için etkinlik almak için kullanılabilir. |
|
|
Sonuç kümesine sayfa eklemek ve yalnızca N çok sayıda sonuç döndürmek için kullanılır.
|
Take | integer |
Sonuç kümesine sayfa eklemek ve yalnızca N çok sayıda sonuç döndürmek için kullanılır. |
|
|
Sonuç kümesine sayfa eklemek ve ilk N sonuçları atlamak için kullanılır.
|
Skip | integer |
Sonuç kümesine sayfa eklemek ve ilk N sonuçları atlamak için kullanılır. |
|
|
Değeri varsa yalnızca bu flowKey ile eşleşen kayıtları döndürüriz
|
FlowKey | string |
Değeri varsa, yalnızca bu flowKey ile eşleşen kayıtları döndürüriz. |
Döndürülenler
- Liste<SigningProcessActivityLogWrapper>
- array of SigningProcessActivityLogWrapper
Bir veya daha fazla imzalayanla yeni bir İmzalama işlemi oluşturur
Bir veya daha fazla oturum açmış kişiyle yeni bir İmzalama işlemi oluşturur.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
pdfDocument
|
pdfDocument | string |
, imzalayacak belgenin base64 dizesidir. FlowKey belgenin oluşturulmasıyla ilgileniyorsa bu gerekli değildir. |
|
|
pdfFileName
|
pdfFileName | string |
PdfDocument kullanılıyorsa, dosya adı için bir değer sağlanması gerekir. |
|
|
flowKey
|
flowKey | True | string |
FlowKey, Taktikal tarafından sağlanır. Bu anahtar Taktikal'a bu isteğin nasıl işleneceğini söyler. Bazı flowKey'ler için Taktikal belgeyi oluşturma işlemini üstlenir. ayrıca imzalanan belgenin imzalandıktan sonra teslim edildiği yeri de denetler. |
|
processKey
|
processKey | string | ||
|
name
|
name | string | ||
|
ssn
|
ssn | string | ||
|
telefon numarası
|
phoneNumber | string | ||
|
e-posta
|
string | |||
|
address
|
address | string | ||
|
postalCode
|
postalCode | string | ||
|
city
|
city | string | ||
|
sebep
|
reason | string | ||
|
hidePersonalCode
|
hidePersonalCode | boolean | ||
|
communicationDeliveryType
|
communicationDeliveryType | string | ||
|
customSmsText
|
customSmsText | string | ||
|
signatureType
|
signatureType | string | ||
|
language
|
language | string | ||
|
Sözlük
|
meta | object |
Sözlük<Dizesi,Dize> |
|
|
fileName
|
fileName | string | ||
|
fileContent
|
fileContent | string | ||
|
kimlik
|
id | string | ||
|
fileName
|
fileName | string | ||
|
contentLength
|
contentLength | integer | ||
|
içerik türü
|
contentType | string | ||
|
url
|
url | string | ||
|
açıklama
|
description | string | ||
|
processKey
|
processKey | string | ||
|
attachmentType
|
attachmentType | string | ||
|
signeeKey
|
signeeKey | string | ||
|
requiresAuth
|
requiresAuth | boolean |
Varsayılan değer yanlış'tır. True olarak ayarlanırsa, belgeyi görüntüleyebilmek için tüm imzalayanların kimlik doğrulaması için orada e-kimlik kullanması gerekir. |
|
|
signInOrder
|
signInOrder | boolean |
Varsayılan değer yanlış'tır. İmzalayanların sırasını denetler. Yalnızca imzalayanlar listesindeki ilk kişiye başlangıç olarak bir imzalama isteği gönderir. Bir sonraki imzayı attıktan sonra. |
|
|
signatureLocation
|
signatureLocation | string |
BottomLastPage veya varsayılan Değer TopFirstPage olabilir. İmzanın belgede nerede görüntüleneceğini denetler. |
|
|
user
|
user | string |
isteği gönderen kullanıcının e-posta adresi. Boş olabilir. |
|
|
sequenceKey
|
sequenceKey | string | ||
|
activityDisplayName
|
activityDisplayName | string | ||
|
flattenDocument
|
flattenDocument | boolean |
Varsayılan değer yanlış'tır. True olarak ayarlanırsa, belge giriş alanlarını düzleştirmeyi deneriz. |
|
|
reminderRule
|
reminderRule | string |
Anımsatıcılar gönderir, hiçbiri için boş bırakın. biçimi "x gün sonra firstReminder:Sonra her y gün" olmalıdır. Örneğin, "1:3", 1 gün sonra bir anımsatıcı gönderir ve bundan sonraki üç günde bir. Anımsatıcı olmadan boş veya null bırakın; geçerli değerler ilk anımsatıcının 0-30 gün arasında gönderilmesi (0 anımsatıcı olmaması anlamına gelir) ve ardından her 0-15 günde bir (0, yine anımsatıcı olmadığı anlamına gelir) gönderilecektir. Bu nedenle 0:10 yalnızca 10 günde bir anımsatıcı gönderirken, 12:0 12 gün sonra yalnızca bir anımsatıcı gönderir |
Döndürülenler
İmzalama İşlemi
- İmzalama İşlemi
- SigningProcess
Bir Şirket için etkinlik günlüğünü alır
Bir Şirket için etkinlik günlüğünü alır
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Aranacak günlüğün başlangıç tarihi EndDate değerinden daha küçük olmalıdır.
|
StartDate | True | date-time |
Aranacak günlüğün başlangıç tarihi EndDate değerinden daha küçük olmalıdır. |
|
Aranacak günlüğün bitiş tarihi, StartDate değerinden daha büyük bir tarih olmalıdır.
|
EndDate | True | date-time |
Aranacak günlüğün bitiş tarihi, StartDate değerinden daha büyük bir tarih olmalıdır. |
|
Sonuç kümesine sayfa eklemek ve yalnızca N çok sayıda sonuç döndürmek için kullanılır.
|
Take | integer |
Sonuç kümesine sayfa eklemek ve yalnızca N çok sayıda sonuç döndürmek için kullanılır. |
|
|
Sonuç kümesine sayfa eklemek ve ilk N sonuçları atlamak için kullanılır.
|
Skip | integer |
Sonuç kümesine sayfa eklemek ve ilk N sonuçları atlamak için kullanılır. |
|
|
Kullanıcının e-posta adresi.
|
User | string |
Kullanıcının e-posta adresi. |
|
|
Yalnızca belirli bir akış türü için etkinlik almak için kullanılabilir.
|
FlowType | string |
Yalnızca belirli bir akış türü için etkinlik almak için kullanılabilir. |
|
|
Değeri varsa, yalnızca bu flowKey ile eşleşen kayıtları döndürüriz.
|
FlowKey | string |
Değeri varsa, yalnızca bu flowKey ile eşleşen kayıtları döndürüriz. |
Döndürülenler
- Liste<SigningProcessActivityLogWrapper>
- array of SigningProcessActivityLogWrapper
İmzalama işlemi için etkinlik günlüğünü alır
İmzalama işlemi için Etkinlik Günlüğü'nü alın.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Kullanıcının e-posta adresi.
|
User | string |
Kullanıcının e-posta adresi. |
|
|
Aranacak günlüğün başlangıç tarihi EndDate değerinden daha küçük olmalıdır.
|
StartDate | True | date-time |
Aranacak günlüğün başlangıç tarihi EndDate değerinden daha küçük olmalıdır. |
|
Aranacak günlüğün bitiş tarihi, StartDate değerinden daha büyük bir tarih olmalıdır.
|
EndDate | True | date-time |
Aranacak günlüğün bitiş tarihi, StartDate değerinden daha büyük bir tarih olmalıdır. |
|
Tek bir imzalama işleminde filtrelenecekse kullanın.
|
ProcessKey | True | string |
Tek bir imzalama işleminde filtrelenecekse kullanın. |
|
Yalnızca belirli bir akış türü için etkinlik almak için kullanılabilir.
|
FlowType | string |
Yalnızca belirli bir akış türü için etkinlik almak için kullanılabilir. |
|
|
sonuç kümesine sayfa eklemek ve yalnızca N çok sayıda sonuç döndürmek için kullanılır.
|
Take | integer |
sonuç kümesine sayfa eklemek ve yalnızca N çok sayıda sonuç döndürmek için kullanılır. |
|
|
sonuç kümesine sayfa eklemek ve ilk N sonuçları atlamak için kullanılır.
|
Skip | integer |
sonuç kümesine sayfa eklemek ve ilk N sonuçları atlamak için kullanılır. |
|
|
Değeri varsa, yalnızca bu flowKey ile eşleşen kayıtları döndürüriz.
|
FlowKey | string |
Değeri varsa, yalnızca bu flowKey ile eşleşen kayıtları döndürüriz. |
Döndürülenler
- Liste<SigningProcessActivityLogWrapper>
- array of SigningProcessActivityLogWrapper
İmzalama işlemini iptal etme
Belirli bir İşlem Anahtarına göre İmzalama işlemini iptal edin.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Tek bir belge İmzalama işlemi için benzersiz tanımlayıcı.
|
ProcessKey | string |
Tek bir belge İmzalama işlemi için benzersiz tanımlayıcı. |
|
|
Dize nesnesi, genellikle portala erişimi olan çalışanın e-postası.
|
User | string |
Dize nesnesi, genellikle portala erişimi olan çalışanın e-postası. |
Döndürülenler
İmzalama İşlemi
- İmzalama İşlemi
- SigningProcess
İzlanda e-kimliği ile kimlik doğrulama işlemi başlatır
İzlanda e-kimliği ile kimlik doğrulaması bir cep telefonu veya Audkenni uygulaması ile yapılabilir.
- Cep Telefonu Kullanma: AuthenticationContextType değeri 'Sim' olarak, phoneNumber ise İzlanda cep telefonu numarası olarak ayarlanmalıdır. ssn yoksayılır.
- Audkenni Uygulamasını Kullanma: AuthenticationContextType değeri 'App' olarak, ssn ise Icdlandic sosyal güvenlik numarası olarak ayarlanmalıdır. phoneNumber yoksayılır.
flowKey her zaman sağlanmalıdır ve Taktikal portalında erişilebilir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
ssn
|
ssn | string | ||
|
telefon numarası
|
phoneNumber | string | ||
|
flowKey
|
flowKey | True | string |
Bir Şirkete ait bir Flow için benzersiz tanımlayıcı. |
|
authenticationContextType
|
authenticationContextType | True | string |
Döndürülenler
StartAuthResponse
- StartAuthResponse
- StartAuthResponse
İzlanda e-kimliğini kullanarak bir kullanıcı için kimlik doğrulamasının durumunu denetler
/Auth/Start'tan başarılı bir yanıt aldıktan sonra bir AuthRequestId döndürülür ve kimlik doğrulamasının tamamlanıp tamamlanmadiğini denetlemek için kullanılır. Kimlik doğrulaması tamamlandıysa ve başarılı olursa, LookupType'a bağlı olarak müşteri nesnesi doldurulur. Arama türü, İzlanda Ulusal Kayıt Defteri için alınan bilgi türünü gösterir.
LookupType'a bağlı olarak döndürülen üç farklı veri kümesi vardır:
Ad: Yalnızca kimliği doğrulanmış kişinin SSN'sini ve Adını döndürür. Bunun ek arama maliyeti yoktur.
NameAddress: Ad, SSN ve adres bilgilerini döndürür. Bunun ek arama maliyeti vardır. LookupType için değer verilmediyse bu varsayılan değerdir.
NameAddressFamily: Ad, SSN, Adres verileri, cinsiyet kodu ve aile bilgilerini döndürür.
'LookupType.NameAddressFamily' seçilirse, döndürülen ek değerler 'Meta' içinde döndürülür.
Yanıtta hatalar varsa veya tamamlanmamışsa, müşteri nesnesi null olur ve StatusMessage ayrıntılı bir ileti içerir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
authRequestId
|
authRequestId | True | string | |
|
flowKey
|
flowKey | True | string |
Bir Şirkete ait bir Flow için benzersiz tanımlayıcı. |
|
lookupType
|
lookupType | True | string |
Döndürülenler
PollCustomer
- PollCustomer
- PollCustomer
PDF belgesini mühürler
Sağlanan bir PDF belgesini base64 dizesi olarak mühürler.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
pdfDocument
|
pdfDocument | True | string |
Pdf belgesinin mühürlenmesi için Base64String. |
|
flowKey
|
flowKey | True | string |
Bir Şirkete ait bir Flow için benzersiz tanımlayıcı. |
|
sebep
|
reason | string |
contada görüntülenme nedenini ayarlama |
|
|
languageType
|
languageType | string |
Döndürülenler
SealingResponse
- SealingResponse
- SealingResponse
processKey ve signeeKey ile imzalama işlemini alır
İşlem anahtarına ve signeeKey'e göre imzalama işlemini alın.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Tek bir belge İmzalama işlemi için benzersiz tanımlayıcı.
|
ProcessKey | True | string |
Tek bir belge İmzalama işlemi için benzersiz tanımlayıcı. |
|
Tek bir imzalama işlemini imzalarken bir kişinin benzersiz tanımlayıcısı.
|
SigneeKey | True | string |
Tek bir imzalama işlemini imzalarken bir kişinin benzersiz tanımlayıcısı. |
|
Kullanıcı Aracısı, web tarayıcısı veya e-posta istemcisi gibi bir kullanıcı için hareket eden bir yazılımdır.
|
UserAgent | string |
Kullanıcı Aracısı, web tarayıcısı veya e-posta istemcisi gibi bir kullanıcı için hareket eden bir yazılımdır. |
Döndürülenler
İmzalama İşlemi
- İmzalama İşlemi
- SigningProcess
Sıralı İmzalama işlemini iptal etme
Belirli bir Sıralı Anahtar için sıralı İmzalama işlemini iptal edin. Sıralı işlemi iptal eden bir kullanıcı (e-posta) sağlanabilir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Sağlanması gereken sıralı imzalama işlemi tanımlayıcısı.
|
SequenceKey | True | string |
Sağlanması gereken sıralı imzalama işlemi tanımlayıcısı. |
|
Yalnızca imzalama işlemini başlatan kullanıcı iptal edebilir.
|
User | True | string |
Yalnızca imzalama işlemini başlatan kullanıcı iptal edebilir. |
Döndürülenler
SequentialSigning
- SequentialSigning
- SequentialSigning
Sıralı imzalama işlemleri için İzlanda e-kimliği ile bir kimlik doğrulama işlemi başlatır
İzlanda e-kimliği ile kimlik doğrulaması bir cep telefonu veya Audkenni uygulaması ile yapılabilir.
- Cep Telefonu'nun kullanılması: AuthenticationContextType değeri 'Sim' olarak, phoneNumber ise Ucelandic cep telefonu numarasına ayarlanmalıdır. ssn yoksayılır.
- Audkenni Uygulamasını Kullanma: AuthenticationContextType değeri 'App' olarak, ssn ise Icdlandic sosyal güvenlik numarası olarak ayarlanmalıdır. phoneNumber yoksayılır.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Bir dizi (Toplu) İmzalama işlemleri için benzersiz tanımlayıcı.
|
SequenceKey | True | string |
Bir dizi (Toplu) İmzalama işlemleri için benzersiz tanımlayıcı. |
|
sequenceKey
|
sequenceKey | True | string | |
|
loginHint
|
loginHint | True | string | |
|
authenticationContextType
|
authenticationContextType | True | string |
Döndürülenler
StartAuthResponse
- StartAuthResponse
- StartAuthResponse
Verilen ProcessKey ve SigneeKey için Signee güncelleştirme
Signee özellikleri, ProcessKey ve SigneeKey sağlandıktan sonra güncelleştirilebilir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Tek bir imzalama işlemini imzalarken bir kişinin benzersiz tanımlayıcısı.
|
SigneeKey | True | string |
Tek bir imzalama işlemini imzalarken bir kişinin benzersiz tanımlayıcısı. |
|
Tek bir belge İmzalama işlemi için benzersiz tanımlayıcı.
|
ProcessKey | True | string |
Tek bir belge İmzalama işlemi için benzersiz tanımlayıcı. |
|
e-posta
|
string | |||
|
address
|
address | string | ||
|
postalCode
|
postalCode | string | ||
|
city
|
city | string | ||
|
signeeKey
|
signeeKey | True | string | |
|
processKey
|
processKey | True | string | |
|
sebep
|
reason | string | ||
|
user
|
user | string |
Döndürülenler
Oturum Aç
- Oturum Aç
- Signee
XML belgesini mühürler
Sağlanan bir XML belgesini base64 dizesi olarak mühürler.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
xmlDocument
|
xmlDocument | True | string |
Xml belgesinin mühürlenmesi için Base64String |
|
flowKey
|
flowKey | True | string |
Taktikal tarafından sağlanan ve sızdırmazlık için kullanılabilecek geçerli bir flowKey |
Döndürülenler
Nesne
- response
- object
Yeni Sıralı (Toplu) İmzalama işlemleri oluşturur
Bir veya daha fazla İmzalama İşlemi ile yeni bir Sıralı İmzalama işlemi (Toplu) oluşturur. Bir dizideki her İmzalama işleminin bir veya daha fazla imzalayanı vardır.
Örnek:
- Bir şirket A ve B belgesinin imzalı olduğunu istiyor. Signee X, A ve B belgesini imzalamalı, Signee Y belge A'yı ve Signee Z de Belge B'yi imzalamalıdır.
- Ardından iki CreateSigningProcess nesnesi dizisiyle yeni bir CreateSequentalSigning. Signees X ve Y, A Belgesi için CreateSigningProcess için oturum açma bilgileri olarak eklenir ve X ve Z imzaları B Belgesi için oturum açma bilgileri olarak eklenir.
Ayrıntılı belgeleri şu adreste bulabilirsiniz: https://docs.taktikal.is/docs/api/using-the-signing-api/sequence-signing/
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
pdfDocument
|
pdfDocument | string |
, imzalayacak belgenin base64 dizesidir. FlowKey belgenin oluşturulmasıyla ilgileniyorsa bu gerekli değildir. |
|
|
pdfFileName
|
pdfFileName | string |
PdfDocument kullanılıyorsa, dosya adı için bir değer sağlanması gerekir. |
|
|
flowKey
|
flowKey | True | string |
FlowKey, Taktikal tarafından sağlanır. Bu anahtar Taktikal'a bu isteğin nasıl işleneceğini söyler. Bazı flowKey'ler için Taktikal belgeyi oluşturma işlemini üstlenir. ayrıca imzalanan belgenin imzalandıktan sonra teslim edildiği yeri de denetler. |
|
processKey
|
processKey | string | ||
|
name
|
name | string | ||
|
ssn
|
ssn | string | ||
|
telefon numarası
|
phoneNumber | string | ||
|
e-posta
|
string | |||
|
address
|
address | string | ||
|
postalCode
|
postalCode | string | ||
|
city
|
city | string | ||
|
sebep
|
reason | string | ||
|
hidePersonalCode
|
hidePersonalCode | boolean | ||
|
communicationDeliveryType
|
communicationDeliveryType | string | ||
|
customSmsText
|
customSmsText | string | ||
|
signatureType
|
signatureType | string | ||
|
language
|
language | string | ||
|
Sözlük
|
meta | object |
Sözlük<Dizesi,Dize> |
|
|
fileName
|
fileName | string | ||
|
fileContent
|
fileContent | string | ||
|
kimlik
|
id | string | ||
|
fileName
|
fileName | string | ||
|
contentLength
|
contentLength | integer | ||
|
içerik türü
|
contentType | string | ||
|
url
|
url | string | ||
|
açıklama
|
description | string | ||
|
processKey
|
processKey | string | ||
|
attachmentType
|
attachmentType | string | ||
|
signeeKey
|
signeeKey | string | ||
|
requiresAuth
|
requiresAuth | boolean |
Varsayılan değer yanlış'tır. True olarak ayarlanırsa, belgeyi görüntüleyebilmek için tüm imzalayanların kimlik doğrulaması için orada e-kimlik kullanması gerekir. |
|
|
signInOrder
|
signInOrder | boolean |
Varsayılan değer yanlış'tır. İmzalayanların sırasını denetler. Yalnızca imzalayanlar listesindeki ilk kişiye başlangıç olarak bir imzalama isteği gönderir. Bir sonraki imzayı attıktan sonra. |
|
|
signatureLocation
|
signatureLocation | string |
BottomLastPage veya varsayılan Değer TopFirstPage olabilir. İmzanın belgede nerede görüntüleneceğini denetler. |
|
|
user
|
user | string |
isteği gönderen kullanıcının e-posta adresi. Boş olabilir. |
|
|
sequenceKey
|
sequenceKey | string | ||
|
activityDisplayName
|
activityDisplayName | string | ||
|
flattenDocument
|
flattenDocument | boolean |
Varsayılan değer yanlış'tır. True olarak ayarlanırsa, belge giriş alanlarını düzleştirmeyi deneriz. |
|
|
reminderRule
|
reminderRule | string |
Anımsatıcılar gönderir, hiçbiri için boş bırakın. biçimi "x gün sonra firstReminder:Sonra her y gün" olmalıdır. Örneğin, "1:3", 1 gün sonra bir anımsatıcı gönderir ve bundan sonraki üç günde bir. Anımsatıcı olmadan boş veya null bırakın; geçerli değerler ilk anımsatıcının 0-30 gün arasında gönderilmesi (0 anımsatıcı olmaması anlamına gelir) ve ardından her 0-15 günde bir (0, yine anımsatıcı olmadığı anlamına gelir) gönderilecektir. Bu nedenle 0:10 yalnızca 10 günde bir anımsatıcı gönderirken, 12:0 12 gün sonra yalnızca bir anımsatıcı gönderir |
|
|
user
|
user | True | string |
Sıralı imzalama işlemini başlatan kullanıcı |
|
requiresAuth
|
requiresAuth | boolean |
Varsayılan değer yanlış'tır. True olarak ayarlanırsa, belgeyi görüntüleyebilmek için tüm imzalayanların kimlik doğrulaması için orada e-kimlik kullanması gerekir. |
|
|
signInOrder
|
signInOrder | boolean |
Varsayılan değer yanlış'tır. İmzalayanların sırasını denetler. Yalnızca imzalayanlar listesindeki ilk kişiye başlangıç olarak bir imzalama isteği gönderir. Bir sonraki imzayı attıktan sonra. |
Döndürülenler
SequentialSigning
- SequentialSigning
- SequentialSigning
Tanımlar
Oturum Aç
Oturum Aç
| Name | Yol | Tür | Description |
|---|---|---|---|
|
name
|
name | string | |
|
ssn
|
ssn | string | |
|
telefon numarası
|
phoneNumber | string | |
|
e-posta
|
string | ||
|
address
|
address | string | |
|
postalCode
|
postalCode | string | |
|
city
|
city | string | |
|
key
|
key | string | |
|
Imzalı
|
signed | boolean | |
|
signedAt
|
signedAt | date-time | |
|
processKey
|
processKey | string | |
|
sebep
|
reason | string | |
|
hidePersonalCode
|
hidePersonalCode | boolean | |
|
communicationDeliveryType
|
communicationDeliveryType | string | |
|
url
|
url | string | |
|
signatureType
|
signatureType | string | |
|
language
|
language | string | |
|
customSmsText
|
customSmsText | string |
SigningAttachment
SigningAttachment
| Name | Yol | Tür | Description |
|---|---|---|---|
|
fileName
|
fileName | string | |
|
fileContent
|
fileContent | string |
AttachmentReference
AttachmentReference
| Name | Yol | Tür | Description |
|---|---|---|---|
|
kimlik
|
id | string | |
|
fileName
|
fileName | string | |
|
contentLength
|
contentLength | integer | |
|
içerik türü
|
contentType | string | |
|
url
|
url | string | |
|
açıklama
|
description | string | |
|
processKey
|
processKey | string | |
|
attachmentType
|
attachmentType | string | |
|
signeeKey
|
signeeKey | string |
Dictionary_String_String_
Sözlük<Dizesi,Dize>
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Sözlük
|
object |
Sözlük<Dizesi,Dize> |
SigningProcessActivityLogWrapper
SigningProcessActivityLogWrapper
| Name | Yol | Tür | Description |
|---|---|---|---|
|
processKey
|
processKey | string | |
|
activityLog
|
activityLog | array of SigningProcessActivityLog | |
|
imzalayanlar
|
signees | array of SigneeActivityLog | |
|
sequenceSignees
|
sequenceSignees | array of SequentialSigningSigneeActivityLog | |
|
attachmentReferences
|
attachmentReferences | array of AttachmentReference | |
|
activityDisplayName
|
activityDisplayName | string |
SigningProcessActivityLog
SigningProcessActivityLog
| Name | Yol | Tür | Description |
|---|---|---|---|
|
flowKey
|
flowKey | string |
Bir Şirkete ait bir Flow için benzersiz tanımlayıcı. |
|
processKey
|
processKey | string | |
|
signeeKey
|
signeeKey | string | |
|
statü
|
status | string | |
|
açıklama
|
description | string | |
|
userAgent
|
userAgent | string | |
|
fileName
|
fileName | string | |
|
createdAt
|
createdAt | date-time | |
|
oluşturan
|
createdBy | string | |
|
requiresAuth
|
requiresAuth | boolean | |
|
signInOrder
|
signInOrder | boolean | |
|
signatureLocation
|
signatureLocation | string | |
|
sequenceKey
|
sequenceKey | string |
SigneeActivityLog
SigneeActivityLog
| Name | Yol | Tür | Description |
|---|---|---|---|
|
processKey
|
processKey | string | |
|
signeeKey
|
signeeKey | string | |
|
ssn
|
ssn | string | |
|
name
|
name | string | |
|
address
|
address | string | |
|
postalCode
|
postalCode | string | |
|
city
|
city | string | |
|
phone
|
phone | string | |
|
e-posta
|
string | ||
|
createdAt
|
createdAt | date-time | |
|
oluşturan
|
createdBy | string | |
|
updatedAt
|
updatedAt | date-time | |
|
signatureType
|
signatureType | string |
SequentialSigningSigneeActivityLog
SequentialSigningSigneeActivityLog
| Name | Yol | Tür | Description |
|---|---|---|---|
|
sequenceKey
|
sequenceKey | string | |
|
signeeKey
|
signeeKey | string | |
|
url
|
url | string | |
|
signingKeys
|
signingKeys | array of SigneeKeys |
SigneeKeys
SigneeKeys
| Name | Yol | Tür | Description |
|---|---|---|---|
|
signeeKey
|
signeeKey | string | |
|
processKey
|
processKey | string |
SequentialSigning
SequentialSigning
| Name | Yol | Tür | Description |
|---|---|---|---|
|
key
|
key | string | |
|
statü
|
status | string | |
|
requiresAuth
|
requiresAuth | boolean | |
|
user
|
user | string | |
|
signInOrder
|
signInOrder | boolean | |
|
imzalayanlar
|
signees | array of SequentialSigningSignee | |
|
signingProcesses
|
signingProcesses | array of SigningProcess |
SequentialSigningSignee
SequentialSigningSignee
| Name | Yol | Tür | Description |
|---|---|---|---|
|
key
|
key | string | |
|
url
|
url | string | |
|
signingKeys
|
signingKeys | array of SigneeKeys |
İmzalama İşlemi
İmzalama İşlemi
| Name | Yol | Tür | Description |
|---|---|---|---|
|
key
|
key | string | |
|
imzalayanlar
|
signees | array of Signee | |
|
flowKey
|
flowKey | string |
Bir Şirkete ait bir Flow için benzersiz tanımlayıcı. |
|
statü
|
status | string | |
|
Sözlük
|
meta | Dictionary_String_String_ |
Sözlük<Dizesi,Dize> |
|
pdfFileName
|
pdfFileName | string | |
|
attachments
|
attachments | array of SigningAttachment | |
|
attachmentReferences
|
attachmentReferences | array of AttachmentReference | |
|
requiresAuth
|
requiresAuth | boolean | |
|
user
|
user | string | |
|
signInOrder
|
signInOrder | boolean | |
|
signatureLocation
|
signatureLocation | string | |
|
sequenceKey
|
sequenceKey | string | |
|
flattenDocument
|
flattenDocument | boolean |
StartAuthResponse
StartAuthResponse
| Name | Yol | Tür | Description |
|---|---|---|---|
|
authRequestId
|
authRequestId | string | |
|
verificationCode
|
verificationCode | string |
SealingResponse
SealingResponse
| Name | Yol | Tür | Description |
|---|---|---|---|
|
pdfDocument
|
pdfDocument | string |
Müşteri
Müşteri
| Name | Yol | Tür | Description |
|---|---|---|---|
|
name
|
name | string | |
|
ssn
|
ssn | string | |
|
telefon numarası
|
phoneNumber | string | |
|
e-posta
|
string | ||
|
address
|
address | string | |
|
postalCode
|
postalCode | string | |
|
city
|
city | string | |
|
token
|
token | string | |
|
flowKey
|
flowKey | string |
Bir Şirkete ait bir Flow için benzersiz tanımlayıcı. |
|
Sözlük
|
meta | Dictionary_String_String_ |
Sözlük<Dizesi,Dize> |
PollCustomer
PollCustomer
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Müşteri
|
customer | Customer |
Müşteri |
|
statusMessage
|
statusMessage | string | |
|
waitingForUserInput
|
waitingForUserInput | boolean |
object
Bu , 'object' türüdür.