Udostępnij przez

Interfejs API uniwersalny dokobit

Dokobit Universal API to uniwersalne narzędzie, które umożliwia wewnętrzne podpisywanie dokumentów w systemie i zbieranie podpisów od innych firm spoza systemu w Całej Europie. Podpisywanie dokumentów odbywa się w bezkonseksowym podpisywaniu dokobitu (gdzie zaproszeni uczestnicy mogą podpisywać dokumenty bez rejestrowania się w portalu Dokobit) za pomocą znakowania organizacji.

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 Dokobit
adres URL https://support.dokobit.com
Email developers@dokobit.com
Metadane łącznika
Publisher Dokobit
Witryna internetowa https://www.dokobit.com/solutions
Zasady ochrony prywatności https://www.dokobit.com/compliance/privacy-policy
Kategorie Produktywność

Dokobit Universal API to uniwersalne narzędzie, które umożliwia wewnętrzne podpisywanie dokumentów w systemie i zbieranie podpisów od innych firm spoza systemu w Całej Europie. Podpisywanie dokumentów odbywa się w bezkonseksowym podpisywaniu dokobitu (gdzie zaproszeni uczestnicy mogą podpisywać dokumenty bez rejestrowania się w portalu Dokobit) za pomocą znakowania organizacji.

Wymagania wstępne

Aby uzyskać token dostępu do interfejsu API, skontaktuj się z nami pod adresem sales@dokobit.com Dokobit Universal API.

Jak uzyskać poświadczenia

Skontaktuj się z naszą sprzedażą, aby uzyskać token dostępu interfejsu API

Wprowadzenie do łącznika

  • Podpisywanie dokumentów można zainicjować przy użyciu akcji "DokobitUniversalAPICreateExternalSigning" lub "DokobitUniversalAPICreateInternalSigning". Użycie polecenia "DokobitUniversalAPICreateExternalSigning" spowoduje wysłanie zaproszenia do podpisania do uczestników. "DokobitUniversalAPICreateInternalSigning" wygeneruje adres URL podpisywania, pod którym użytkownicy mogą być przekierowywani.
  • Następnie można zarządzać podpisywaniem przy użyciu odpowiednich akcji umożliwiających dodawanie/usuwanie uczestników, wysyłanie przypomnień lub sprawdzanie stanu podpisywania dokumentu.
  • Po podpisaniu dokumentu przez uczestników można go pobrać za pomocą akcji "DokobitUniversalAPIDownloadDocumentExternal" lub "DokobitUniversalAPIDownloadDocumentInternal".

Znane problemy i ograniczenia

Bieżąca implementacja obsługuje zbieranie podpisów w plikach PDF i obsługiwane przez kontenery ASiCe, ADoc, BDoc lub EDoc.

Typowe błędy i środki zaradcze

  • Plik musi być udostępniany jako zawartość pliku zakodowanego w formacie Base64.
  • Jeśli podpisywanie dokumentu "Type" jest ustawione na "pdf", podczas podpisywania dokumentu zostanie zaakceptowany pojedynczy dokument PDF. W przypadku wielu plików ustaw wartość "Typ" podpisywania na "asice" lub inny format kontenera.

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 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 podpisywania wewnętrznego

Umożliwia aktualizowanie atrybutów istniejącego podpisywania dokumentu.
Aktualizowanie podpisywania zewnętrznego

Umożliwia aktualizowanie atrybutów istniejącego podpisywania dokumentu.
Dodawanie wewnętrznego sygnatariusza

Wskazani uczestnicy uzyskają dostęp do dokumentu z wybraną rolą.
Dodawanie zewnętrznego podpisywania

Wskazani uczestnicy uzyskają dostęp do dokumentu z wybraną rolą.
E-Delivery

Usługa Document e-Delivery służy do bezpiecznego udostępniania dokumentów za pomocą uniwersalnego interfejsu API Dokobit.
Pobieranie dokumentu wewnętrznego

Pobiera podpisany dokument.
Pobieranie dokumentu zewnętrznego

Pobiera podpisany dokument.
Podpisywanie pieczęć

Dokument zostanie zapieczętowany elektroniczną pieczętą Organizacji. Skontaktuj się z naszym pomocą techniczną pod adresem developers@dokobit.com , aby uzyskać kwalifikowany certyfikat do uszczelnienia elektronicznego.
Sprawdzanie stanu podpisywania wewnętrznego

Zwraca informacje o dokumencie ze stanem podpisywania.
Sprawdzanie stanu podpisywania zewnętrznego

Zwraca informacje o dokumencie ze stanem podpisywania.
Tworzenie podpisywania zewnętrznego

Podpisywanie zewnętrzne inicjuje asynchroniczne żądanie podpisania z systemu. W takim przypadku użytkownik otrzyma wiadomość e-mail na potrzeby podpisania i otrzymasz wywołanie zwrotne po podpisaniu dokumentu.
Tworzenie wewnętrznego podpisywania

