Udostępnij przez


Znak Zoho

Znak Zoho jest kompletną aplikacją podpisów cyfrowych, która ułatwia cyfrowe podpisywanie dokumentów biznesowych z pełnymi zabezpieczeniami i niezawodnością

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 Obsługa interfejsu API podpisywania Zoho
adres URL https://www.zoho.com/sign/contact.html
Email support@zohosign.com
Metadane łącznika
Publisher Zoho Corporation
Witryna internetowa https://www.zoho.com/sign/
Zasady ochrony prywatności https://www.zoho.com/privacy.html
Kategorie Zawartość i pliki; Produktywność

Cyfrowe podpisywanie dokumentów biznesowych w trybie online z pełnymi zabezpieczeniami i niezawodnością przy użyciu oprogramowania Zoho e-signature. Automatyzowanie transakcji przy użyciu prostych przepływów pracy dokumentów podpisywania elektronicznego. Kompletna aplikacja podpisów cyfrowych dla sygnatariuszy biznesowych.

Wymagania wstępne

Aby móc korzystać z tego łącznika, musisz zapłacić za konto Zoho-Sign na platformie Zoho-Sign. Aby uzyskać szczegółowe informacje, zobacz https://www.zoho.com/sign/pricing-api.html Tutaj możesz również skonfigurować konto https://zoho.com/sign ##How, aby uzyskać poświadczenia Interfejs API Zoho-Sign używa protokołu OAuth 2 do uwierzytelniania. Dlatego po skonfigurowaniu konta nie są wymagane żadne dodatkowe kroki.

Wszystkie interfejsy API podpisywania Zoho wymagają tego obowiązkowego nagłówka: Autoryzacja — nagłówek żądania uwierzytelniania.

W przypadku generowania tokenów zobacz: https://www.zoho.com/sign/api/#getting-started

Wprowadzenie do łącznika

Łącznik Zoho Sign Connector umożliwia użytkownikom bezpośrednie zarządzanie dokumentami, zarządzanie szablonami i inne operacje bez uzyskiwania dostępu do interfejsu internetowego aplikacji Zoho Sign

W menedżerze dokumentów, korzystając z tych łączników, użytkownicy mogą tworzyć dokumenty, aktualizować dokumenty, wysyłać dokumenty do podpisów i pobierać listę wszystkich dokumentów związanych z kontem.

Podobnie w przypadku innych operacji zapoznaj się z tytułem "CO TO SĄ OBSŁUGIWANE OPERACJE?" w poniższym linku,

https://www.zoho.com/sign/api/#introduction

Te łączniki pomogą Ci zautomatyzować użycie bezpośrednio z dokumentu lub szablonu wysyłającego do śledzenia stanu i nie tylko.

Typowe błędy i środki zaradcze

W przypadku błędu debuguj go przy użyciu prawidłowych kodów błędów i ich przyczyny.

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
Wybierz region. ciąg Wybierz domenę. Prawda

Limity ograniczania

Nazwa Wywołania Okres odnowienia
Wywołania interfejsu API na połączenie 100 60 sekund

Akcje

Aktualizowanie właściwości utworzonego żądania

Aktualizowanie właściwości utworzonego żądania

Pobieranie certyfikatu ukończenia

Pobiera certyfikat ukończenia określonej koperty

Pobieranie danych ukończonego żądania

Pokazuje szczegóły podpisanej koperty

Pobieranie dokumentu

Pokazuje szczegóły określonej koperty

Pobieranie listy szablonów

Pokazuje listę wszystkich utworzonych szablonów dokumentów

Pobieranie szczegółów określonego szablonu

Pokazuje szczegóły określonego szablonu dokumentu

Pobierz dokument

Pobiera określoną kopertę

Pobierz plik

Pobiera określony dokument lub plik

Przypomnienie dla adresatów

Wyślij przypomnienie do adresatów określonego dokumentu.

Przypomnienie określonego dokumentu

Przypomnienie określonego dokumentu

SendSignRequest

Wysyłanie przekazanego dokumentu do podpisu

Tworzenie dokumentu do podpisywania

Akcja tworzenia dokumentu do podpisywania przez przekazanie pliku.

Usuń dokument

Usuwanie określonego dokumentu

