Taktikal Core (wersja zapoznawcza)
Dzięki platformie Taktikal Core masz możliwość podpisywania, uszczelniania, uwierzytelniania i uzyskiwania szczegółowych informacji dotyczących procesów podpisywania.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure Government — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD) |
| Power Apps | Premium | Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Power Automate | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Kontakt | |
|---|---|
| Name | Taktikal |
| adres URL | https://docs.taktikal.com/ |
| help@taktikal.com |
| Metadane łącznika | |
|---|---|
| Publisher | Taktikal |
| Witryna internetowa | https://taktikal.com/ |
| Zasady ochrony prywatności | https://www.taktikal.com/privacy |
| Kategorie | Produktywność |
Interfejsy API Taktikal Core to zaawansowany sposób tworzenia nowych rozwiązań we własnym interfejsie i integracji z rozwiązaniami, które już działają.
Dokumenty mogą być wysyłane do podpisu bezpośrednio z własnych systemów, a po podpisaniu dokumenty i powiązane metadane mogą być automatycznie wysyłane z powrotem do systemu dokumentów. Możesz również monitorować stan dokumentów w procesie podpisywania i wywoływać stan na podstawie numerów identyfikatorów lub innych unikatowych identyfikatorów.
Wymagania wstępne
Aby użyć interfejsu API Taktikal Core, skontaktuj się z naszym zespołem sprzedaży pod adresem sales@taktikal.is , aby uzyskać niezbędne poświadczenia interfejsu API.
Jak uzyskać poświadczenia
Skontaktuj się z naszym zespołem ds. sprzedaży, aby utworzyć dostęp i uzyskać poświadczenia interfejsu API.
Wprowadzenie do łącznika
Podstawowy interfejs API może pobierać podpisane dokumenty, uwierzytelniać się przy użyciu islandzkego identyfikatora e-ID i zarządzać wszystkimi procesami podpisywania
- W przypadku uwierzytelniania użyj /Auth/Start, aby zainicjować proces uwierzytelniania, a następnie /Auth/Poll, aby sprawdzić, czy stan uwierzytelniania.
- Aby podpisać jednokrotne wywołanie dokumentu /management/signing dla pojedynczego dokumentu i /management/signing/sekwencyjne dla zbiorczego podpisu wielu dokumentów.
- Aby uzyskać szczegółowy dziennik dotyczący wywołania procesu podpisywania /signing/activity/{ProcessKey}.
Znane problemy i ograniczenia
- Żądania muszą mieć nagłówek autoryzacji dla uwierzytelniania podstawowego. Jest to firmaKey i API-Key
- W tej chwili tylko kwalifikowane podpisy są z islandzką e-id.
- Podaj plik PDF powinien być ciągiem ab Base64.
- Osoby podpisające muszą mieć prawidłowy adres e-mail i numer telefonu komórkowego.
Typowe błędy i środki zaradcze
Obecnie tylko plik PDF jest akceptowany do podpisu.
Często zadawane pytania
Więcej informacji na temat interfejsu API można znaleźć w obszarze https://docs.taktikal.com
Rozpoczęcie procesu podpisywania jest pojedynczym żądaniem POST. Aby rozpocząć proces podpisywania, potrzebny jest prawidłowy dokument PDF i lista osób podpisujących, które muszą podpisać dokument. Taktikal będzie obsługiwać wyświetlanie dokumentu pod znakiem, również jeśli wybrano komunikacjęDeliveryType, Taktikal wyśle podpisy SMS lub e-mail z linkiem do podpisania. Po podpisaniu dokumentu przez wszystkich uczestników Taktikal wyśle dokument do odpowiednich zarejestrowanych ścieżek dostarczania.
Klucz flowKey jest kluczem dostarczonym przez taktikal. Ten klucz poinformuje Taktikal, jak obsłużyć to żądanie. W przypadku niektórych elementów flowKeys Taktikal zajmie się tworzeniem dokumentu. Będzie on również kontrolować, gdzie podpisany dokument jest dostarczany po podpisaniu.
Tworzenie połączenia
Łącznik obsługuje następujące typy uwierzytelniania:
| Wartość domyślna | Parametry tworzenia połączenia. | Wszystkie regiony | Nie można udostępniać |
Domyślny
Dotyczy: wszystkie regiony
Parametry tworzenia połączenia.
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Klucz firmy | securestring | Klucz firmy dla tego interfejsu API | Prawda |
| Klucz interfejsu API | securestring | Klucz interfejsu API dla tego interfejsu API | Prawda |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
|
Aktualizowanie elementu Signee dla danego elementu Process |
Właściwości signee można zaktualizować, po podaniu właściwości ProcessKey i SigneeKey. |
| Anulowanie procesu podpisywania |
Anuluj proces podpisywania na podstawie danego klucza procesu. |
| Anulowanie sekwencyjnego procesu podpisywania |
Anuluj sekwencyjny proces podpisywania oparty na danym kluczu sekwencji. Użytkownik (wiadomość e-mail) może zostać udostępniony, który anuluje proces sekwencyjny. |
| Inicjuje proces uwierzytelniania przy użyciu islandzkego identyfikatora e-id |
Uwierzytelnianie przy użyciu islandzkego e-idu można wykonać za pomocą telefonu komórkowego lub aplikacji Audkenni.
klucz flowKey należy zawsze podać i jest dostępny w portalu Taktikal. |
| Pobiera dziennik aktywności dla firmy |
Pobiera dziennik aktywności dla firmy |
| Pobiera dziennik aktywności na potrzeby procesu podpisywania |
Pobierz dziennik aktywności dla procesu podpisywania. |
| Pobiera dziennik aktywności użytkownika (e-mail) dla określonego okresu |
Pobiera dziennik aktywności użytkownika przez pewien okres. |
|
Pobiera proces podpisywania według właściwości process |
Pobierz proces podpisywania za pomocą processkey i signeeKey. |
| Rozpoczyna proces uwierzytelniania przy użyciu islandzkego identyfikatora e-id dla sekwencyjnych procesów podpisywania |
Uwierzytelnianie przy użyciu islandzkego e-idu można wykonać za pomocą telefonu komórkowego lub aplikacji Audkenni.
|
| Sprawdza stan uwierzytelniania użytkownika przy użyciu jego islandzkego identyfikatora e-id |
Po pomyślnej odpowiedzi z /Auth/Start zwracany jest identyfikator AuthRequestId i służy do sprawdzania, czy uwierzytelnianie zostało zakończone. Jeśli uwierzytelnianie zostanie zakończone i zakończy się pomyślnie, obiekt klienta zostanie wypełniony w zależności od lookupType. Typ odnośnika wskazuje, że typ informacji jest pobierany dla rejestru narodowego islandii. Istnieją trzy różne zestawy danych zwracane w zależności od elementu LookupType:
Jeśli wybrano opcję "LookupType.NameAddressFamily", zwracane będą dodatkowe wartości w meta. Jeśli odpowiedź zawiera błędy lub nie zostanie zakończona, obiekt klienta będzie miał wartość null, a komunikat StatusMessage będzie zawierać szczegółowy komunikat. |
| Tworzy nowe procesy podpisywania sekwencyjnego (zbiorczego) |
Tworzy nowy sekwencyjny proces podpisywania (zbiorczy) z co najmniej jednym procesem podpisywania. Każdy proces podpisywania w sekwencji ma co najmniej jeden znak. Przykład:
Szczegółową dokumentację można znaleźć na stronie https://docs.taktikal.is/docs/api/using-the-signing-api/sequence-signing/ |
| Tworzy nowy proces podpisywania z co najmniej jednym znakiem |
Tworzy nowy proces podpisywania z co najmniej jednym znakiem. |
| Uszczelnia dokument XML |
Uszczelnia dostarczony dokument XML jako ciąg base64. |
| Zapieczętuje dokument PDF |
Zapieczętuje dostarczony dokument PDF jako ciąg base64. |
Aktualizowanie elementu Signee dla danego elementu ProcessKey i SigneeKey
Właściwości signee można zaktualizować, po podaniu właściwości ProcessKey i SigneeKey.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Unikatowy identyfikator osoby podpisującego pojedynczy proces podpisywania.
|
SigneeKey | True | string |
Unikatowy identyfikator osoby podpisującego pojedynczy proces podpisywania. |
|
Unikatowy identyfikator procesu podpisywania pojedynczego dokumentu.
|
ProcessKey | True | string |
Unikatowy identyfikator procesu podpisywania pojedynczego dokumentu. |
|
e-mail
|
string | |||
|
address
|
address | string | ||
|
postalCode
|
postalCode | string | ||
|
city
|
city | string | ||
|
signeeKey
|
signeeKey | True | string | |
|
processKey
|
processKey | True | string | |
|
powód
|
reason | string | ||
|
użytkownik
|
user | string |
Zwraca
Signee
- Signee
- Signee
Anulowanie procesu podpisywania
Anuluj proces podpisywania na podstawie danego klucza procesu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Unikatowy identyfikator procesu podpisywania pojedynczego dokumentu.
|
ProcessKey | string |
Unikatowy identyfikator procesu podpisywania pojedynczego dokumentu. |
|
|
Obiekt ciągu, zazwyczaj adres e-mail pracownika, który ma dostęp do portalu.
|
User | string |
Obiekt ciągu, zazwyczaj adres e-mail pracownika, który ma dostęp do portalu. |
Zwraca
PodpisywanieProcess
- PodpisywanieProcess
- SigningProcess
Anulowanie sekwencyjnego procesu podpisywania
Anuluj sekwencyjny proces podpisywania oparty na danym kluczu sekwencji. Użytkownik (wiadomość e-mail) może zostać udostępniony, który anuluje proces sekwencyjny.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator procesu podpisywania sekwencyjnego, który należy podać.
|
SequenceKey | True | string |
Identyfikator procesu podpisywania sekwencyjnego, który należy podać. |
|
Tylko użytkownik, który rozpoczął proces podpisywania, może go anulować.
|
User | True | string |
Tylko użytkownik, który rozpoczął proces podpisywania, może go anulować. |
Zwraca
Sekwencyjnesigning
- Sekwencyjnesigning
- SequentialSigning
Inicjuje proces uwierzytelniania przy użyciu islandzkego identyfikatora e-id
Uwierzytelnianie przy użyciu islandzkego e-idu można wykonać za pomocą telefonu komórkowego lub aplikacji Audkenni.
- Przy użyciu telefonu komórkowego: wartość AuthenticationContextType powinna być ustawiona na wartość "Sim", a numer telefonu musi być ustawiony na islandzki numer telefonu komórkowego. Ssn jest ignorowany.
- Za pomocą aplikacji Audkenni: właściwość AuthenticationContextType powinna być ustawiona na wartość "Aplikacja", a numer SSN musi być ustawiony na numer ubezpieczenia społecznego Icdlandic. Numer telefonu jest ignorowany.
klucz flowKey należy zawsze podać i jest dostępny w portalu Taktikal.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Ssn
|
ssn | string | ||
|
numer telefonu
|
phoneNumber | string | ||
|
flowKey
|
flowKey | True | string |
Unikatowy identyfikator przepływu należącego do firmy. |
|
authenticationContextType
|
authenticationContextType | True | string |
Zwraca
StartAuthResponse
- StartAuthResponse
- StartAuthResponse
Pobiera dziennik aktywności dla firmy
Pobiera dziennik aktywności dla firmy
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Data rozpoczęcia przeszukiwania dziennika musi być mniejsza niż Data zakończenia.
|
StartDate | True | date-time |
Data rozpoczęcia przeszukiwania dziennika musi być mniejsza niż Data zakończenia. |
|
Data zakończenia przeszukiwanego dziennika musi być większa niż Data rozpoczęcia.
|
EndDate | True | date-time |
Data zakończenia przeszukiwanego dziennika musi być większa niż Data rozpoczęcia. |
|
Służy do stronicowania zestawu wyników i zwracania tylko N wielu wyników.
|
Take | integer |
Służy do stronicowania zestawu wyników i zwracania tylko N wielu wyników. |
|
|
Służy do stronicowania zestawu wyników i pomijania pierwszych N wyników.
|
Skip | integer |
Służy do stronicowania zestawu wyników i pomijania pierwszych N wyników. |
|
|
Adres e-mail użytkownika.
|
User | string |
Adres e-mail użytkownika. |
|
|
Może służyć do pobierania działania tylko dla określonego typu przepływu.
|
FlowType | string |
Może służyć do pobierania działania tylko dla określonego typu przepływu. |
|
|
Jeśli ma ona wartość, zwracamy tylko rekordy zgodne z tym kluczem przepływu.
|
FlowKey | string |
Jeśli ma ona wartość, zwracamy tylko rekordy zgodne z tym kluczem przepływu. |
Zwraca
- Lista<SigningProcessActivityLogWrapper>
- array of SigningProcessActivityLogWrapper
Pobiera dziennik aktywności na potrzeby procesu podpisywania
Pobierz dziennik aktywności dla procesu podpisywania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Adres e-mail użytkownika.
|
User | string |
Adres e-mail użytkownika. |
|
|
Data rozpoczęcia przeszukiwania dziennika musi być mniejsza niż Data zakończenia.
|
StartDate | True | date-time |
Data rozpoczęcia przeszukiwania dziennika musi być mniejsza niż Data zakończenia. |
|
Data zakończenia przeszukiwanego dziennika musi być większa niż Data rozpoczęcia.
|
EndDate | True | date-time |
Data zakończenia przeszukiwanego dziennika musi być większa niż Data rozpoczęcia. |
|
Użyj opcji , jeśli mają być filtrowane w ramach pojedynczego procesu podpisywania.
|
ProcessKey | True | string |
Użyj opcji , jeśli mają być filtrowane w ramach pojedynczego procesu podpisywania. |
|
Może służyć do pobierania działania tylko dla określonego typu przepływu.
|
FlowType | string |
Może służyć do pobierania działania tylko dla określonego typu przepływu. |
|
|
służy do stronicowania zestawu wyników i zwracania tylko N wielu wyników.
|
Take | integer |
służy do stronicowania zestawu wyników i zwracania tylko N wielu wyników. |
|
|
służy do stronicowania zestawu wyników i pomijania pierwszych N wyników.
|
Skip | integer |
służy do stronicowania zestawu wyników i pomijania pierwszych N wyników. |
|
|
Jeśli ma ona wartość, zwracamy tylko rekordy zgodne z tym kluczem przepływu.
|
FlowKey | string |
Jeśli ma ona wartość, zwracamy tylko rekordy zgodne z tym kluczem przepływu. |
Zwraca
- Lista<SigningProcessActivityLogWrapper>
- array of SigningProcessActivityLogWrapper
Pobiera dziennik aktywności użytkownika (e-mail) dla określonego okresu
Pobiera dziennik aktywności użytkownika przez pewien okres.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Adres e-mail użytkownika.
|
User | string |
Adres e-mail użytkownika. |
|
|
Data rozpoczęcia przeszukiwania dziennika musi być mniejsza niż Data zakończenia.
|
StartDate | True | date-time |
Data rozpoczęcia przeszukiwania dziennika musi być mniejsza niż Data zakończenia. |
|
Data zakończenia przeszukiwanego dziennika musi być większa niż Data rozpoczęcia.
|
EndDate | True | date-time |
Data zakończenia przeszukiwanego dziennika musi być większa niż Data rozpoczęcia. |
|
Użyj opcji , jeśli mają być filtrowane w ramach pojedynczego procesu podpisywania.
|
ProcessKey | string |
Użyj opcji , jeśli mają być filtrowane w ramach pojedynczego procesu podpisywania. |
|
|
Może służyć do pobierania działania tylko dla określonego typu przepływu.
|
FlowType | string |
Może służyć do pobierania działania tylko dla określonego typu przepływu. |
|
|
Służy do stronicowania zestawu wyników i zwracania tylko N wielu wyników.
|
Take | integer |
Służy do stronicowania zestawu wyników i zwracania tylko N wielu wyników. |
|
|
Służy do stronicowania zestawu wyników i pomijania pierwszych N wyników.
|
Skip | integer |
Służy do stronicowania zestawu wyników i pomijania pierwszych N wyników. |
|
|
Jeśli ma ona wartość, zwracamy tylko rekordy zgodne z tym kluczem przepływu
|
FlowKey | string |
Jeśli ma ona wartość, zwracamy tylko rekordy zgodne z tym kluczem przepływu. |
Zwraca
- Lista<SigningProcessActivityLogWrapper>
- array of SigningProcessActivityLogWrapper
Pobiera proces podpisywania według właściwości processKey i signeeKey
Pobierz proces podpisywania za pomocą processkey i signeeKey.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Unikatowy identyfikator procesu podpisywania pojedynczego dokumentu.
|
ProcessKey | True | string |
Unikatowy identyfikator procesu podpisywania pojedynczego dokumentu. |
|
Unikatowy identyfikator osoby podpisującego pojedynczy proces podpisywania.
|
SigneeKey | True | string |
Unikatowy identyfikator osoby podpisującego pojedynczy proces podpisywania. |
|
Agent użytkownika to oprogramowanie działające dla użytkownika, takie jak przeglądarka internetowa lub klient poczty e-mail.
|
UserAgent | string |
Agent użytkownika to oprogramowanie działające dla użytkownika, takie jak przeglądarka internetowa lub klient poczty e-mail. |
Zwraca
PodpisywanieProcess
- PodpisywanieProcess
- SigningProcess
Rozpoczyna proces uwierzytelniania przy użyciu islandzkego identyfikatora e-id dla sekwencyjnych procesów podpisywania
Uwierzytelnianie przy użyciu islandzkego e-idu można wykonać za pomocą telefonu komórkowego lub aplikacji Audkenni.
- Przy użyciu telefonu komórkowego: wartość AuthenticationContextType powinna być ustawiona na wartość "Sim", a numer telefonu musi być ustawiony na numer telefonu komórkowego Ucelandic. Ssn jest ignorowany.
- Za pomocą aplikacji Audkenni: właściwość AuthenticationContextType powinna być ustawiona na wartość "Aplikacja", a numer SSN musi być ustawiony na numer ubezpieczenia społecznego Icdlandic. Numer telefonu jest ignorowany.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Unikatowy identyfikator procesów podpisywania sekwencji (zbiorczego).
|
SequenceKey | True | string |
Unikatowy identyfikator procesów podpisywania sekwencji (zbiorczego). |
|
sequenceKey
|
sequenceKey | True | string | |
|
loginHint
|
loginHint | True | string | |
|
authenticationContextType
|
authenticationContextType | True | string |
Zwraca
StartAuthResponse
- StartAuthResponse
- StartAuthResponse
Sprawdza stan uwierzytelniania użytkownika przy użyciu jego islandzkego identyfikatora e-id
Po pomyślnej odpowiedzi z /Auth/Start zwracany jest identyfikator AuthRequestId i służy do sprawdzania, czy uwierzytelnianie zostało zakończone. Jeśli uwierzytelnianie zostanie zakończone i zakończy się pomyślnie, obiekt klienta zostanie wypełniony w zależności od lookupType. Typ odnośnika wskazuje, że typ informacji jest pobierany dla rejestru narodowego islandii.
Istnieją trzy różne zestawy danych zwracane w zależności od elementu LookupType:
Nazwa: zwróci tylko nazwę SSN i nazwę uwierzytelnionej osoby. Nie ma to dodatkowych kosztów wyszukiwania.
NameAddress: zwróci informacje o nazwie, nazwie SSN i adresie. Ma to dodatkowy koszt wyszukiwania. Jest to wartość domyślna, jeśli dla parametru LookupType nie podano żadnej wartości.
NameAddressFamily: zwraca nazwę, SSN, dane adresu, kod płci i informacje o rodzinie.
Jeśli wybrano opcję "LookupType.NameAddressFamily", zwracane będą dodatkowe wartości w meta.
Jeśli odpowiedź zawiera błędy lub nie zostanie zakończona, obiekt klienta będzie miał wartość null, a komunikat StatusMessage będzie zawierać szczegółowy komunikat.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
authRequestId
|
authRequestId | True | string | |
|
flowKey
|
flowKey | True | string |
Unikatowy identyfikator przepływu należącego do firmy. |
|
lookupType (typ wyszukiwania)
|
lookupType | True | string |
Zwraca
PollCustomer
- PollCustomer
- PollCustomer
Tworzy nowe procesy podpisywania sekwencyjnego (zbiorczego)
Tworzy nowy sekwencyjny proces podpisywania (zbiorczy) z co najmniej jednym procesem podpisywania. Każdy proces podpisywania w sekwencji ma co najmniej jeden znak.
Przykład:
- Firma chce mieć podpisany dokument A i B. Signee X powinien podpisać dokument A i B, Signee Y powinien podpisać dokument A i Signee Z powinien podpisać dokument B.
- Następnie nowy element CreateSequentalSigning z tablicą dwóch obiektów CreateSigningProcess. Znaki X i Y są dodawane jako znaki dla elementu CreateSigningProcess dla dokumentów A i znaki X i Z są dodawane jako znaki dla dokumentu B.
Szczegółową dokumentację można znaleźć na stronie https://docs.taktikal.is/docs/api/using-the-signing-api/sequence-signing/
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
pdfDocument
|
pdfDocument | string |
to ciąg base64 dokumentu do podpisania. Nie jest to wymagane, jeśli klucz flowKey zajmuje się tworzeniem dokumentu. |
|
|
pdfFileName
|
pdfFileName | string |
Jeśli plik PdfDocument jest używany, należy podać wartość dla nazwy pliku. |
|
|
flowKey
|
flowKey | True | string |
Wartość FlowKey jest dostarczana przez taktikal. Ten klucz poinformuje Taktikal, jak obsłużyć to żądanie. W przypadku niektórych elementów flowKeys Taktikal zajmie się tworzeniem dokumentu. Będzie on również kontrolować, gdzie podpisany dokument jest dostarczany po podpisaniu. |
|
processKey
|
processKey | string | ||
|
nazwa
|
name | string | ||
|
Ssn
|
ssn | string | ||
|
numer telefonu
|
phoneNumber | string | ||
|
e-mail
|
string | |||
|
address
|
address | string | ||
|
postalCode
|
postalCode | string | ||
|
city
|
city | string | ||
|
powód
|
reason | string | ||
|
hidePersonalCode
|
hidePersonalCode | boolean | ||
|
communicationDeliveryType
|
communicationDeliveryType | string | ||
|
customSmsText
|
customSmsText | string | ||
|
signatureType
|
signatureType | string | ||
|
język
|
language | string | ||
|
Słownik
|
meta | object |
Ciąg słownika<, ciąg> |
|
|
fileName
|
fileName | string | ||
|
fileContent
|
fileContent | string | ||
|
id
|
id | string | ||
|
fileName
|
fileName | string | ||
|
contentLength
|
contentLength | integer | ||
|
typ treści
|
contentType | string | ||
|
URL
|
url | string | ||
|
opis
|
description | string | ||
|
processKey
|
processKey | string | ||
|
attachmentType
|
attachmentType | string | ||
|
signeeKey
|
signeeKey | string | ||
|
wymaga uwierzytelniania
|
requiresAuth | boolean |
Wartość domyślna to false. Jeśli ustawiono wartość true, wszyscy osoby podpisające muszą używać tam identyfikatora e-ID do uwierzytelniania przed wyświetleniem dokumentu. |
|
|
signInOrder
|
signInOrder | boolean |
Wartość domyślna to false. Będzie kontrolować kolejność podpisujących. Będzie wysyłać tylko żądanie podpisania do pierwszej osoby na liście osób podpisujących, aby rozpocząć od. Po podpisaniu następnego signee i tak dalej. |
|
|
signatureLocation
|
signatureLocation | string |
Może to być wartość BottomLastPage lub wartość domyślna TopFirstPage. Steruje miejscem wyświetlania podpisu w dokumencie. |
|
|
użytkownik
|
user | string |
adres e-mail użytkownika wysyłającego żądanie. Może być pusty. |
|
|
sequenceKey
|
sequenceKey | string | ||
|
activityDisplayName
|
activityDisplayName | string | ||
|
flattenDocument
|
flattenDocument | boolean |
Wartość domyślna to false. W przypadku ustawienia wartości true spróbujemy spłaszać pola wejściowe dokumentów. |
|
|
reminderRule
|
reminderRule | string |
Wysyła przypomnienia, pozostaw puste dla żadnego. format powinien mieć wartość "firstReminder after x days:Then every y days", np. "1:3" będzie wysyłać jedno przypomnienie po 1 dniu, a następnie co trzy dni po tym. Pozostaw puste lub zerowe dla żadnych przypomnień, prawidłowe wartości będą wysyłane przez pierwsze przypomnienie z zakresu od 0 do 30 dni (0 oznacza brak przypomnienia), a następnie wysyłać co 0–15 dni (0, ponownie, co oznacza brak przypomnień, więc 0:10 wysyła przypomnienie tylko co 10 dni, podczas gdy 12:0 wysyła tylko jedno przypomnienie po 12 dniach |
|
|
użytkownik
|
user | True | string |
Użytkownik, który uruchamia sekwencyjny proces podpisywania |
|
wymaga uwierzytelniania
|
requiresAuth | boolean |
Wartość domyślna to false. Jeśli ustawiono wartość true, wszyscy osoby podpisające muszą używać tam identyfikatora e-ID do uwierzytelniania przed wyświetleniem dokumentu. |
|
|
signInOrder
|
signInOrder | boolean |
Wartość domyślna to false. Będzie kontrolować kolejność podpisujących. Będzie wysyłać tylko żądanie podpisania do pierwszej osoby na liście osób podpisujących, aby rozpocząć od. Po podpisaniu następnego signee i tak dalej. |
Zwraca
Sekwencyjnesigning
- Sekwencyjnesigning
- SequentialSigning
Tworzy nowy proces podpisywania z co najmniej jednym znakiem
Tworzy nowy proces podpisywania z co najmniej jednym znakiem.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
pdfDocument
|
pdfDocument | string |
to ciąg base64 dokumentu do podpisania. Nie jest to wymagane, jeśli klucz flowKey zajmuje się tworzeniem dokumentu. |
|
|
pdfFileName
|
pdfFileName | string |
Jeśli plik PdfDocument jest używany, należy podać wartość dla nazwy pliku. |
|
|
flowKey
|
flowKey | True | string |
Wartość FlowKey jest dostarczana przez taktikal. Ten klucz poinformuje Taktikal, jak obsłużyć to żądanie. W przypadku niektórych elementów flowKeys Taktikal zajmie się tworzeniem dokumentu. Będzie on również kontrolować, gdzie podpisany dokument jest dostarczany po podpisaniu. |
|
processKey
|
processKey | string | ||
|
nazwa
|
name | string | ||
|
Ssn
|
ssn | string | ||
|
numer telefonu
|
phoneNumber | string | ||
|
e-mail
|
string | |||
|
address
|
address | string | ||
|
postalCode
|
postalCode | string | ||
|
city
|
city | string | ||
|
powód
|
reason | string | ||
|
hidePersonalCode
|
hidePersonalCode | boolean | ||
|
communicationDeliveryType
|
communicationDeliveryType | string | ||
|
customSmsText
|
customSmsText | string | ||
|
signatureType
|
signatureType | string | ||
|
język
|
language | string | ||
|
Słownik
|
meta | object |
Ciąg słownika<, ciąg> |
|
|
fileName
|
fileName | string | ||
|
fileContent
|
fileContent | string | ||
|
id
|
id | string | ||
|
fileName
|
fileName | string | ||
|
contentLength
|
contentLength | integer | ||
|
typ treści
|
contentType | string | ||
|
URL
|
url | string | ||
|
opis
|
description | string | ||
|
processKey
|
processKey | string | ||
|
attachmentType
|
attachmentType | string | ||
|
signeeKey
|
signeeKey | string | ||
|
wymaga uwierzytelniania
|
requiresAuth | boolean |
Wartość domyślna to false. Jeśli ustawiono wartość true, wszyscy osoby podpisające muszą używać tam identyfikatora e-ID do uwierzytelniania przed wyświetleniem dokumentu. |
|
|
signInOrder
|
signInOrder | boolean |
Wartość domyślna to false. Będzie kontrolować kolejność podpisujących. Będzie wysyłać tylko żądanie podpisania do pierwszej osoby na liście osób podpisujących, aby rozpocząć od. Po podpisaniu następnego signee i tak dalej. |
|
|
signatureLocation
|
signatureLocation | string |
Może to być wartość BottomLastPage lub wartość domyślna TopFirstPage. Steruje miejscem wyświetlania podpisu w dokumencie. |
|
|
użytkownik
|
user | string |
adres e-mail użytkownika wysyłającego żądanie. Może być pusty. |
|
|
sequenceKey
|
sequenceKey | string | ||
|
activityDisplayName
|
activityDisplayName | string | ||
|
flattenDocument
|
flattenDocument | boolean |
Wartość domyślna to false. W przypadku ustawienia wartości true spróbujemy spłaszać pola wejściowe dokumentów. |
|
|
reminderRule
|
reminderRule | string |
Wysyła przypomnienia, pozostaw puste dla żadnego. format powinien mieć wartość "firstReminder after x days:Then every y days", np. "1:3" będzie wysyłać jedno przypomnienie po 1 dniu, a następnie co trzy dni po tym. Pozostaw puste lub zerowe dla żadnych przypomnień, prawidłowe wartości będą wysyłane przez pierwsze przypomnienie z zakresu od 0 do 30 dni (0 oznacza brak przypomnienia), a następnie wysyłać co 0–15 dni (0, ponownie, co oznacza brak przypomnień, więc 0:10 wysyła przypomnienie tylko co 10 dni, podczas gdy 12:0 wysyła tylko jedno przypomnienie po 12 dniach |
Zwraca
PodpisywanieProcess
- PodpisywanieProcess
- SigningProcess
Uszczelnia dokument XML
Uszczelnia dostarczony dokument XML jako ciąg base64.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
xmlDocument
|
xmlDocument | True | string |
Base64String dokumentu XML w celu uszczelnienia |
|
flowKey
|
flowKey | True | string |
Prawidłowy klucz przepływu dostarczony przez Taktikal, którego można użyć do uszczelnienia |
Zwraca
Object
- response
- object
Zapieczętuje dokument PDF
Zapieczętuje dostarczony dokument PDF jako ciąg base64.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
pdfDocument
|
pdfDocument | True | string |
Zapieczętowanie dokumentu PDF w formacie Base64String. |
|
flowKey
|
flowKey | True | string |
Unikatowy identyfikator przepływu należącego do firmy. |
|
powód
|
reason | string |
ustaw przyczynę wyświetlania w uszczelnieniu |
|
|
languageType
|
languageType | string |
Zwraca
UszczelnienieResponse
- UszczelnienieResponse
- SealingResponse
Definicje
Signee
Signee
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string | |
|
Ssn
|
ssn | string | |
|
numer telefonu
|
phoneNumber | string | |
|
e-mail
|
string | ||
|
address
|
address | string | |
|
postalCode
|
postalCode | string | |
|
city
|
city | string | |
|
klucz
|
key | string | |
|
Podpisane
|
signed | boolean | |
|
signedAt
|
signedAt | date-time | |
|
processKey
|
processKey | string | |
|
powód
|
reason | string | |
|
hidePersonalCode
|
hidePersonalCode | boolean | |
|
communicationDeliveryType
|
communicationDeliveryType | string | |
|
URL
|
url | string | |
|
signatureType
|
signatureType | string | |
|
język
|
language | string | |
|
customSmsText
|
customSmsText | string |
Dołączenie do podpisywania
Dołączenie do podpisywania
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
fileName
|
fileName | string | |
|
fileContent
|
fileContent | string |
AttachmentReference
AttachmentReference
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string | |
|
fileName
|
fileName | string | |
|
contentLength
|
contentLength | integer | |
|
typ treści
|
contentType | string | |
|
URL
|
url | string | |
|
opis
|
description | string | |
|
processKey
|
processKey | string | |
|
attachmentType
|
attachmentType | string | |
|
signeeKey
|
signeeKey | string |
Dictionary_String_String_
Ciąg słownika<, ciąg>
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Słownik
|
object |
Ciąg słownika<, ciąg> |
SigningProcessActivityLogWrapper
SigningProcessActivityLogWrapper
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
processKey
|
processKey | string | |
|
activityLog
|
activityLog | array of SigningProcessActivityLog | |
|
Sygnatariusze
|
signees | array of SigneeActivityLog | |
|
sequenceSignees
|
sequenceSignees | array of SequentialSigningSigneeActivityLog | |
|
attachmentReferences
|
attachmentReferences | array of AttachmentReference | |
|
activityDisplayName
|
activityDisplayName | string |
SigningProcessActivityLog
SigningProcessActivityLog
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
flowKey
|
flowKey | string |
Unikatowy identyfikator przepływu należącego do firmy. |
|
processKey
|
processKey | string | |
|
signeeKey
|
signeeKey | string | |
|
stan
|
status | string | |
|
opis
|
description | string | |
|
userAgent
|
userAgent | string | |
|
fileName
|
fileName | string | |
|
createdAt
|
createdAt | date-time | |
|
utworzone przez
|
createdBy | string | |
|
wymaga uwierzytelniania
|
requiresAuth | boolean | |
|
signInOrder
|
signInOrder | boolean | |
|
signatureLocation
|
signatureLocation | string | |
|
sequenceKey
|
sequenceKey | string |
SigneeActivityLog
SigneeActivityLog
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
processKey
|
processKey | string | |
|
signeeKey
|
signeeKey | string | |
|
Ssn
|
ssn | string | |
|
nazwa
|
name | string | |
|
address
|
address | string | |
|
postalCode
|
postalCode | string | |
|
city
|
city | string | |
|
phone
|
phone | string | |
|
e-mail
|
string | ||
|
createdAt
|
createdAt | date-time | |
|
utworzone przez
|
createdBy | string | |
|
updatedAt
|
updatedAt | date-time | |
|
signatureType
|
signatureType | string |
SekwencyjneSigningSigneeActivityLog
SekwencyjneSigningSigneeActivityLog
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
sequenceKey
|
sequenceKey | string | |
|
signeeKey
|
signeeKey | string | |
|
URL
|
url | string | |
|
signingKeys
|
signingKeys | array of SigneeKeys |
SigneeKeys
SigneeKeys
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
signeeKey
|
signeeKey | string | |
|
processKey
|
processKey | string |
Sekwencyjnesigning
Sekwencyjnesigning
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
klucz
|
key | string | |
|
stan
|
status | string | |
|
wymaga uwierzytelniania
|
requiresAuth | boolean | |
|
użytkownik
|
user | string | |
|
signInOrder
|
signInOrder | boolean | |
|
Sygnatariusze
|
signees | array of SequentialSigningSignee | |
|
signingProcesses
|
signingProcesses | array of SigningProcess |
SekwencyjneSigningSignee
SekwencyjneSigningSignee
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
klucz
|
key | string | |
|
URL
|
url | string | |
|
signingKeys
|
signingKeys | array of SigneeKeys |
PodpisywanieProcess
PodpisywanieProcess
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
klucz
|
key | string | |
|
Sygnatariusze
|
signees | array of Signee | |
|
flowKey
|
flowKey | string |
Unikatowy identyfikator przepływu należącego do firmy. |
|
stan
|
status | string | |
|
Słownik
|
meta | Dictionary_String_String_ |
Ciąg słownika<, ciąg> |
|
pdfFileName
|
pdfFileName | string | |
|
attachments
|
attachments | array of SigningAttachment | |
|
attachmentReferences
|
attachmentReferences | array of AttachmentReference | |
|
wymaga uwierzytelniania
|
requiresAuth | boolean | |
|
użytkownik
|
user | string | |
|
signInOrder
|
signInOrder | boolean | |
|
signatureLocation
|
signatureLocation | string | |
|
sequenceKey
|
sequenceKey | string | |
|
flattenDocument
|
flattenDocument | boolean |
StartAuthResponse
StartAuthResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
authRequestId
|
authRequestId | string | |
|
verificationCode
|
verificationCode | string |
UszczelnienieResponse
UszczelnienieResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
pdfDocument
|
pdfDocument | string |
Klient
Klient
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string | |
|
Ssn
|
ssn | string | |
|
numer telefonu
|
phoneNumber | string | |
|
e-mail
|
string | ||
|
address
|
address | string | |
|
postalCode
|
postalCode | string | |
|
city
|
city | string | |
|
kod przedpłaty
|
token | string | |
|
flowKey
|
flowKey | string |
Unikatowy identyfikator przepływu należącego do firmy. |
|
Słownik
|
meta | Dictionary_String_String_ |
Ciąg słownika<, ciąg> |
PollCustomer
PollCustomer
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Klient
|
customer | Customer |
Klient |
|
Komunikat o statusie
|
statusMessage | string | |
|
oczekiwanieForUserInput
|
waitingForUserInput | boolean |
obiekt
Jest to typ 'obiekt'.