Wewnętrzne podpisywanie inicjuje żądanie podpisania z systemu. W takim przypadku adres URL podpisywania jest generowany, gdzie uczestnik powinien zostać przekierowany.
Usuwanie podpisywania wewnętrznego

Dokument zostanie usunięty z konta właściciela. Pozostanie ona dostępna dla innych uczestników.
Usuwanie podpisywania zewnętrznego

Dokument zostanie usunięty z konta właściciela. Pozostanie ona dostępna dla innych uczestników.
Usuwanie wewnętrznego sygnatariusza

Dostęp do dokumentu zostanie odwołany dla wskazanego uczestnika.
Usuwanie zewnętrznego sygnatariusza

Dostęp do dokumentu zostanie odwołany dla wskazanego uczestnika.
Validation

Dokobit jest certyfikowanym dostawcą usług eIDAS na potrzeby kwalifikowanych weryfikacji podpisów elektronicznych i e-seal. Użyj tej akcji, aby przekazać podpisany plik do weryfikacji. Obsługiwane typy plików: asice, , scebdocedocasics, pdf, . p7sxml
Walidacja — dane diagnostyczne XML

Pobierz dane diagnostyczne w formacie XML.
Walidacja — raport PDF

Pobierz raport weryfikacji w pliku PDF.
Walidacja — raport XML

Pobierz raport weryfikacji w formacie XML.
Walidacja — szczegółowy raport PDF

Pobierz szczegółowy raport weryfikacji w pliku PDF.
Wyślij przypomnienie

Umożliwia wysłanie wiadomości e-mail z przypomnieniem dla uczestnika, tylko wtedy, gdy osoba nie podpisała jeszcze dokumentu. Działa tylko z zewnętrznym przepływem podpisywania.

Aktualizowanie podpisywania wewnętrznego

Identyfikator operacji:
DokobitUniversalAPIUpdateInternalSigning

Umożliwia aktualizowanie atrybutów istniejącego podpisywania dokumentu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Token podpisywania
 token True string

Token podpisywania.
Wymagaj kwalifikowanych podpisów
 require_qualified_signatures boolean

Zezwalaj na podpisywanie tylko przy użyciu kwalifikowanych podpisów. Wartość domyślna: false.
Zezwalaj na identyfikację wideo
 allow_video_identification boolean

Zezwalaj na podpisywanie przy użyciu identyfikacji opartej na wideo. Wartość domyślna: false.
Dozwolone metody podpisywania
 allowed_signing_methods array of string

Zezwalaj tylko na określone metody podpisywania. Dostępne wartości: mobile, smartideparaksts_mobilebankid_nobankid_seelectronic_idftnaudkenni_appsmartcarditsmeidinmitid, , . sms_otpswisscom

Zwraca

Nazwa Ścieżka Typ Opis
Status
 status string

Stan.

Aktualizowanie podpisywania zewnętrznego

Identyfikator operacji:
DokobitUniversalAPIUpdateExternalSigning

Umożliwia aktualizowanie atrybutów istniejącego podpisywania dokumentu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Token podpisywania
 token True string

Token podpisywania.
Deadline
 deadline date-time

Data terminu podpisania z określonym fragmentem strefy czasowej. Przykład: 2018-11-05T13:15:30Z.
Ostateczny termin
 hard_deadline boolean

Jeśli ustawiono wartość na true uczestników, po ustawieniu deadlineelementu nie będzie można podpisać ani zatwierdzić tego dokumentu. Wartość domyślna: false.
Wymagaj kwalifikowanych podpisów
 require_qualified_signatures boolean

Zezwalaj na podpisywanie tylko przy użyciu kwalifikowanych podpisów. Wartość domyślna: false.
Zezwalaj na identyfikację wideo
 allow_video_identification boolean

Zezwalaj na podpisywanie przy użyciu identyfikacji opartej na wideo. Wartość domyślna: false.
Zezwalaj na zapisywanie dokumentów
 allow_document_saving boolean

Zezwalaj użytkownikowi na zapisywanie dokumentu w portalu Dokobit i wykonywanie dalszych akcji. Wartość domyślna: true.
Dozwolone metody podpisywania
 allowed_signing_methods array of string

Zezwalaj tylko na określone metody podpisywania. Dostępne wartości: mobile, smartideparaksts_mobilebankid_nobankid_seelectronic_idftnaudkenni_appsmartcarditsmeidinmitid, , . sms_otpswisscom

Zwraca

Nazwa Ścieżka Typ Opis
Status
 status string

Stan.

Dodawanie wewnętrznego sygnatariusza

Identyfikator operacji:
DokobitUniversalAPIAddInternalSigner