Wywoływanie interfejsu API

Wywoływanie interfejsu API

Aktualizowanie właściwości utworzonego żądania

Aktualizowanie właściwości utworzonego żądania

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania
RequestId True string

Identyfikator żądania

Typ dokumentu
request_type_id string

request_type_id

Nazwa dokumentu
request_name True string

Nazwa dokumentu (żądanie)

Nazwa adresata
recipient_name string

Imię i nazwisko adresata

Adres e-mail adresata
recipient_email string

Adres e-mail adresata

Numer telefonu
recipient_phonenumber string

Numer telefonu adresata w trybie uwierzytelniania SMS.

Kod kraju
recipient_countrycode string

Country Code of recipient's phone number for SMS mode of authentication (Kod kraju numeru telefonu odbiorcy dla trybu uwierzytelniania sms).

Typ akcji
action_type string

Wybierz, czy adresat jest osoba podpisującego, osoba przeglądająca, osoba zatwierdzająca, czy inpersonSigner.

Notatki prywatne
private_notes string

Notatki prywatne

Kolejność podpisywania
signing_order integer

Kolejność podpisywania

Wymagaj uwierzytelniania dla adresata
verify_recipient boolean

Czy odbiorca musi zostać zweryfikowany przez jeden z trybów uwierzytelniania.

Typ dostarczania uwierzytelniania
verification_type string

Typ weryfikacji

Kod weryfikacyjny
verification_code string

6-cyfrowy kod weryfikacyjny dla trybu weryfikacji offline.

Dni do ukończenia
expiration_days integer

Liczba dni pozostałych do wygaśnięcia dokumentu.

Wyślij w kolejności
is_sequential boolean

Zezwalaj adresatom na logowanie się w określonej kolejności.

Przypomnienia automatyczne
email_reminders boolean

Włącz okresowe przypomnienia dla adresatów w celu podpisania dokumentu.

Wyślij resztę co - (dni)
reminder_period integer

Określ przedział czasu, w którym ma zostać wysłane przypomnienie o podpisaniu do adresatów.

Folder
folder_id string

unikatowy identyfikator folderu

Notatki
notes html

Uwagi dla wszystkich adresatów.

Zwraca

Nazwa Ścieżka Typ Opis
kod
code integer

kod

komunikat
message string

komunikat

stan
status string

stan

Pobieranie certyfikatu ukończenia

Pobiera certyfikat ukończenia określonej koperty

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania
request_id True integer

Identyfikator żądania

Zwraca

response
file

Pobieranie danych ukończonego żądania

Pokazuje szczegóły podpisanej koperty

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania
request_id True integer

Identyfikator żądania

Zwraca

Nazwa Ścieżka Typ Opis
kod
code integer

kod

request_name
document_form_data.request_name string

Nazwa żądania

zsdocumentid
document_form_data.zsdocumentid string

Identyfikator dokumentu Zoho

działania
document_form_data.actions array of object

działania

signed_time
document_form_data.actions.signed_time string

Czas podpisania

action_type
document_form_data.actions.action_type string

Typ akcji

recipient_email
document_form_data.actions.recipient_email string

Adres e-mail adresata

recipient_name
document_form_data.actions.recipient_name string

Imię i nazwisko adresata

pola
document_form_data.actions.fields array of object

pola

field_label
document_form_data.actions.fields.field_label string

Etykieta pola

field_value
document_form_data.actions.fields.field_value string

Wartość pola

field_name
document_form_data.actions.fields.field_name string

Nazwa pola

stan
status string

stan

Pobieranie dokumentu

Pokazuje szczegóły określonej koperty

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania
RequestId True integer

Identyfikator żądania

Zwraca

Nazwa Ścieżka Typ Opis
kod
code integer

kod

request_status
requests.request_status string

Stan żądania

Notatki
requests.notes string

Notatki

attachments
requests.attachments array of

Załączniki

reminder_period
requests.reminder_period integer

Okres przypomnienia

owner_id
requests.owner_id string

Identyfikator właściciela

opis
requests.description string

Opis żądania

request_name
requests.request_name string

Nazwa żądania

modified_time
requests.modified_time integer

Czas modyfikacji

action_time
requests.action_time integer