Wskazani uczestnicy uzyskają dostęp do dokumentu z wybraną rolą.

Parametry

Nazwa Klucz Wymagane Typ Opis
Token podpisywania
 token True string

Token podpisywania.
Tożsamość zewnętrzna
 external_id True string

Unikatowy losowy identyfikator uczestnika z systemu. Jeśli go nie masz, możesz wygenerować unikatowe identyfikatory losowe.
Role
 role string

Rola uczestnika. Dostępne wartości: signer, viewer. Wartość domyślna: signer.
Code
 code string

Kod uczestnika.
Kod kraju
 country_code string

Kod kraju uczestnika. Wymagane w przypadku podania kodu osobistego. Dostępne wartości: LT, LVPLEENOFIIS, , BE, . SE
Telefon
 phone string

Telefon uczestnika.
Język powiadomień
 language string

Ustawia język interfejsu użytkownika. Dostępne wartości: en, ltdklvfideisetnofrse. nl
Strona
 page string

Indeks strony dla widocznej adnotacji podpisu PDF. Dotyczy tylko podpisywania typu PDF. Wartość domyślna: 1.
Położenie od góry
 top string

Pozycja (w punktach) od góry dla widocznej adnotacji podpisu PDF. Dotyczy tylko podpisywania typu PDF. Wartość domyślna: 1.
Położenie od lewej
 left string

Pozycja (w punktach) po lewej stronie dla widocznej adnotacji podpisu PDF. Dotyczy tylko podpisywania typu PDF. Wartość domyślna: 1.
Język
 language string

Język widocznej adnotacji podpisu PDF. Dotyczy tylko podpisywania typu PDF. Dostępne wartości: en, , lvlt, , etis
Przyczyna niestandardowa
 custom_reason string

Przyczyna podpisu niestandardowego.

Zwraca

Nazwa Ścieżka Typ Opis
Status
 status string

Stan.
Sygnatariuszy
 signers array of object

Informacje o uczestnikach.
Tożsamość zewnętrzna
 signers.external_id string

Unikatowy losowy identyfikator uczestnika z systemu.
Żeton
 signers.token string

Token uczestnika.
Name
 signers.name string

Nazwa uczestnika.
Surname
 signers.surname string

Nazwisko uczestnika.
E-mail
 signers.email string

Adres e-mail uczestnika.
Code
 signers.code string

Osobisty kod uczestnika (krajowy numer identyfikacyjny).
Kod kraju
 signers.country_code string

Kraj uczestnika.
Role
 signers.role string

Rola uczestnika.
Firma
 signers.company string

Firma uczestnika.
Position
 signers.position string

Pozycja uczestnika.
Telefon
 signers.phone string

Telefon uczestnika.

Dodawanie zewnętrznego podpisywania

Identyfikator operacji:
DokobitUniversalAPIAddExternalSigner

Wskazani uczestnicy uzyskają dostęp do dokumentu z wybraną rolą.

Parametry

Nazwa Klucz Wymagane Typ Opis
Token podpisywania
 token True string

Token podpisywania.
Tożsamość zewnętrzna
 external_id True string

Unikatowy losowy identyfikator uczestnika z systemu. Jeśli go nie masz, możesz wygenerować unikatowe identyfikatory losowe.
Name
 name string

Nazwa uczestnika.
Surname
 surname string

Nazwisko uczestnika.
E-mail
 email string

Adres e-mail uczestnika.
Code
 code string

Kod uczestnika.
Kod kraju
 country_code string

Kod kraju uczestnika. Wymagane w przypadku podania kodu osobistego. Dostępne wartości: LT, LVNOISFIEE, , BE, . SE
Role
 role string

Rola uczestnika. Dostępne wartości: signer, viewer. Wartość domyślna: signer.
Firma
 company string

Firma uczestnika.
Position
 position string

Pozycja uczestnika.
Telefon
 phone string

Telefon uczestnika.
Przyczyna niestandardowa
 custom_reason string

Przyczyna podpisu niestandardowego.
Język powiadomień
 notifications_language string

Ustawia język powiadomień. Dostępne wartości: en, ltdklvfideisetnofrse. nl
Strona
 page string

Indeks strony dla widocznej adnotacji podpisu PDF. Dotyczy tylko podpisywania typu PDF. Wartość domyślna: 1.
Położenie od góry
 top string

Pozycja (w punktach) od góry dla widocznej adnotacji podpisu PDF. Dotyczy tylko podpisywania typu PDF. Wartość domyślna: 1.
Położenie od lewej
 left string

Pozycja (w punktach) po lewej stronie dla widocznej adnotacji podpisu PDF. Dotyczy tylko podpisywania typu PDF. Wartość domyślna: 1.
Język
 language string

Język widocznej adnotacji podpisu PDF. Dotyczy tylko podpisywania typu PDF. Dostępne wartości: en, , lvlt, , etis
Comment
 comment string

Wiadomość dla uczestników.

Zwraca

Nazwa Ścieżka Typ Opis
Status
 status string

Stan.
Sygnatariuszy
 signers array of object

Informacje o uczestnikach.
Tożsamość zewnętrzna
 signers.external_id string

Unikatowy losowy identyfikator uczestnika z systemu.
Żeton
 signers.token string

Token uczestnika.
Name
 signers.name string

Nazwa uczestnika.
Surname
 signers.surname string

Nazwisko uczestnika.
E-mail
 signers.email string

Adres e-mail uczestnika.
Code
 signers.code string

Osobisty kod uczestnika (krajowy numer identyfikacyjny).
Kod kraju
 signers.country_code string

Kraj uczestnika.
Role
 signers.role string

Rola uczestnika.
Firma
 signers.company string

Firma uczestnika.
Position
 signers.position string

Pozycja uczestnika.
Język powiadomień
 signers.notifications_language string

Ustawia język powiadomień. Dostępne wartości: en, , lvisltetno'fr', 'se', 'de'.
Telefon
 signers.phone string

Telefon uczestnika.

E-Delivery

Identyfikator operacji:
DokobitUniversalAPIeDelivery

Usługa Document e-Delivery służy do bezpiecznego udostępniania dokumentów za pomocą uniwersalnego interfejsu API Dokobit.

Parametry

Nazwa Klucz Wymagane Typ Opis
Typ
 type True string

Format dokumentu. Dostępne wartości: pdf.
Name
 name True string

Nazwa dokumentu wyświetlana dla użytkownika.
Adres URL ogłaszania zwrotnego
 postback_url string

Adres URL systemu do obsługi elementów webhook.
Comment
 comment string

Wiadomość dla adresatów.
Name
 name True string

Nazwa pliku.
Content
 content True string

Zawartość pliku zakodowanego w formacie Base64.
Tożsamość zewnętrzna
 external_id True string

Unikatowy losowy identyfikator uczestnika z systemu. Jeśli go nie masz, możesz wygenerować unikatowe identyfikatory losowe.
Code
 code True string

Osobisty kod odbiorcy (numer identyfikacyjny kraju).
Kod kraju
 country_code True string

Kod kraju odbiorcy. Wymagane w przypadku podania kodu osobistego. Dostępne wartości: lt, , eelv, is.
E-mail
 email string

Adres e-mail adresata do wysyłania dokumentu. Wymagane, jeśli telefon nie jest ustawiony.
Telefon
 phone string

Numer telefonu odbiorcy na potrzeby wysyłania wiadomości SMS do dokumentu. Wymagane, jeśli wiadomość e-mail nie jest ustawiona. Wiadomość SMS zostanie wysłana tylko wtedy, gdy wiadomość e-mail nie zostanie podana.
Język powiadomień
 notifications_language string

Ustawia język powiadomień. Dostępne wartości: en, , lvisltetno'fr', 'se', 'de'.

Zwraca

Nazwa Ścieżka Typ Opis
Status
 status string

Stan.
Token dokumentu
 token string

Token dokumentu.
Adresatów
 recipients array of object

Informacje adresata.
Tożsamość zewnętrzna
 recipients.external_id string

Unikatowy losowy identyfikator uczestnika z systemu.
Żeton
 recipients.token string

Token adresata.
Code
 recipients.code string

Osobisty kod odbiorcy (numer identyfikacyjny kraju).
Country
 recipients.country string

Kraj odbiorcy.
E-mail
 recipients.email string

Adres e-mail adresata.

Pobieranie dokumentu wewnętrznego

Identyfikator operacji:
DokobitUniversalAPIDownloadDocumentInternal

Pobiera podpisany dokument.

Parametry

Nazwa Klucz Wymagane Typ Opis
Token podpisywania
 token True string

Token podpisywania.

Zwraca

response
object

Pobieranie dokumentu zewnętrznego

Identyfikator operacji:
DokobitUniversalAPIDownloadDocumentExternal

Pobiera podpisany dokument.

Parametry

Nazwa Klucz Wymagane Typ Opis
Token podpisywania
 token True string

Token podpisywania.

Zwraca

response
object

Podpisywanie pieczęć

Identyfikator operacji:
DokobitUniversalAPISealSigning

Dokument zostanie zapieczętowany elektroniczną pieczętą Organizacji. Skontaktuj się z naszym pomocą techniczną pod adresem developers@dokobit.com , aby uzyskać kwalifikowany certyfikat do uszczelnienia elektronicznego.

Parametry

Nazwa Klucz Wymagane Typ Opis
Token podpisywania
 token True string

Token podpisywania.
Przyczyna niestandardowa
 custom_reason string