Czas akcji

is_deleted
requests.is_deleted boolean

Usuwanie stanu żądania

expiration_days
requests.expiration_days integer

Dni wygaśnięcia

is_sequential
requests.is_sequential boolean

Stan sekwencyjny

sign_submitted_time
requests.sign_submitted_time integer

Czas przesłania podpisu

owner_first_name
requests.owner_first_name string

Imię właściciela

sign_percentage
requests.sign_percentage float

Procent podpisywania

expire_by
requests.expire_by integer

Data wygaśnięcia dokumentu

is_expiring
requests.is_expiring boolean

Dokument wygasający

owner_email
requests.owner_email string

Identyfikator e-mail właściciela

created_time
requests.created_time integer

Godzina utworzenia dokumentu

email_reminders
requests.email_reminders boolean

Wysyłanie przypomnień za pośrednictwem poczty e-mail

document_ids
requests.document_ids array of object

Identyfikatory dokumentów

image_string
requests.document_ids.image_string string

Ciąg obrazu

document_name
requests.document_ids.document_name string

Nazwa dokumentu

Stron
requests.document_ids.pages array of object

Stron

image_string
requests.document_ids.pages.image_string string

Ciąg obrazu

page
requests.document_ids.pages.page integer

page

is_thumbnail
requests.document_ids.pages.is_thumbnail boolean

Stan miniatury

document_size
requests.document_ids.document_size integer

Rozmiar dokumentu

document_order
requests.document_ids.document_order string

Kolejność dokumentów

total_pages
requests.document_ids.total_pages integer

Całkowita liczba stron w dokumencie

document_id
requests.document_ids.document_id string

Identyfikator dokumentu

self_sign
requests.self_sign boolean

Stan samodzielnego podpisywania

sign_id
requests.sign_id string

Identyfikator logowania

folder_name
requests.folder_name string

Nazwa folderu

in_process
requests.in_process boolean

W stanie procesu

ważność
requests.validity integer

Ważność dokumentu

request_type_name
requests.request_type_name string

Nazwa typu żądania

folder_id
requests.folder_id string

Identyfikator folderu

identyfikator_żądania
requests.request_id string

Identyfikator żądania

request_type_id
requests.request_type_id string

Identyfikator typu żądania

owner_last_name
requests.owner_last_name string

Nazwisko właściciela

działania
requests.actions array of object

działania

verify_recipient
requests.actions.verify_recipient boolean

Weryfikowanie identyfikatora poczty adresatów

action_type
requests.actions.action_type string

Typ akcji

private_notes
requests.actions.private_notes string

Notatki prywatne

recipient_email
requests.actions.recipient_email string

Identyfikator e-mail adresata

send_completed_document
requests.actions.send_completed_document boolean

Stan ukończonego dokumentu wysyłania

verification_type
requests.actions.verification_type string

Typ weryfikacji

allow_signing
requests.actions.allow_signing boolean

Zezwalaj na stan podpisywania

recipient_phonenumber
requests.actions.recipient_phonenumber string

Numer telefonu odbiorcy

is_bulk
requests.actions.is_bulk boolean

Stan zbiorczego

action_id
requests.actions.action_id string

Identyfikator akcji

is_revoked
requests.actions.is_revoked boolean

Stan odwołania

is_embedded
requests.actions.is_embedded boolean

Stan osadzonego

signing_order
requests.actions.signing_order integer

Kolejność podpisywania

recipient_name
requests.actions.recipient_name string

Imię i nazwisko adresata

action_status
requests.actions.action_status string

Stan akcji

recipient_countrycode
requests.actions.recipient_countrycode string

Kod kraju odbiorcy

ishost
requests.actions.ishost boolean

stan użycia hosta

język
requests.actions.language string

język

in_person_name
requests.actions.in_person_name string

Nazwisko osoby

in_person_email
requests.actions.in_person_email string

Osobiście wyślij wiadomość e-mail

verification_code
requests.actions.verification_code string

Kod weryfikacyjny

attachment_size
requests.attachment_size integer

Rozmiar załącznika

komunikat
message string

komunikat

stan
status string

stan

Pobieranie listy szablonów

Pokazuje listę wszystkich utworzonych szablonów dokumentów