Przyczyna podpisu niestandardowego.
Strona
 page string

Indeks strony dla widocznej adnotacji podpisu PDF. Dotyczy tylko podpisywania typu PDF. Wartość domyślna: 1.
Położenie od góry
 top string

Pozycja (w punktach) od góry dla widocznej adnotacji podpisu PDF. Dotyczy tylko podpisywania typu PDF. Wartość domyślna: 1.
Położenie od lewej
 left string

Pozycja (w punktach) po lewej stronie dla widocznej adnotacji podpisu PDF. Dotyczy tylko podpisywania typu PDF. Wartość domyślna: 1.

Zwraca

Nazwa Ścieżka Typ Opis
Status
 status string

Stan.

Sprawdzanie stanu podpisywania wewnętrznego

Identyfikator operacji:
DokobitUniversalAPICheckInternalSigningStatus

Zwraca informacje o dokumencie ze stanem podpisywania.

Parametry

Nazwa Klucz Wymagane Typ Opis
Token podpisywania
 token True string

Token podpisywania.

Zwraca

Nazwa Ścieżka Typ Opis
Stan podpisywania
 status string

Stan podpisywania dokumentu.
Name
 name string

Nazwa podpisywania wyświetlana dla użytkownika.
Typ
 type string

Typ dokumentu.
Data utworzenia
 date_created string

Data rozpoczęcia podpisywania dokumentu.
Deadline
 deadline date-time

Data terminu podpisania z określonym fragmentem strefy czasowej. Przykład: 2018-11-05T13:15:30Z.
Nazwa pliku
 filename string

Nazwa pliku.
Files
 files array of object
Name
 files.name string

Nazwa pliku.
Adres URL pobierania
 files.url string

Adres URL pobierania pliku.
Typ MIME
 files.mime_type string

Typ MIME pliku.
Sygnatariuszy
 signers array of object

Informacje o uczestnikach.
Żeton
 signers.token string

Token uczestnika.
Name
 signers.first_name string

Nazwa uczestnika.
Surname
 signers.last_name string

Nazwisko uczestnika.
Code
 signers.code string

Kod uczestnika.
Country
 signers.country string

Kraj uczestnika.
E-mail
 signers.email string

Adres e-mail uczestnika.
Typ
 signers.type string

Typ.
Status
 signers.status string

Stan uczestnika.

Sprawdzanie stanu podpisywania zewnętrznego

Identyfikator operacji:
DokobitUniversalAPICheckExternalSigningStatus

Zwraca informacje o dokumencie ze stanem podpisywania.

Parametry

Nazwa Klucz Wymagane Typ Opis
Token podpisywania
 token True string

Token podpisywania.

Zwraca

Nazwa Ścieżka Typ Opis
Stan podpisywania
 status string

Stan podpisywania dokumentu.
Name
 name string

Nazwa podpisywania wyświetlana dla użytkownika.
Typ
 type string

Typ dokumentu.
Data utworzenia
 date_created string

Data rozpoczęcia podpisywania dokumentu.
Deadline
 deadline date-time

Data terminu podpisania z określonym fragmentem strefy czasowej. Przykład: 2018-11-05T13:15:30Z.
Nazwa pliku
 filename string

Nazwa pliku.
Files
 files array of object
Name
 files.name string

Nazwa pliku.
Adres URL pobierania
 files.url string

Adres URL pobierania pliku.
Typ MIME
 files.mime_type string

Typ MIME pliku.
Sygnatariuszy
 signers array of object

Informacje o uczestnikach.
Żeton
 signers.token string

Token uczestnika.
Name
 signers.first_name string

Nazwa uczestnika.
Surname
 signers.last_name string

Nazwisko uczestnika.
Code
 signers.code string

Kod uczestnika.
Country
 signers.country string

Kraj uczestnika.
E-mail
 signers.email string

Adres e-mail uczestnika.
Typ
 signers.type string

Typ.
Status
 signers.status string

Stan uczestnika.

Tworzenie podpisywania zewnętrznego

Identyfikator operacji:
DokobitUniversalAPICreateExternalSigning

Podpisywanie zewnętrzne inicjuje asynchroniczne żądanie podpisania z systemu. W takim przypadku użytkownik otrzyma wiadomość e-mail na potrzeby podpisania i otrzymasz wywołanie zwrotne po podpisaniu dokumentu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Typ
 type True string

Format dokumentu. Dostępne wartości: pdf, , bdocasice, edoc, adoc, adoc.cedoc.
Name
 name True string

Nazwa podpisywania wyświetlana dla użytkownika.
Adres URL ogłaszania zwrotnego
 postback_url string

Adres URL systemu do obsługi elementów webhook.
Deadline
 deadline date-time