Zwraca

Nazwa Ścieżka Typ Opis
templates
templates array of object
template_id
templates.template_id string
template_name
templates.template_name string

Nazwa szablonu

Pobieranie szczegółów określonego szablonu

Pokazuje szczegóły określonego szablonu dokumentu

Parametry

Nazwa Klucz Wymagane Typ Opis
Lista szablonów
template_id True string

Lista szablonów

Pobierz dokument

Pobiera określoną kopertę

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania
request_id True integer

Identyfikator żądania

Zwraca

response
file

Pobierz plik

Pobiera określony dokument lub plik

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania
request_id True integer

Identyfikator żądania

Identyfikator dokumentu
document_id True integer

Identyfikator dokumentu

Zwraca

response
file

Przypomnienie dla adresatów

Wyślij przypomnienie do adresatów określonego dokumentu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania
request_id True integer

Identyfikator żądania

Przypomnienie określonego dokumentu

Przypomnienie określonego dokumentu

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania
request_id True integer

Identyfikator żądania

SendSignRequest

Wysyłanie przekazanego dokumentu do podpisu

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania
RequestId True string

Identyfikator żądania

Zwraca

Nazwa Ścieżka Typ Opis
kod
code integer

kod

komunikat
message string

komunikat

stan
status string

stan

Tworzenie dokumentu do podpisywania

Akcja tworzenia dokumentu do podpisywania przez przekazanie pliku.

Parametry

Nazwa Klucz Wymagane Typ Opis
tworzenie dokumentu
file True file

tworzenie dokumentu

Zwraca

Nazwa Ścieżka Typ Opis
kod
code integer

kod

request_status
requests.request_status string

Stan żądania

owner_email
requests.owner_email string

Adres e-mail właściciela

created_time
requests.created_time integer

Czas utworzenia

document_ids
requests.document_ids array of object

document_ids

image_string
requests.document_ids.image_string string

Ciąg obrazu

document_name
requests.document_ids.document_name string

Nazwa dokumentu

Stron
requests.document_ids.pages array of object

Stron

image_string
requests.document_ids.pages.image_string string

Ciąg obrazu

page
requests.document_ids.pages.page integer

page

is_thumbnail
requests.document_ids.pages.is_thumbnail boolean

is_thumbnail

document_size
requests.document_ids.document_size integer

Rozmiar dokumentu

document_order
requests.document_ids.document_order string

Kolejność dokumentów

total_pages
requests.document_ids.total_pages integer

Łączna liczba stron

document_id
requests.document_ids.document_id string

Identyfikator dokumentu

Notatki
requests.notes string

Notatki

self_sign
requests.self_sign boolean

podpis własny

owner_id
requests.owner_id string

identyfikator właściciela

opis
requests.description string

Description

folder_name
requests.folder_name string

Nazwa folderu

request_name
requests.request_name string

Nazwa żądania

modified_time
requests.modified_time integer

czas modyfikacji

is_deleted
requests.is_deleted boolean

Stan usunięcia

expiration_days
requests.expiration_days integer

Dni wygaśnięcia

in_process
requests.in_process boolean

W trakcie

is_sequential
requests.is_sequential boolean

Stan sekwencyjny

request_type_name
requests.request_type_name string

Nazwa typu żądania

owner_first_name
requests.owner_first_name string

Imię właściciela

folder_id
requests.folder_id string

Identyfikator folderu

identyfikator_żądania
requests.request_id string

Identyfikator żądania

request_type_id
requests.request_type_id string

Identyfikator typu żądania

owner_last_name
requests.owner_last_name string

Nazwisko właściciela

sign_percentage
requests.sign_percentage integer

Procent podpisywania

komunikat
message string

Message

stan
status string

stan

Usuń dokument

Usuwanie określonego dokumentu

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator żądania
request_id True integer

Identyfikator żądania

Wywoływanie interfejsu API

Wywoływanie interfejsu API

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka adresu URL
url True string

Podaj ścieżkę adresu URL

Metoda
method True string

Wybierz metodę interfejsu API do użycia

Zwraca

response
object

Wyzwalacze

Wyzwalacze podpisywania Zoho

Rejestrowanie wywołania zwrotnego dla określonego zdarzenia

Wyzwalacze podpisywania Zoho

Rejestrowanie wywołania zwrotnego dla określonego zdarzenia

Parametry

Nazwa Klucz Wymagane Typ Opis
Czynności
webhook_actions True string

Akcje elementu webhook

Zwraca

Nazwa Ścieżka Typ Opis
request_status
requests.request_status string

stan żądania

Notatki
requests.notes string

Notatki

reminder_period
requests.reminder_period integer

okres przypomnienia

owner_id
requests.owner_id string

identyfikator właściciela

opis
requests.description string

opis

request_name
requests.request_name string

Nazwa żądania

modified_time
requests.modified_time integer

Czas modyfikacji

action_time
requests.action_time integer

Czas akcji

is_deleted
requests.is_deleted boolean

Stan usunięcia

expiration_days
requests.expiration_days integer

Dni wygaśnięcia

is_sequential
requests.is_sequential boolean

Stan operacji sekwencyjnej

sign_submitted_time
requests.sign_submitted_time integer

Czas przesłania podpisu

owner_first_name
requests.owner_first_name string

Właściciel pierwszego imienia

sign_percentage
requests.sign_percentage integer

Procent podpisywania

expire_by
requests.expire_by integer

Wygasnąć o

owner_email
requests.owner_email string

Adres e-mail właściciela

created_time
requests.created_time integer

Czas utworzenia

email_reminders
requests.email_reminders boolean

Przypomnienia e-mail

document_ids
requests.document_ids array of object

Lista identyfikatorów dokumentów

document_name
requests.document_ids.document_name string

Wprowadź nazwę dokumentu

document_size
requests.document_ids.document_size integer

Rozmiar dokumentu

document_order
requests.document_ids.document_order string

Kolejność dokumentu

total_pages
requests.document_ids.total_pages integer

Łączna liczba stron w dokumencie

document_id
requests.document_ids.document_id string

Identyfikator dokumentu

self_sign
requests.self_sign boolean

Stan samodzielnego podpisywania

in_process
requests.in_process boolean

Stan procesu

ważność
requests.validity integer

Ważność

request_type_name
requests.request_type_name string

Nazwa typu żądania

decline_reason
requests.decline_reason string

Przyczyna odrzucenia

identyfikator_żądania
requests.request_id string

Identyfikator żądania

request_type_id
requests.request_type_id string

Identyfikator typu żądania

owner_last_name
requests.owner_last_name string

Nazwisko właściciela

działania
requests.actions array of object

działania

verify_recipient
requests.actions.verify_recipient boolean

Weryfikowanie adresata

action_type
requests.actions.action_type string

Typ akcji

private_notes
requests.actions.private_notes string

Notatki prywatne

recipient_email
requests.actions.recipient_email string

Adres e-mail adresata

allow_signing
requests.actions.allow_signing boolean

Stan podpisywania

recipient_phonenumber
requests.actions.recipient_phonenumber string

Numer telefonu odbiorcy

is_bulk
requests.actions.is_bulk boolean

Stan akcji zbiorczej

action_id
requests.actions.action_id string

Identyfikator akcji

is_revoked
requests.actions.is_revoked boolean

Stan odwołania

is_embedded
requests.actions.is_embedded boolean

Stan osadzonego

signing_order
requests.actions.signing_order integer

Kolejność podpisywania

recipient_name
requests.actions.recipient_name string

Imię i nazwisko adresata

action_status
requests.actions.action_status string

Stan akcji

recipient_countrycode
requests.actions.recipient_countrycode string

Kod kraju odbiorcy

performed_by_email
notifications.performed_by_email string

Wykonywane pocztą e-mail

performed_at
notifications.performed_at integer

Wykonane w

powód
notifications.reason string

Przyczyna

działanie
notifications.activity string

Activity

operation_type
notifications.operation_type string

Typ operacji

action_id
notifications.action_id string

Identyfikator akcji

performed_by_name
notifications.performed_by_name string

Wykonywane według nazwy

signing_order
notifications.signing_order integer

Kolejność podpisywania

ip_address
notifications.ip_address string

Adres IP

Definicje

plik

Jest to podstawowy typ danych "file".

obiekt

Jest to typ 'obiekt'.