Data terminu podpisania z określonym fragmentem strefy czasowej. Przykład: 2018-11-05T13:15:30Z.
Ostateczny termin
 hard_deadline boolean

Jeśli ustawiono wartość na true uczestników, po ustawieniu deadlineparametru nie będzie można podpisać tego dokumentu. Wartość domyślna: false.
Wymagaj kwalifikowanych podpisów
 require_qualified_signatures boolean

Zezwalaj na podpisywanie tylko przy użyciu kwalifikowanych podpisów. Wartość domyślna: false.
Położenie adnotacji
 annotation_position string

Możesz wybrać pozycję adnotacji podpisów w dokumencie PDF. Dostępne wartości: first_top, , last_topfirst_bottom, last_bottom, none. Wartość domyślna: first_top.
Kod osobisty adnotacji
 annotation_personal_code boolean

W przypadku ustawienia true na osobisty kod będzie widoczny w adnotacji. Dotyczy tylko podpisywania typu PDF. Wartość domyślna: false.
Comment
 comment string

Wiadomość dla uczestników.
Zezwalaj na identyfikację wideo
 allow_video_identification boolean

Zezwalaj na podpisywanie przy użyciu identyfikacji opartej na wideo. Wartość domyślna: false.
Zezwalaj na zapisywanie dokumentów
 allow_document_saving boolean

Zezwalaj użytkownikowi na zapisywanie dokumentu w portalu Dokobit i wykonywanie dalszych akcji. Wartość domyślna: true.
Spłaszczany plik PDF
 flatten_pdf boolean

Jeśli ustawiono wartość true, dokument zostanie spłaszczone, aby pola formularza stały się częścią zawartości dokumentu i nie można ich edytować po podpisaniu. Dotyczy tylko podpisywania typu PDF. Wartość domyślna: false.
Dozwolone metody podpisywania
 allowed_signing_methods array of string

Zezwalaj tylko na określone metody podpisywania. Dostępne wartości: mobile, smartideparaksts_mobilebankid_nobankid_seelectronic_idftnaudkenni_appsmartcarditsmeidinmitid, , . sms_otpswisscom
Name
 name True string

Nazwa pliku.
Content
 content True string

Zawartość pliku zakodowanego w formacie Base64.
Tożsamość zewnętrzna
 external_id True string

Unikatowy losowy identyfikator uczestnika z systemu. Jeśli go nie masz, możesz wygenerować unikatowe identyfikatory losowe.
Name
 name string

Nazwa uczestnika.
Surname
 surname string

Nazwisko uczestnika.
E-mail
 email string

Adres e-mail uczestnika.
Code
 code string

Osobisty kod uczestnika (krajowy numer identyfikacyjny).
Kod kraju
 country_code string

Kod kraju uczestnika. Wymagane w przypadku podania kodu osobistego. Dostępne wartości: LT, LVNOISFIEE, , BE, . SE
Role
 role string

Rola uczestnika. Dostępne wartości: signer, viewer. Wartość domyślna: signer.
Firma
 company string

Nazwa firmy uczestnika.
Position
 position string

Pozycja uczestnika.
Telefon
 phone string

Numer telefonu uczestnika.
Kolejność
 sequence integer

Umożliwia skonfigurowanie kolejności sekwencji akcji zatwierdzania i podpisywania dokumentu.
Język powiadomień
 notifications_language string

Ustawia język powiadomień. Dostępne wartości: en, ltdklvfideisetnofrse. nl
Przyczyna niestandardowa
 custom_reason string

Przyczyna podpisu niestandardowego.
Strona
 page string

Indeks strony dla widocznej adnotacji podpisu PDF. Dotyczy tylko podpisywania typu PDF. Wartość domyślna: 1.
Położenie od góry
 top string

Pozycja (w punktach) od góry dla widocznej adnotacji podpisu PDF. Dotyczy tylko podpisywania typu PDF. Wartość domyślna: 1.
Położenie od lewej
 left string

Pozycja (w punktach) po lewej stronie dla widocznej adnotacji podpisu PDF. Dotyczy tylko podpisywania typu PDF. Wartość domyślna: 1.
Język
 language string

Język widocznej adnotacji podpisu PDF. Dotyczy tylko podpisywania typu PDF. Dostępne wartości: en, , lvlt, , etis

Zwraca

Nazwa Ścieżka Typ Opis
Status
 status string

Stan.
Token podpisywania
 token string

Token podpisywania.
Sygnatariuszy
 signers array of object

Informacje o uczestnikach.
Tożsamość zewnętrzna
 signers.external_id string

Unikatowy losowy identyfikator uczestnika z systemu.
Żeton
 signers.token string

Token uczestnika.
Name
 signers.first_name string

Nazwa uczestnika.
Surname
 signers.last_name string

Nazwisko uczestnika.
Code
 signers.code string

Osobisty kod uczestnika (krajowy numer identyfikacyjny).
Country
 signers.country string

Kraj uczestnika.
E-mail
 signers.email string

Adres e-mail uczestnika.

Tworzenie wewnętrznego podpisywania

Identyfikator operacji:
DokobitUniversalAPICreateInternalSigning

Wewnętrzne podpisywanie inicjuje żądanie podpisania z systemu. W takim przypadku adres URL podpisywania jest generowany, gdzie uczestnik powinien zostać przekierowany.

Parametry

Nazwa Klucz Wymagane Typ Opis
Typ
 type True string

Format dokumentu. Dostępne wartości: pdf, , bdocasice, edoc, adoc, adoc.cedoc.
Name
 name True string

Nazwa podpisywania wyświetlana dla użytkownika.
URI przekierowania
 redirect_uri True string

Identyfikator URI przekierowania, który będzie używany do przekierowywania podpisującego po zakończeniu podpisywania.
Adres URL ogłaszania zwrotnego
 postback_url string

Adres URL systemu do obsługi elementów webhook.
Wymagaj kwalifikowanych podpisów
 require_qualified_signatures boolean

Zezwalaj na podpisywanie tylko przy użyciu kwalifikowanych podpisów. Wartość domyślna: false.
Położenie adnotacji
 annotation_position string

Możesz wybrać pozycję adnotacji podpisów w dokumencie PDF. Dostępne wartości: first_top, , last_topfirst_bottom, last_bottom, none. Wartość domyślna: first_top.
Kod osobisty adnotacji
 annotation_personal_code boolean

W przypadku ustawienia true na osobisty kod będzie widoczny w adnotacji. Dotyczy tylko podpisywania typu PDF. Wartość domyślna: false.
Zezwalaj na identyfikację wideo
 allow_video_identification boolean

Zezwalaj na podpisywanie przy użyciu identyfikacji opartej na wideo. Wartość domyślna: false.
Spłaszczany plik PDF
 flatten_pdf boolean

Jeśli ustawiono wartość true, dokument zostanie spłaszczone, aby pola formularza stały się częścią zawartości dokumentu i nie można ich edytować po podpisaniu. Dotyczy tylko podpisywania typu PDF. Wartość domyślna: false.
Dozwolone metody podpisywania
 allowed_signing_methods array of string

Zezwalaj tylko na określone metody podpisywania. Dostępne wartości: mobile, smartideparaksts_mobilebankid_nobankid_seelectronic_idftnaudkenni_appsmartcarditsmeidinmitid, , . sms_otpswisscom
Name
 name True string

Nazwa pliku.
Content
 content True string

Zawartość pliku zakodowanego w formacie Base64.
Tożsamość zewnętrzna
 external_id True string

Unikatowy losowy identyfikator uczestnika z systemu. Jeśli go nie masz, możesz wygenerować unikatowe identyfikatory losowe.
Role
 role string

Rola uczestnika. Dostępne wartości: signer, viewer. Wartość domyślna: signer.
Code
 code string

Kod uczestnika.
Kod kraju
 country_code string

Kod kraju uczestnika. Wymagane w przypadku podania kodu osobistego. Dostępne wartości: LT, LVPLEENOFIIS, , BE, . SE
Telefon
 phone string

Telefon uczestnika.
Język powiadomień
 language string

Ustawia język interfejsu użytkownika. Dostępne wartości: en, ltdklvfideisetnofrse. nl
Strona
 page string

Indeks strony dla widocznej adnotacji podpisu PDF. Dotyczy tylko podpisywania typu PDF. Wartość domyślna: 1.
Położenie od góry
 top string

Pozycja (w punktach) od góry dla widocznej adnotacji podpisu PDF. Dotyczy tylko podpisywania typu PDF. Wartość domyślna: 1.
Położenie od lewej
 left string

Pozycja (w punktach) po lewej stronie dla widocznej adnotacji podpisu PDF. Dotyczy tylko podpisywania typu PDF. Wartość domyślna: 1.
Język
 language string

Język widocznej adnotacji podpisu PDF. Dotyczy tylko podpisywania typu PDF. Dostępne wartości: en, , lvlt, , etis
Przyczyna niestandardowa
 custom_reason string

Przyczyna podpisu niestandardowego.

Zwraca

Nazwa Ścieżka Typ Opis
Status
 status string

Stan.
Token podpisywania
 token string

Token podpisywania.
Sygnatariuszy
 signers array of object

Informacje o uczestnikach.
Tożsamość zewnętrzna
 signers.external_id string

Unikatowy losowy identyfikator uczestnika z systemu.
Żeton
 signers.token string

Token uczestnika.
URI przekierowania
 signers.redirect_uri string

Adres URL podpisywania.

Usuwanie podpisywania wewnętrznego

Identyfikator operacji:
DokobitUniversalAPIDeleteInternalSigning

Dokument zostanie usunięty z konta właściciela. Pozostanie ona dostępna dla innych uczestników.

Parametry

Nazwa Klucz Wymagane Typ Opis
Token podpisywania
 token True string

Token podpisywania.

Zwraca

Nazwa Ścieżka Typ Opis
Status
 status string

Stan.

Usuwanie podpisywania zewnętrznego

Identyfikator operacji:
DokobitUniversalAPIDeleteExternalSigning

Dokument zostanie usunięty z konta właściciela. Pozostanie ona dostępna dla innych uczestników.

Parametry

Nazwa Klucz Wymagane Typ Opis
Token podpisywania
 token True string

Token podpisywania.

Zwraca

Nazwa Ścieżka Typ Opis
Status
 status string

Stan.

Usuwanie wewnętrznego sygnatariusza

Identyfikator operacji:
DokobitUniversalAPIDeleteInternalSigner

Dostęp do dokumentu zostanie odwołany dla wskazanego uczestnika.

Parametry

Nazwa Klucz Wymagane Typ Opis
Token podpisywania
 token True string

Token podpisywania.
Żeton
 token True string

Token uczestnika.

Zwraca

Nazwa Ścieżka Typ Opis
Status
 status string

Stan.

Usuwanie zewnętrznego sygnatariusza

Identyfikator operacji:
DokobitUniversalAPIDeleteExternalSigner

Dostęp do dokumentu zostanie odwołany dla wskazanego uczestnika.

Parametry

Nazwa Klucz Wymagane Typ Opis
Token podpisywania
 token True string

Token podpisywania.
Żeton
 token True string

Token uczestnika.

Zwraca

Nazwa Ścieżka Typ Opis
Status
 status string

Stan.

Validation

Identyfikator operacji:
DokobitUniversalAPIValidation

Dokobit jest certyfikowanym dostawcą usług eIDAS na potrzeby kwalifikowanych weryfikacji podpisów elektronicznych i e-seal. Użyj tej akcji, aby przekazać podpisany plik do weryfikacji. Obsługiwane typy plików: asice, , scebdocedocasics, pdf, . p7sxml

Parametry

Nazwa Klucz Wymagane Typ Opis
Name
 name True string

Nazwa pliku.
Content
 content True string

Zawartość pliku zakodowanego w formacie Base64.

Zwraca

Nazwa Ścieżka Typ Opis
Stan przekazywania
 status string

Stan przekazywania.
Token weryfikacji
 token string

Token weryfikacji.

Walidacja — dane diagnostyczne XML

Identyfikator operacji:
DokobitUniversalAPIValidationXMLDiagnosticData

Pobierz dane diagnostyczne w formacie XML.

Parametry

Nazwa Klucz Wymagane Typ Opis
Token weryfikacji
 token True string

Token weryfikacji odebrany z akcji DokobitUniversalAPIValidation.

Zwraca

response
object

Walidacja — raport PDF

Identyfikator operacji:
DokobitUniversalAPIValidationPDFReport

Pobierz raport weryfikacji w pliku PDF.

Parametry

Nazwa Klucz Wymagane Typ Opis
Token weryfikacji
 token True string

Token weryfikacji odebrany z akcji DokobitUniversalAPIValidation.

Zwraca

response
object

Walidacja — raport XML

Identyfikator operacji:
DokobitUniversalAPIValidationXMLReport

Pobierz raport weryfikacji w formacie XML.

Parametry

Nazwa Klucz Wymagane Typ Opis
Token weryfikacji
 token True string

Token weryfikacji odebrany z akcji DokobitUniversalAPIValidation.

Zwraca

response
object

Walidacja — szczegółowy raport PDF

Identyfikator operacji:
DokobitUniversalAPIValidationDetailedPDFReport

Pobierz szczegółowy raport weryfikacji w pliku PDF.

Parametry

Nazwa Klucz Wymagane Typ Opis
Token weryfikacji
 token True string

Token weryfikacji odebrany z akcji DokobitUniversalAPIValidation.

Zwraca

response
object

Wyślij przypomnienie

Identyfikator operacji:
DokobitUniversalAPIReminder

Umożliwia wysłanie wiadomości e-mail z przypomnieniem dla uczestnika, tylko wtedy, gdy osoba nie podpisała jeszcze dokumentu. Działa tylko z zewnętrznym przepływem podpisywania.

Parametry

Nazwa Klucz Wymagane Typ Opis
Token podpisywania
 token True string

Token podpisywania.
Token logowania
 signer True string

Token uczestnika.
Message
 message string

Wiadomość z przypomnieniem do sygnatariusza.

Zwraca

Nazwa Ścieżka Typ Opis
Status
 status string

Stan.

Definicje

obiekt

Jest to typ 'obiekt'.