SigningHub (wersja zapoznawcza)
Usługa SigningHub firmy Ascertia oferuje kompleksowy pakiet do obsługi podpisów cyfrowych o wysokim zaufaniu i automatyzacji przepływu pracy dokumentów. Ten łącznik umożliwia firmom bezpieczne uwierzytelnianie użytkowników, inicjowanie żądań podpisywania dokumentów i zarządzanie cyklami kompleksowego zatwierdzania. Zaprojektowana pod kątem spełnienia rygorystycznych globalnych standardów zabezpieczeń zapewnia, że zautomatyzowane przepływy pracy pozostaną prawnie wymuszane, przejrzyste i wysoce bezpieczne w całej organizacji.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Wszystkie regiony 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: - Azure Government regionów - Azure regionach Chin - Departament Obrony USA (DoD) |
| Power Apps | Premium | Wszystkie regiony 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 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 | Support |
| adres URL | https://www.signinghub.com/contact-us/ |
| support@ascertia.com |
| Metadane łącznika | |
|---|---|
| Publisher | Ascertia |
| Właściciel stosu | SigningHub |
| BrandColor | #1C1C1C |
| IconBrandColor | #1C1C1C |
| Witryna internetowa | https://signinghub.com |
| Zasady ochrony prywatności | https://www.signinghub.com/privacy-policy |
| Categories | Zawartość i pliki; Produktywność |
Łącznik usługi SigningHub
Usługa SigningHub udostępnia kompleksowy interfejs API REST, który umożliwia organizacjom automatyzowanie przepływów pracy podpisywania dokumentów cyfrowych i zarządzanie nimi. Za pomocą tego łącznika można zintegrować usługę SigningHub z Power Automate, aby usprawnić procesy zatwierdzania dokumentów i zautomatyzować akcje podpisywania w niestandardowych przepływach pracy.
Ten łącznik umożliwia automatyzację podpisywania dokumentów i innych akcji usługi SigningHub bezpośrednio w ramach przepływów Power Automate, pomagając organizacjom w tworzeniu wydajnych i bezpiecznych przepływów pracy dokumentów.
Publisher: Ascertia
Wymagania wstępne
Aby użyć tego łącznika, musisz mieć następujące elementy:
- Aktywne konto usługi SigningHub (https://www.signinghub.com).
- Prawidłowa integracja zdefiniowana w usłudze SigningHub.
Jak uzyskać poświadczenia
Wypełnij pola Formularz logowania następującymi wartościami:
- Adres e-mail: adres e-mail konta usługi SigningHub.
- Hasło: hasło konta usługi SigningHub.
- Identyfikator klienta interfejsu API: Ascertia lub administrator firmy udostępni identyfikator klienta interfejsu API do korzystania z łącznika.
- Klucz tajny klienta interfejsu API: Ascertia lub administrator firmy udostępni klucz tajny klienta interfejsu API do korzystania z łącznika.
- Adres URL interfejsu API podpisywania: adres URL interfejsu API podpisywania domyślnie https://api.signinghub.com
Obsługiwane operacje
Ten łącznik zapewnia pewien zakres interfejsu API REST usługi SigningHub. Listę obsługiwanych akcji i ich parametrów można znaleźć w przewodniku po interfejsie API usługi SigningHub.
Łącza i pomoc techniczna
- Oficjalna dokumentacja interfejsu API
- Adres URL pomocy technicznej
- Zasady zachowania poufności informacji
Limity ograniczania
| Nazwisko | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Aktualizowanie kodu QR |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do aktualizowania kodu QR dokumentu w pakiecie. |
| Aktualizowanie kolejności użytkowników przepływu pracy |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do aktualizowania kolejności adresata w przepływie pracy. |
| Aktualizowanie pola checkbox |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do aktualizowania pola wyboru dokumentu w pakiecie. Zwróć uwagę, że można zmienić wszystkie parametry wejściowe. Jeśli chcesz zachować bieżące ustawienie, prześlij je w wywołaniu bez zmian. W związku z tym można użyć tych samych parametrów co podczas dodawania pola wejściowego lub informacji zwracanych przez polecenie Pobierz pola dokumentu. Ten ostatni może być używany podczas stosowania szablonu lub tworzenia dokumentu przy użyciu interfejsu GUI. Nie można zaktualizować szerokości i wysokości. Pozostaną one takie same, jak w przypadku ich dodania. |
| Aktualizowanie pola osoby |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do aktualizowania pola podpisu osoby dokumentu w pakiecie. Zwróć uwagę, że można zmienić wszystkie parametry wejściowe. Jeśli chcesz zachować bieżące ustawienie, prześlij je w wywołaniu bez zmian. W związku z tym można użyć tych samych parametrów co podczas dodawania pola wejściowego lub informacji zwracanych przez polecenie Pobierz pola dokumentu. Ten ostatni może być używany podczas stosowania szablonu lub tworzenia dokumentu przy użyciu interfejsu GUI. |
| Aktualizowanie pola początkowego |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do aktualizowania pola inicjałów dokumentu w pakiecie. Zwróć uwagę, że można zmienić wszystkie parametry wejściowe. Jeśli chcesz zachować bieżące ustawienie, prześlij je w wywołaniu bez zmian. W związku z tym można użyć tych samych parametrów co podczas dodawania pola wejściowego lub informacji zwracanych przez polecenie Pobierz pola dokumentu. Ten ostatni może być używany podczas stosowania szablonu lub tworzenia dokumentu przy użyciu interfejsu GUI. |
| Aktualizowanie pola podpisu cyfrowego |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do aktualizowania pola podpisu cyfrowego dokumentu w pakiecie. Zwróć uwagę, że można zmienić wszystkie parametry wejściowe. Jeśli chcesz zachować bieżące ustawienie, prześlij je w wywołaniu bez zmian. W związku z tym można użyć tych samych parametrów co podczas dodawania pola wejściowego lub informacji zwracanych przez polecenie Pobierz pola dokumentu. Ten ostatni może być używany podczas stosowania szablonu lub tworzenia dokumentu przy użyciu interfejsu GUI. |
|
Aktualizowanie pola Radio |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do aktualizowania przycisku radiowego dokumentu w pakiecie. Zwróć uwagę, że można zmienić wszystkie parametry wejściowe. Jeśli chcesz zachować bieżące ustawienie, prześlij je w wywołaniu bez zmian. W związku z tym można użyć tych samych parametrów co podczas dodawania pola wejściowego lub informacji zwracanych przez polecenie Pobierz pola dokumentu. Ten ostatni może być używany podczas stosowania szablonu lub tworzenia dokumentu przy użyciu interfejsu GUI. Nie można zaktualizować szerokości i wysokości. Pozostaną one takie same, jak w przypadku ich dodania. |
| Aktualizowanie pola tekstowego |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do aktualizowania pola tekstowego dokumentu w pakiecie. Zwróć uwagę, że można zmienić wszystkie parametry wejściowe. Jeśli chcesz zachować bieżące ustawienie, prześlij je w wywołaniu bez zmian. W związku z tym można użyć tych samych parametrów co podczas dodawania pola wejściowego lub informacji zwracanych przez polecenie Pobierz pola dokumentu. Ten ostatni może być używany podczas stosowania szablonu lub tworzenia dokumentu przy użyciu interfejsu GUI. |
| Aktualizowanie przestrzeni udostępnionej |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do aktualizowania przestrzeni udostępnionej. Dostępność aktualizacji przestrzeni udostępnionych podlega przypisanej roli użytkownika przedsiębiorstwa. Aby zezwolić na tę aprowizację administrator przedsiębiorstwa, włączy opcję "Zarządzaj przestrzenią udostępnioną" w obszarze Ustawienia dokumentu role>. |
| Aktualizowanie przetwarzania końcowego |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do dodawania symbolu zastępczego do przepływu pracy dokumentu w pakiecie. |
| Aktualizowanie przypomnień przepływu pracy |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do aktualizowania przypomnień przepływu pracy dla adresata, który został już dodany do przepływu pracy. Zwykle to wywołanie jest przydatne po zastosowaniu szablonu do dokumentu, a aplikacje biznesowe chcą zastąpić ustawienia przypomnień w przepływie pracy. Identyfikator dokumentu przepływu pracy jest podany w adresie URL zasobu, a odbiorca przepływu pracy jest identyfikowany przez kolejność, w której jest dodawany do przepływu pracy. |
| Aktualizowanie symbolu zastępczego |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do aktualizowania symbolu zastępczego w przepływie pracy. Zwykle to wywołanie jest przydatne po zastosowaniu szablonu do dokumentu, a aplikacje biznesowe chcą zastąpić szczegóły określonego właściciela miejsca w przepływie pracy. Identyfikator dokumentu przepływu pracy jest podany w adresie URL zasobu, a właściciel miejsca przepływu pracy jest identyfikowany przez kolejność, w której jest dodawany do przepływu pracy. Podczas przygotowywania dokumentów typu XML obsługiwane są tylko typy ról "SIGNER", "REVIEWER" i "CARBON_COPY" |
| Aktualizowanie szczegółów przepływu pracy |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do aktualizowania szczegółów przepływu pracy. Zwykle to wywołanie jest przydatne po zastosowaniu szablonu do dokumentu, ale aplikacje biznesowe chcą zastąpić uprawnienie certyfikacji lub szczegóły przetwarzania końcowego. Identyfikator pakietu jest podany w adresie URL zasobu. |
| Aktualizowanie uprawnień użytkownika przepływu pracy |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do aktualizowania uprawnień przepływu pracy dla użytkownika, który został już dodany do przepływu pracy. Zwykle to wywołanie jest przydatne po zastosowaniu szablonu do dokumentu, a aplikacje biznesowe chcą zastąpić uprawnienia w przepływie pracy. Identyfikator pakietu dokumentów jest podany w adresie URL zasobu, a użytkownik przepływu pracy jest identyfikowany przez kolejność, w której jest dodawany do przepływu pracy. |
| Aktualizowanie uwierzytelniania użytkownika przepływu pracy (otwieranie dokumentu) pakietu Enterprise |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do aktualizowania uwierzytelniania pakietów i czasu trwania dostępu dla adresatów. Ten interfejs API może być również używany przez administratora przedsiębiorstwa lub użytkownika przedsiębiorstwa, jeśli zmienna "scope" została użyta w żądaniu uwierzytelniania |
| Aktualizowanie użytkownika przepływu pracy |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do aktualizowania szczegółów adresata, grupy lub właściciela miejsca, który został już dodany do przepływu pracy. Zwykle to wywołanie jest przydatne po zastosowaniu szablonu do dokumentu, a aplikacje biznesowe chcą zastąpić szczegóły określonego użytkownika w przepływie pracy. Identyfikator dokumentu przepływu pracy jest podany w adresie URL zasobu, a odbiorca przepływu pracy jest identyfikowany przez kolejność, w której jest dodawany do przepływu pracy. Pamiętaj, że przygotowanie dokumentu typu XML obsługuje tylko typy ról "SIGNER", "REVIEWER" i "CARBON_COPY". |
| Aktualizowanie zasad certyfikacji dla dokumentu |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do aktualizowania ustawień sygnatury certyfikacji dla dokumentu w pakiecie. |
| Dodaj pakiet |
Ten interfejs API usługi służy do dodawania/tworzenia pakietu dokumentów do przechowywania co najmniej jednego dokumentu. Ten pakiet może następnie służyć do dodawania dokumentów i adresatów w celu uruchomienia nowego przepływu pracy. Jak wspomniano wcześniej, to wywołanie jest obowiązkowe, jeśli chcesz pracować z dokumentami. Pakiet musi istnieć przed przekazaniem lub dodaniem dokumentów do witryny SigningHub. Nawet pojedynczy dokument jest częścią pakietu: pakietu zawierającego jeden dokument. Uwaga: w razie potrzeby można zmienić nazwę pakietu po utworzeniu. |
| Dodaj pole początkowe |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do dodawania pola inicjałów do dokumentu w pakiecie. Co najmniej jeden użytkownik musi istnieć w przepływie pracy przed dodaniu pól (danych wejściowych i podpisów) do dokumentu w ten sposób. Numer zamówienia odpowiada odbiorcy w przepływie pracy. W związku z tym ta liczba musi być równa lub mniejsza niż całkowita liczba użytkowników w przepływie pracy. Poniższy przykład przypisuje to nowe pole podpisu do pierwszej osoby w przepływie pracy. Aby uzyskać więcej informacji, zobacz Dodawanie użytkowników do przepływu pracy . Pamiętaj, że jeśli masz dokument z zastosowanym szablonem lub zastosowano go przy użyciu interfejsów API, przepływ pracy będzie już zawierać użytkowników. |
|
Dodaj pole Radio |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do dodawania pola wyboru do dokumentu w pakiecie. Co najmniej jeden użytkownik musi istnieć w przepływie pracy przed dodaniu pól (danych wejściowych i podpisów) do dokumentu w ten sposób. Numer zamówienia odpowiada odbiorcy w przepływie pracy. W związku z tym ta liczba musi być równa lub mniejsza niż całkowita liczba użytkowników w przepływie pracy. Poniższy przykład przypisuje to nowe pole podpisu do pierwszej osoby w przepływie pracy. Aby uzyskać więcej informacji, zobacz Dodawanie użytkowników do przepływu pracy . Pamiętaj, że jeśli masz dokument z zastosowanym szablonem lub zastosowano go przy użyciu interfejsów API, przepływ pracy będzie już zawierać użytkowników. Jeśli nie podano parametrów szerokości i wysokości, zostanie przypisany domyślny rozmiar 10x10. Jeśli zostanie podana szerokość lub wysokość (lub obie), system porówna te podane wartości ze sobą. Większa wartość między szerokością a wysokością zostanie przypisana do obu wymiarów. |
| Dodawanie grup do przepływu pracy |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do dodawania grup jako adresata do przepływu pracy. Grupa SigningHub oznacza, że każdy członek grupy może wykonać akcję, tj. podpisać, w imieniu wszystkich członków grupy. Zanotuj, że grupa zostanie dodana jako ostatni użytkownik/grupa w przepływie pracy. W związku z tym może być wymagana dalsza praca w celu usunięcia bieżącego użytkownika/grupy, która jest już obecna w przepływie pracy. Podczas przygotowywania dokumentów typu XML obsługiwane są tylko typy ról "SIGNER", "REVIEWER" i "CARBON_COPY" |
| Dodawanie kodu QR |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do dodawania kodu QR do dokumentu w pakiecie. |
| Dodawanie lub aktualizowanie dokumentu z biblioteki |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do dodawania dokumentu z biblioteki użytkownika do pakietu. Identyfikator pakietu jest podany w adresie URL. Identyfikator dokumentu powinien być również podany jako "document_id" w adresie URL zasobu, aby zidentyfikować dokument biblioteki do skopiowania. Pamiętaj, że pakiet musi już istnieć, zanim będzie można dodać dokument przy użyciu tego wywołania. |
|
Dodawanie pola Check |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do dodawania pola wyboru do dokumentu w pakiecie. Co najmniej jeden użytkownik musi istnieć w przepływie pracy przed dodaniu pól (danych wejściowych i podpisów) do dokumentu w ten sposób. Numer zamówienia odpowiada odbiorcy w przepływie pracy. W związku z tym ta liczba musi być równa lub mniejsza niż całkowita liczba użytkowników w przepływie pracy. Poniższy przykład przypisuje to nowe pole podpisu do pierwszej osoby w przepływie pracy. Aby uzyskać więcej informacji, zobacz Dodawanie użytkowników do przepływu pracy . Pamiętaj, że jeśli masz dokument z zastosowanym szablonem lub zastosowano go przy użyciu interfejsów API, przepływ pracy będzie już zawierać użytkowników. Jeśli nie podano parametrów szerokości i wysokości, zostanie przypisany domyślny rozmiar 10x10. Jeśli zostanie podana szerokość lub wysokość (lub obie), system porówna te podane wartości ze sobą. Większa wartość między szerokością a wysokością zostanie przypisana do obu wymiarów. |
| Dodawanie pola osoby |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do dodawania pola podpisu osoby do dokumentu w pakiecie. Co najmniej jeden użytkownik musi istnieć w przepływie pracy przed dodaniu pól (danych wejściowych i podpisów) do dokumentu w ten sposób. Numer zamówienia odpowiada odbiorcy w przepływie pracy. W związku z tym ta liczba musi być równa lub mniejsza niż całkowita liczba użytkowników w przepływie pracy. Poniższy przykład przypisuje to nowe pole podpisu do pierwszej osoby w przepływie pracy. Aby uzyskać więcej informacji, zobacz Dodawanie użytkowników do przepływu pracy . Pamiętaj, że jeśli masz dokument z zastosowanym szablonem lub zastosowano go przy użyciu interfejsów API, przepływ pracy będzie już zawierać użytkowników. Aby hostować spotkanie osobiście, użytkownik usługi SigningHub musi być częścią przepływu pracy. Należy je dodać z rolą "INPERSON_HOST" lub "SIGNER". W przypadku opcji hosta nie wymagają pola podpisu ani danych wejściowych w dokumencie, a pole podpisu osoby może być podpisane przez zarejestrowanego użytkownika bez podpisywania w usłudze. Należy pamiętać, że jest to specjalny scenariusz przepływu pracy, w którym oczekiwano, że użytkownik i odbiorca usługi SigningHub będą znajdować się w tej samej lokalizacji. Ten typ podpisu nie jest przeznaczony do użycia w przypadku, gdy dokument jest udostępniany adresatom za pośrednictwem linku poczty e-mail w normalnej luźnej metodzie integracji. |
| Dodawanie pola podpisu cyfrowego |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do dodawania pola podpisu cyfrowego do dokumentu w pakiecie. Co najmniej jeden użytkownik musi istnieć w przepływie pracy przed dodaniu pól (danych wejściowych i podpisów) do dokumentu w ten sposób. Numer zamówienia odpowiada odbiorcy w przepływie pracy. W związku z tym ta liczba musi być równa lub mniejsza niż całkowita liczba użytkowników w przepływie pracy. Poniższy przykład przypisuje to nowe pole podpisu do pierwszej osoby w przepływie pracy. Aby uzyskać więcej informacji, zobacz Dodawanie użytkowników do przepływu pracy . Pamiętaj, że jeśli masz dokument z zastosowanym szablonem lub zastosowano go przy użyciu interfejsów API, przepływ pracy będzie już zawierać użytkowników. |
| Dodawanie pola tekstowego |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do dodawania pola wprowadzania tekstu do dokumentu w pakiecie. Co najmniej jeden użytkownik musi istnieć w przepływie pracy przed dodaniu pól (danych wejściowych i podpisów) do dokumentu w ten sposób. Numer zamówienia odpowiada odbiorcy w przepływie pracy. W związku z tym ta liczba musi być równa lub mniejsza niż całkowita liczba użytkowników w przepływie pracy. Poniższy przykład przypisuje to nowe pole podpisu do pierwszej osoby w przepływie pracy. Aby uzyskać więcej informacji, zobacz Dodawanie użytkowników do przepływu pracy . Pamiętaj, że jeśli masz dokument z zastosowanym szablonem lub zastosowano go przy użyciu interfejsów API, przepływ pracy będzie już zawierać użytkowników. |
| Dodawanie symbolu zastępczego do przepływu pracy |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do dodawania symbolu zastępczego do przepływu pracy w pakiecie. Posiadacz zastępczy jest wymagany, jeśli nie znasz tożsamości zamierzonego adresata w przepływie pracy. Zanotuj, że symbol zastępczy zostanie dodany jako ostatni użytkownik w przepływie pracy. W związku z tym może być wymagana dalsza praca w celu usunięcia bieżącego użytkownika/grupy, która jest już obecna w przepływie pracy. Dodanie posiadacza zastępczego umożliwia kontynuowanie i dodawanie do dokumentu pól podpisów i/lub danych wejściowych, które następnie można przypisać do poszczególnych użytkowników na późniejszym etapie. Podczas przygotowywania dokumentów typu XML obsługiwane są tylko typy ról "SIGNER", "REVIEWER" i "CARBON_COPY" |
| Dodawanie użytkowników do przepływu pracy |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do dodawania adresatów do przepływu pracy. To wywołanie spowoduje dodanie adresata tylko do przepływu pracy. Oznacza to, że żadne pola aktualnie w dokumencie nie będą automatycznie przypisywane do nowych adresatów ani nie będą tworzyć nowych pól. Zanotuj, że adresaci zostaną dodani jako ostatnia osoba w przepływie pracy. W związku z tym może być wymagana dalsza praca w celu usunięcia bieżących adresatów już obecnych w przepływie pracy. Co najmniej jeden użytkownik musi istnieć w przepływie pracy, zanim do dokumentu można dodać pola (dane wejściowe i podpis). Zwróć uwagę, że dane wejściowe akceptują co najmniej jednego użytkownika w jednym wywołaniu. W tym konkretnym wywołaniu użytkownik jest znaną osobą fizyczną. Jednak te same reguły dotyczą grup i symboli zastępczych. W jednym z tych przypadków odbiorca staje się grupą użytkowników, w której dowolny członek grupy może podpisać dokument lub symbol zastępczy. Ten ostatni przypadek jest używany, gdy nie znasz tożsamości zamierzonego sygnatariusza. Uwaga Kolejność podpisywania przepływu pracy usługi SigningHub rozpoczyna się od "1". W związku z tym dodanie użytkownika do przepływu pracy bez bieżących adresatów rozpoczyna nową liczbę zamówień podpisywania. Parametr "signing_order" jest obowiązkowy, jeśli typ przepływu pracy to "niestandardowy". Ważne, użycie tego wywołania interfejsu API może mieć wpływ na typ przepływu pracy. Jeśli w przepływie pracy sekwencyjnym znajdują się bieżąci adresaci, a nowy jest dodawany z tą samą kolejnością podpisywania co bieżący odbiorca, ta część przepływu pracy zmienia się automatycznie z sekwencyjnego na równoległy. W związku z tym ogólny przepływ pracy jest teraz typu niestandardowy, w przeciwieństwie do czysto sekwencyjnych. Dodanie adresata z tym samym zamówieniem podpisywania co dwa lub równoległe adresaty nie zmienia przepływu pracy. W tym konkretnym punkcie przepływu pracy znajduje się tylko trzech lub więcej adresatów; wszystkie w kolejności równoległej. Pamiętaj, że podczas przygotowywania dokumentów typu XML obsługiwane są tylko typy ról "SIGNER", "REVIEWER" i "CARBON_COPY" |
| Dokument odrzuć strażnika |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do odrzucania dokumentu przez określonego użytkownika w podanej kolejności. |
| Dokument zatwierdzania strażnika |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do zatwierdzania dokumentu przez określonego użytkownika w podanej kolejności. |
| Inicjały wypełnienia |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do wypełniania pola inicjałów w dokumencie przez określonego użytkownika w podanej kolejności. |
| Kończenie przetwarzania |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do zakończenia przetwarzania dokumentów po podpisaniu wszystkich pól podpisu. Ta metoda jest używana głównie przez natywne aplikacje mobilne SigningHub dla systemów iOS i Android oraz przypadki użycia mobilnych sieci Web. Ogólne aplikacje biznesowe wykorzystujące ścisłą integrację z odpowiednim portalem nie muszą wywoływać tej metody. Jednak w przypadku korzystania z interfejsu API podpisywania dokumentu (i dlatego użytkownik nie jest wyświetlany z wizualną reprezentacją dokumentu, którego zażądano podpisania), wywołanie tego interfejsu API jest wymagane w celu zapewnienia, że odpowiedni przepływ pracy będzie kontynuowany lub zakończony. Na przykład po zastosowaniu wszystkich podpisów przy użyciu wywołania interfejsu API "ślepego" podpisywania dokumentu dokument nie będzie wyświetlany jako stan "Ukończono" dla właściciela do momentu wywołania tego interfejsu API. Właściciel dokumentu zobaczy stan "W toku" do momentu wywołania tego interfejsu API. W ramach natywnych aplikacji mobilnych usługi SigningHub i mobilnych przypadków użycia sieci Web to wywołanie jest niezbędne, aby upewnić się, że każdy użytkownik wykonuje odpowiednie działania w odniesieniu do aplikacji SigningHub.Na przykład po podpisaniu dokumentu w aplikacji SigningHub ta metoda jest wywoływana przez aplikację, aby upewnić się, że przepływ pracy będzie nadal przetwarzany, a następny sygnatariusz jest powiadamiany, a stan dokumentu jest dostępny za pośrednictwem skonfigurowanego adresu URL wywołania zwrotnego. |
| Odrzuć dokument |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do odrzucania dokumentu przez określonego użytkownika w podanej kolejności. |
| Odwołaj dokument |
Aplikacje biznesowe mogą używać tego interfejsu API usługi, aby zatrzymać przepływ pracy w toku. Identyfikator dokumentu jest podany w adresie URL zasobu. Po odwołaniu stanu dokumentu automatycznie zmieni się na "WERSJA ROBOCZA". |
| Pakiety podpisywania zbiorczego |
Aplikacje biznesowe mogą używać tego interfejsu API do podpisywania/udostępniania/podpisywania i udostępniania wielu dokumentów (zarówno elektronicznych, jak i cyfrowych) bez wyświetlania dokumentów użytkownikowi końcowemu. Ten interfejs API wymaga informacji z aplikacji biznesowej na temat pakietów dokumentów oraz szczegółów podpisów, pól osobiście i inicjałów. Po pomyślnym zakończeniu transakcji podpisywania zbiorczego interfejs API zwróci stany i identyfikatory transakcji pakietów dokumentów. W przeciwieństwie do interfejsu API podpisywania dokumentu ten interfejs API nie tylko podpisuje pakiet dokumentu, ale także oznacza go jako zatwierdzony i przeglądany w oparciu o to, czy odbiorca jest użytkownikiem podpisanym, edytorem czy recenzentem. Każdy pakiet dokumentów, dla którego stan jest zwracany jako ukończony, został podpisany, zatwierdzony lub przejrzyszony przez ten interfejs API. Podpisywanie zbiorcze działa ze wszystkimi metodami uwierzytelniania w czasie podpisywania. Jeśli funkcja SIGN zostanie przekazana jako bulk_action, a pakiet jest w stanie Wersja robocza, znak i udział zostaną wykonane automatycznie. Ten interfejs API należy wywołać po interfejsie API dokumentów wstępnego podpisywania zbiorczego . Jeśli przed podpisaniem musisz wprowadzić zmiany w dowolnym dokumencie, interfejs API pól formularza wypełnienia powinien być wywoływany przed wywołaniem interfejsu API dokumentu podpisywania wstępnego. Pamiętaj, że wszystkie obowiązkowe pola wejściowe w dokumencie wymagają ukończenia przed pomyślnym ukończeniem tego interfejsu API; natomiast pola wypełnione automatycznie (takie jak Nazwa, Adres e-mail, Data, Stanowisko itp.) zostaną wypełnione automatycznie. Sygnatariusz jest identyfikowany przez token dostępu przedstawiony w wywołaniu. W związku z tym uwierzytelnianie sygnatariusza jest wymagane przed wykonaniem tego wezwania. Nie można uwierzytelnić się jako administrator przedsiębiorstwa za pomocą zmiennej zakresu i podpisać dokument w imieniu użytkownika. Token dostępu musi zostać wystawiony sygnatariuszowi w wyniku uwierzytelniania bezpośredniego. Po podpisaniu dokumentu można zobaczyć odpowiedź weryfikacyjną z interfejsu API stanu podpisywania zbiorczego . Pierwsze lub drugie użycie protokołu OTP na potrzeby uwierzytelniania W przypadku włączenia uwierzytelniania OTP dla operacji podpisywania po stronie serwera aplikacje klienckie będą musiały wygenerować protokół OTP dla numeru telefonu komórkowego przy użyciu uwierzytelniania podpisywania zbiorczego za pośrednictwem wywołania interfejsu API OTP. Odpowiednie aplikacje biznesowe muszą pobrać protokół OTP z użycia i przesłać go podczas wykonywania wywołania interfejsu API. Odbywa się to przy użyciu nagłówka "x-otp" w żądaniu. |
| Pobieranie pakietów |
Aplikacje biznesowe mogą używać tego interfejsu API usługi, aby uzyskać listę dokumentów filtrowanych według różnych stanów. Użytkownicy mogą podzielić rekordy na strony, podając liczbę rekordów na stronę. |
| Pobieranie przypomnienia o przepływie pracy |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do aktualizowania przypomnień dla adresatów, którzy zostali już dodani do przepływu pracy. Zwykle to wywołanie jest przydatne po zastosowaniu szablonu do dokumentu, a aplikacje biznesowe chcą zastąpić ustawienia przypomnień w przepływie pracy. Identyfikator dokumentu przepływu pracy jest podany w adresie URL zasobu, a odbiorca przepływu pracy jest identyfikowany przez kolejność, w której jest dodawany do przepływu pracy. |
| Pobieranie pól dokumentu |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do pobierania pól dokumentów, np. inicjałów, osób, pól podpisu lub pól formularza. |
| Pobieranie szablonów |
Aplikacje biznesowe mogą używać tego interfejsu API usługi, aby uzyskać listę szablonów dla bieżącego użytkownika. Można wyszukiwać na podstawie kryterium podanego w nagłówku "x-search-text". Ponadto można przeszukiwać szablony osobiste użytkownika lub szablony przedsiębiorstwa zgodnie z ich rolą użytkownika przez administratora przedsiębiorstwa. |
| Pobieranie szablonów przedsiębiorstwa |
Aplikacje biznesowe mogą używać tego interfejsu API usługi, aby uzyskać listę szablonów przedsiębiorstwa bieżącego użytkownika. Oznacza to, że administrator przedsiębiorstwa lub użytkownik przedsiębiorstwa, jeśli zmienna "scope" została użyta w żądaniu uwierzytelniania. Można wyszukiwać na podstawie kryterium podanego w nagłówku "x-search-text". |
| Pobieranie szczegółów dokumentu |
Aplikacje biznesowe mogą używać tego interfejsu API usługi, aby uzyskać szczegółowe informacje o dokumencie. Identyfikator dokumentu jest podany w adresie URL jako "{document_id}". |
| Pobieranie szczegółów pakietu |
Aplikacje biznesowe mogą używać tego interfejsu API usługi, aby uzyskać szczegółowe informacje o pakiecie. Ten interfejs API może być również używany przez aplikację biznesową do wykonywania akcji w imieniu użytkownika przedsiębiorstwa za pośrednictwem pozycji "Uwierzytelnianie zakresu". |
| Pobieranie szczegółów przepływu pracy |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do uzyskiwania szczegółów przepływu pracy dla pakietu. |
| Pobieranie uwierzytelniania użytkownika przepływu pracy (otwieranie dokumentu) pakietu Enterprise |
Aplikacje biznesowe mogą używać tego interfejsu API usługi, aby uzyskać ustawienia zabezpieczeń dostępu włączone dla pakietu. Adresaci, dla których skonfigurowano zabezpieczenia, są identyfikowani przez kolejność w adresie URL. Identyfikator pakietu jest również identyfikowany w adresie URL żądania. Adresaci nie będą mogli uzyskać dostępu do pakietu dokumentów poza zakresem tego czasu trwania, jeśli włączono zabezpieczenia dostępu. Właściciel dokumentu może również skonfigurować zabezpieczenia pakietu na podstawie uwierzytelniania dla adresata. |
| Pobieranie użytkowników przepływu pracy |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do uzyskiwania szczegółów przepływu pracy dla pakietu. |
| Pobieranie załączników |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do pobierania załączników dokumentu. |
| Pobierz dokument |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do pobierania bajtów dokumentów. Identyfikator pakietu i identyfikator dokumentu są podane w adresie URL zasobu. |
| Pobierz pakiet |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do pobierania pakietu dokumentów w formacie binarnym. Identyfikator pakietu jest podany w adresie URL zasobu. Jeśli pakiet zawiera tylko jeden dokument, pobieranie to binarny dokument PDF. Alternatywnie, jeśli pakiet zawiera więcej niż jeden dokument, pobieranie jest plikiem zip binarnym wszystkich dokumentów. Nagłówki x-password i x-otp są opcjonalne. Są one wymagane, jeśli właściciel dokumentu ustawił je podczas fazy tworzenia przepływu pracy. |
| Pobierz załącznik |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do pobierania załącznika dokumentu. |
| Podpisywanie dokumentu |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do podpisywania dokumentu (zarówno elektronicznego, jak i cyfrowego) bez wyświetlania dokumentu użytkownikowi końcowemu przy użyciu usługi SigningHub. Na przykład aplikacja biznesowa może mieć inną metodę wyświetlania dokumentu użytkownikowi, a wymagana jest tylko funkcja podpisywania usługi SigningHub lub w przypadku operacji zbiorczych może być uzasadnione podpisanie bez konieczności wyświetlania i zatwierdzania poszczególnych dokumentów przez użytkownika. Jeśli przed podpisaniem dokumentu zostaną zapisane zmiany, należy wywołać interfejs API pól formularza wypełnienia przed wywołaniem interfejsu API podpisywania dokumentu. Pamiętaj, że wszystkie obowiązkowe pola wejściowe w dokumencie wymagają ukończenia przed pomyślnym ukończeniem tego interfejsu API. Sygnatariusz jest identyfikowany przez token dostępu przedstawiony w wywołaniu. W związku z tym uwierzytelnianie sygnatariusza jest wymagane przed wykonaniem tego wezwania. Nie można uwierzytelnić się jako administrator przedsiębiorstwa za pomocą zmiennej zakresu i podpisać dokument w imieniu użytkownika. Token dostępu musi zostać wystawiony sygnatariuszowi w wyniku uwierzytelniania bezpośredniego. Po zakończeniu tego wywołania ważne jest, aby wywołanie wywołania interfejsu API zakończ dokument był ostatnim sygnatariuszem dokumentu. Przyczyną jest to, że bez wywoływania tego interfejsu API dokument pozostanie w stanie "W toku" właścicielowi dokumentu. Po wywołaniu interfejsu API stan zmieni się na "Ukończono" dla właściciela dokumentu. Po podpisaniu dokumentu można zobaczyć odpowiedź weryfikacyjną z interfejsu API uzyskiwania weryfikacji dokumentu . Pierwsze lub drugie użycie protokołu OTP na potrzeby uwierzytelniania Jeśli uwierzytelnianie OTP jest włączone dla operacji podpisywania po stronie serwera, aplikacje klienckie będą musiały wygenerować OTP dla numeru telefonu komórkowego przy użyciu uwierzytelniania osoby podpisującego za pośrednictwem wywołania interfejsu API OTP. Odpowiednie aplikacje biznesowe muszą pobrać protokół OTP z użycia i przesłać go podczas wykonywania wywołania interfejsu API. Odbywa się to przy użyciu nagłówka "x-otp" w żądaniu. |
| Pola automiejsowe |
Aplikacje biznesowe mogą wywoływać ten interfejs API, aby dodać pola formularza zdefiniowane przez podpis lub użytkownika do dokumentu na podstawie podanego kryterium wyszukiwania. Opcje umieszczania to: po lewej stronie, po prawej stronie, u góry i u dołu. Dokument jest wyszukiwany, a wszystkie wystąpienia spełnianych kryteriów wyszukiwania są przetwarzane. Dzięki temu można dodać wiele pól z jednym wywołaniem. Na przykład przekaż dokument i automatycznie umieść pole podpisu po prawej stronie wszystkich wystąpień słowa "Podpisz tutaj:". Pozwala to zaoszczędzić czas i zagwarantować, że żadne podpisy nie zostaną pominięte w przepływie pracy. Wywołanie interfejsu API obsługuje wszystkie typy pól; a mianowicie elektroniczne, cyfrowe, osobiście, inicjały i pole tekstowe itp. Ponadto wywołanie interfejsu API obsługuje zmienną "order". Oznacza to, że można automatycznie przypisać zestaw pól podpisu do pojedynczego użytkownika. W związku z tym wywołanie można powtórzyć, aby umieścić pola podpisu i przypisać je do więcej niż jednego użytkownika w przepływie pracy. Co najmniej jeden użytkownik musi istnieć w przepływie pracy, aby można było w ten sposób dodać pola podpisu do dokumentu. Numer zamówienia odpowiada odbiorcy w przepływie pracy. W związku z tym ta liczba musi być równa lub mniejsza niż całkowita liczba użytkowników w przepływie pracy. Poniższy przykład przypisuje to nowe pole podpisu do pierwszej osoby w przepływie pracy. To wywołanie interfejsu API może być używane wiele razy w tym samym dokumencie. Powodem tego jest zaspokojenie wielu sygnatariuszy dokumentu. Odbiorca lub sygnatariusz jest identyfikowany przez zmienną "order" przekazaną w wywołaniu. Aby uzyskać więcej informacji, zobacz Dodawanie użytkowników do przepływu pracy . Pamiętaj, że jeśli masz dokument z zastosowanym szablonem lub zastosowano go przy użyciu interfejsów API, przepływ pracy będzie już zawierać użytkowników. |
| Przekazywanie dokumentu |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do dodawania dokumentu do pakietu dokumentów połączonego z kontem użytkownika przedsiębiorstwa. Informacje o dokumencie są wysyłane w nagłówku żądania HTTP, a bajty dokumentu są wysyłane w treści żądania HTTP. Uwaga Usługa SigningHub konwertuje obsługiwane formaty dokumentów na format PDF, jeśli nagłówek "x-convert-document" jest ustawiony na wartość "true". Jedynym obsługiwanym przypadkiem, w którym ta wartość jest ustawiona na wartość "false", jest zachowanie Word formatowania i dokumentów XML. Usługa SigningHub obsługuje szeroką gamę formatów dokumentów, z których każdy można przekonwertować na format PDF po przekazaniu. Kliknij tutaj, aby uzyskać pełną listę. Uwaga Dokumenty PDF nie są zmieniane podczas przekazywania do systemu. Pamiętaj, że pakiet musi już istnieć, zanim będzie można dodać dokument przy użyciu tego wywołania. |
| Przekaż załącznik |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do przekazywania załącznika w dokumencie. |
| Przenoszenie pakietu do folderu Niestandardowe lub Udostępnione miejsce |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do przenoszenia pakietu dokumentów do folderu udostępnionego lub niestandardowego folderu użytkownika. |
| Prześlij dokument |
Jedną z ról usługi SigningHub jest "Edytor". Dzięki temu adresat może edytować pola wejściowe w dokumencie, ale nie wymaga podpisu. Po zakończeniu adresat przesyła swoje zmiany. Przycisk używany w graficznym interfejsie użytkownika nosi nazwę "Prześlij". Jest to równoważna operacja dla edytora w celu przesłania zmian za pośrednictwem wywołania interfejsu API. Kliknij pozycję SigningHub Roles (Role usługi SigningHub ), aby uzyskać opis wszystkich dostępnych ról adresata przepływu pracy. |
| Przypisywanie pola dokumentu |
Aplikacje biznesowe mogą używać tego interfejsu API usługi, aby przypisywać użytkowników do pól wejściowych, np. pól podpisu, a tym samym definiować kolejność podpisywania. Pola muszą być już obecne w dokumencie, a użytkownicy muszą być obecni w przepływie pracy. Identyfikator dokumentu przepływu pracy jest podany w adresie URL zasobu wraz z identyfikatorem pakietu. Gdy adresaci znajdują się w przepływie pracy, są numerowani, zaczynając od jednego i licząc na każdy dodatkowy. W związku z tym, jeśli w przepływie pracy są ponumerowani trzej użytkownicy, numerowane są "1", "2" i "3" z szacunkiem. To wywołanie interfejsu API umożliwia przypisanie użytkownika według numeru zamówienia przepływu pracy do pola wejściowego w dokumencie. |
| Stan podpisywania zbiorczego |
Aplikacje biznesowe mogą używać tego interfejsu API do uzyskiwania stanu określonej transakcji podpisywania zbiorczego wraz ze szczegółami pakietów dokumentów przetworzonych przez interfejs API pakietów podpisywania zbiorczego . Ten interfejs API należy wywołać po interfejsie API pakietów podpisywania zbiorczego. Sygnatariusz jest identyfikowany przez token dostępu przedstawiony w wywołaniu. W związku z tym uwierzytelnianie sygnatariusza jest wymagane przed wykonaniem tego wezwania. Nie można uwierzytelnić się jako administrator przedsiębiorstwa za pomocą zmiennej zakresu i podpisać dokument w imieniu użytkownika. Token dostępu musi zostać wystawiony sygnatariuszowi w wyniku uwierzytelniania bezpośredniego. W przypadku podpisywania RAS właściwość ACTION będzie REMOTE_AUTHORIZATION_REQURIED, a właściwość STATUS będzie oczekująca, co oznacza, że żądanie musi być autoryzowane przy użyciu urządzenia przenośnego. Jeśli proces podpisywania zakończy się niepowodzeniem w niektórych dokumentach z powodu różnych poziomów zapewnienia skonfigurowanych, a użytkownik chce ponownie zainicjować proces podpisywania w celu ukończenia procesu podpisywania w dokumentach zakończonych niepowodzeniem, właściwość ACTION będzie REINITIATE_SIGNING_PROCESS, a właściwość STATUS będzie OCZEKUJĄCA. |
| Stosowanie szablonu przepływu pracy |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do stosowania szablonu przepływu pracy do dokumentu. Identyfikator dokumentu, na którym należy zastosować szablon, znajduje się w adresie URL zasobu. Gdy identyfikator dokumentu ma wartość 0, szablon zostanie zastosowany do wszystkich dokumentów w pacakge. Podczas stosowania szablonu należy pamiętać o tych dwóch ważnych kwestiach: Punkt 1 — jeśli zastosowany szablon zostanie utworzony przy użyciu pliku PDF, który zawiera już pola formularza, upewnij się, że dokument, na którym jest teraz stosowany ten szablon, musi zawierać te pola formularza z wyprzedzeniem, a usługa SigningHub nie utworzy tych pól formularza za pośrednictwem szablonu, a jedynie zastosuje dane formularza i przypisze je do odpowiednich użytkowników. Punkt 2 — jeśli zastosowany szablon jest tworzony, w którym pola formularza są dodawane ręcznie (stąd nie są one pierwotnie obecne w pliku PDF) za pośrednictwem witryny SigningHub, np. pola podpisu, początkowego, podpisu osoby, pól radiowych, pól radiowych, pól tekstowych itp., następnie przy zastosowaniu takiego szablonu te pola formularza zostaną utworzone w dokumencie docelowym, nawet jeśli te pola formularza były już obecne w dokumencie. |
| Udostępnianie pakietu dokumentów |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do udostępniania pakietu dokumentów osobom podpisujący i uruchamiać nowy przepływ pracy. Dokument powinien być już przygotowany przez zastosowanie szablonu i opcjonalnie zaktualizowanie użytkowników i akcji zdefiniowanych w szablonie. Identyfikator pakietu, który ma zostać udostępniony, jest podany w adresie URL zasobu. |
| Ukończ przepływ pracy w środku (zakończ przepływ pracy) |
Aplikacje biznesowe mogą oznaczać przepływ pracy ukończony nawet w środku przepływu pracy. Użyj tego interfejsu API usługi, aby zmienić stan przepływu pracy na ukończony. Jeśli istnieją adresaci, którzy jeszcze nie podpisali dokumentu. Ich podpis nie będzie już wymagany i nie będzie mógł zobaczyć dokumentu w skrzynce odbiorczej. Token elementu nośnego powinien należeć do właściciela dokumentu lub administratora przedsiębiorstwa może użyć zmiennej zakresu, aby uzyskać token dostępu w imieniu właściciela dokumentu w celu wykonania tej akcji. |
| Usuwanie użytkownika przepływu pracy |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do usuwania adresata przepływu pracy. |
| Usuń dokument |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do usuwania dokumentu w pakiecie. |
| Usuń pakiet |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do usuwania dokumentu ze skrzynki odbiorczej użytkownika. Identyfikator pakietu jest podany w adresie URL zasobu jako "{package_id}". Jeśli stan dokumentu to OCZEKUJĄCE, zostanie on automatycznie odrzucony w wyniku operacji usuwania. Jeśli stan dokumentu jest udostępniony, dokument zostanie automatycznie odwołany i przepływ pracy zostanie zatrzymany przed usunięciem dokumentu. |
| Usuń pole dokumentu |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do usuwania pola dokumentu w pakiecie. |
| Usuń przestrzeń udostępnioną |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do usuwania przestrzeni udostępnionej. Dostępność usuwania przestrzeni udostępnionych podlega przypisanej roli użytkownika przedsiębiorstwa. Aby zezwolić na tę aprowizację administrator przedsiębiorstwa, włączy opcję "Zarządzaj przestrzenią udostępnioną" w obszarze Ustawienia dokumentu role>. |
| Usuń załącznik |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do usuwania załącznika dokumentu. |
| Uzyskiwanie historii przepływu pracy |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do pobierania listy akcji wykonywanych w dokumencie. Identyfikator pakietu jest podany w adresie URL zasobu. Pole wyszukiwania (nagłówek x-search-text) jest przeznaczone dla poczty e-mail, nazwy dokumentu, akcji, klucza informacji i wartości infovalue. |
| Uzyskiwanie kontaktów |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do ponawiania prób kontaktów zarówno z kontaktów osobistych, jak i przedsiębiorstwa dla bieżącego użytkownika. Można wyszukiwać na podstawie kryterium podanego w nagłówku "x-search-text". Ponadto istnieje możliwość przeszukiwania określonych kontaktów użytkownika lub przedsiębiorstwa, do którego należy użytkownik. Informacje odpowiedzi wyszukiwania zawierają adres e-mail użytkownika i odpowiednią nazwę użytkownika. |
| Uzyskiwanie przestrzeni udostępnionej |
Aplikacje biznesowe mogą korzystać z tego interfejsu API usługi, aby uzyskać określoną przestrzeń udostępnioną. Ten interfejs API zwraca informacje o przestrzeni udostępnionej, jego właścicielu i współpracowniku. |
| Uzyskiwanie raportu dowodów procesów |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do pobierania raportu dowodów procesu przepływu pracy dokumentu. |
| Uzyskiwanie uprawnień użytkownika przepływu pracy |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do uzyskiwania uprawnień do dokumentu dla adresata. Odbiorca jest identyfikowany przez kolejność w przepływie pracy. Identyfikator pakietu jest podany w adresie URL zasobu. |
| Uzyskiwanie zasad certyfikacji dla dokumentu |
Aplikacje biznesowe mogą używać tego interfejsu API usługi, aby uzyskać certyfikowanie ustawień podpisu dokumentu w pakiecie. |
| Wypełnij pola formularza |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do wypełniania co najmniej jednego pola formularza w dokumencie przez określonego użytkownika w kolejności. |
| Zatwierdzanie dokumentu |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do zatwierdzania dokumentu przez określonego użytkownika w podanej kolejności. |
| Zmienianie nazwy dokumentu |
Aplikacje biznesowe mogą używać tego interfejsu API usługi do zmiany nazwy dokumentu w pakiecie. |
| Zmienianie nazwy pakietu |
Ten interfejs API usługi służy do zmieniania nazwy pakietu dokumentu. Pakiet dokumentu jest identyfikowany przez jego unikatowy identyfikator w adresie URL wywołania. |
Aktualizowanie kodu QR
Aplikacje biznesowe mogą używać tego interfejsu API usługi do aktualizowania kodu QR dokumentu w pakiecie.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, do którego jest dodawany dokument. |
|
Identyfikator dokumentu
|
documentId | True | integer |
Identyfikator dokumentu, dla którego ma zostać podjęta akcja. |
|
field_name
|
field_name | True | string |
Bieżąca nazwa pola, które ma zostać zaktualizowane. |
|
renamed_as
|
renamed_as | string |
Zaktualizowano nazwę pola, jeśli zmiana nazwy jest przeznaczona. |
|
|
page_no
|
page_no | True | integer |
Numer strony, dla którego należy zaktualizować pole |
|
x
|
x | True | double |
Lewa lokalizacja pola w pikselach. |
|
y
|
y | True | double |
Górna lokalizacja pola w pikselach. |
|
width
|
width | True | double |
Szerokość pola w pikselach. |
|
height
|
height | True | double |
Wysokość pola w pikselach. |
|
dane
|
data | string |
Dane zwykłego tekstu, które mają być zakodowane w kodzie QR. Wartość domyślna to adres URL wygenerowany w celu uzyskania dostępu do powiązanego dokumentu. np. {base_url}/document/{document_unique_id} |
|
|
error_correction_level
|
error_correction_level | True | string |
Poziom korekty błędów dla kodu QR, który określa ilość nadmiarowości danych. Opcje to: L (Niski), M (Średni), Q (Kwartyl) i H (Wysoki). Wyższe poziomy oferują większą odporność na błędy. Wartość domyślna to "Q" |
|
kodowanie
|
encoding | True | string |
Określa tryb kodowania znaków dla zawartości kodu QR. Obsługiwane opcje to: Domyślne, Iso8859_1, Iso8859_2 i Utf8. Wartość domyślna to "Default" (Wartość domyślna) |
|
pixels_per_module
|
pixels_per_module | True | integer |
Określa liczbę pikseli na moduł w kodzie QR. Większa liczba powoduje zwiększenie i bardziej szczegółowy kod QR. Wartość domyślna to "20" Możliwe wartości to: 20 | 30 | 40 | 50 |
|
add_margins
|
add_margins | True | boolean |
Wskazuje, czy strefy ciche (marginesy) powinny być rysowane wokół kodu QR. Strefy ciche pomagają skanerom wykrywać i dekodować kod QR dokładniej. Wartość domyślna to "true" |
|
kropki
|
dots | string |
Reprezentuje ciemny kolor używany dla kropek w kodzie QR. Wartość domyślna to "black". np. "#0000000" |
|
|
tło
|
background | string |
Reprezentuje jasny kolor używany na tle kodu QR. Wartość domyślna to "biały". np. "#ffffff" |
|
|
base64
|
base64 | string |
Opcjonalna ikona (base64) do umieszczenia w środku kodu QR. |
|
|
hide_background_dots
|
hide_background_dots | True | boolean |
Kolor tła za ikoną, jeśli zostanie podana ikona. Jeśli kolor nie jest dostarczany przezroczyste tło jest zaimplementowane. |
|
size
|
size | True | integer |
Rozmiar ikony jako procent rozmiaru kodu QR, jeśli zostanie podana ikona. Wartość domyślna to "15". Możliwe wartości to: 10 | 15 | 20 | 25 | 30 | 35 | 40 |
Zwraca
- Body
- UpdateQrCodeResponse
Aktualizowanie kolejności użytkowników przepływu pracy
Aplikacje biznesowe mogą używać tego interfejsu API usługi do aktualizowania kolejności adresata w przepływie pracy.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, do którego mają zostać dodani adresaci. |
|
Zamówienie
|
order | True | integer |
Istniejąca kolejność adresata, który ma zostać zaktualizowany. |
|
porządek
|
order | True | integer |
Kolejność adresata, który ma zostać zaktualizowany. |
Zwraca
- response
- object
Aktualizowanie pola checkbox
Aplikacje biznesowe mogą używać tego interfejsu API usługi do aktualizowania pola wyboru dokumentu w pakiecie.
Zwróć uwagę, że można zmienić wszystkie parametry wejściowe. Jeśli chcesz zachować bieżące ustawienie, prześlij je w wywołaniu bez zmian. W związku z tym można użyć tych samych parametrów co podczas dodawania pola wejściowego lub informacji zwracanych przez polecenie Pobierz pola dokumentu. Ten ostatni może być używany podczas stosowania szablonu lub tworzenia dokumentu przy użyciu interfejsu GUI.
Nie można zaktualizować szerokości i wysokości. Pozostaną one takie same, jak w przypadku ich dodania.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, do którego jest dodawany dokument. |
|
Identyfikator dokumentu
|
documentId | True | integer |
Identyfikator dokumentu, dla którego ma zostać podjęta akcja. |
|
field_name
|
field_name | True | string |
Bieżąca nazwa pola, które ma zostać zaktualizowane. |
|
renamed_as
|
renamed_as | string |
Zaktualizowano nazwę pola, jeśli zmiana nazwy jest przeznaczona. |
|
|
page_no
|
page_no | True | integer |
Numer strony, na którym ma zostać utworzone pole. |
|
wartość
|
value | string |
Wartość pola. Możliwe wartości to "true" lub "false" |
|
|
x
|
x | True | double |
Lewa lokalizacja pola w pikselach. |
|
y
|
y | True | double |
Górna lokalizacja pola w pikselach. |
|
width
|
width | True | double |
Szerokość pola w pikselach. |
|
height
|
height | True | double |
Wysokość pola w pikselach. |
|
validation_rule
|
validation_rule | string |
Co najmniej jedna reguła sprawdzania poprawności możliwych wartości pól to "OBOWIĄZKOWE" lub "OPCJONALNE". |
|
|
Identyfikator folderu
|
x-folder-id | string |
Określ identyfikator folderu, aby pobrać elementy folderu, gdy jest zaangażowany folder przestrzeni udostępnionej. |
Zwraca
- response
- object
Aktualizowanie pola osoby
Aplikacje biznesowe mogą używać tego interfejsu API usługi do aktualizowania pola podpisu osoby dokumentu w pakiecie.
Zwróć uwagę, że można zmienić wszystkie parametry wejściowe. Jeśli chcesz zachować bieżące ustawienie, prześlij je w wywołaniu bez zmian. W związku z tym można użyć tych samych parametrów co podczas dodawania pola wejściowego lub informacji zwracanych przez polecenie Pobierz pola dokumentu. Ten ostatni może być używany podczas stosowania szablonu lub tworzenia dokumentu przy użyciu interfejsu GUI.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, do którego jest dodawany dokument. |
|
Identyfikator dokumentu
|
documentId | True | integer |
Identyfikator dokumentu, dla którego ma zostać podjęta akcja. |
|
field_name
|
field_name | True | string |
Bieżąca nazwa pola, które ma zostać zaktualizowane. |
|
renamed_as
|
renamed_as | string |
zaktualizowana nazwa pola, jeśli jest przeznaczona zmiana nazwy. |
|
|
page_no
|
page_no | True | integer |
Numer strony, na którym ma zostać utworzone pole. |
|
symbol zastępczy
|
placeholder | string |
Identyfikator ciągu dla pola osoby, może to być Klient, Jack, CEO itp. |
|
|
x
|
x | True | double |
Lewa lokalizacja pola w pikselach. |
|
y
|
y | True | double |
Górna lokalizacja pola w pikselach. |
|
width
|
width | True | double |
Szerokość pola w pikselach. |
|
height
|
height | True | double |
Wysokość pola w pikselach. |
|
wyświetlać
|
display | string |
Widoczność pola, które ma zostać zaktualizowane, możliwe wartości to "VISIBLE" i "INVISIBLE" |
|
|
level_of_assurance
|
level_of_assurance | array of string |
Poziom zapewniania, który ma zostać zaktualizowany. Możliwe wartości to "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ELECTRONIC_SIGNATURE" |
|
|
enabled
|
enabled | True | boolean |
Prawda, jeśli dla pola jest włączone uwierzytelnianie. W przeciwnym razie fałsz. |
|
enabled
|
enabled | True | boolean |
Prawda, jeśli dla pola jest włączone uwierzytelnianie OTP wiadomości SMS/e-mail. W przeciwnym razie fałsz. |
|
mobile_number
|
mobile_number | string |
Numer telefonu komórkowego adresata, do którego przypisano pole. |
|
|
enabled
|
enabled | True | boolean |
Prawda, jeśli dla pola jest włączone uwierzytelnianie TOTP. W przeciwnym razie fałsz. |
|
Identyfikator folderu
|
x-folder-id | string |
Określ identyfikator folderu, aby pobrać elementy folderu, gdy jest zaangażowany folder przestrzeni udostępnionej. |
Zwraca
- response
- object
Aktualizowanie pola początkowego
Aplikacje biznesowe mogą używać tego interfejsu API usługi do aktualizowania pola inicjałów dokumentu w pakiecie.
Zwróć uwagę, że można zmienić wszystkie parametry wejściowe. Jeśli chcesz zachować bieżące ustawienie, prześlij je w wywołaniu bez zmian.
W związku z tym można użyć tych samych parametrów co podczas dodawania pola wejściowego lub informacji zwracanych przez polecenie Pobierz pola dokumentu. Ten ostatni może być używany podczas stosowania szablonu lub tworzenia dokumentu przy użyciu interfejsu GUI.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, do którego jest dodawany dokument. |
|
Identyfikator dokumentu
|
documentId | True | integer |
Identyfikator dokumentu, dla którego ma zostać podjęta akcja. |
|
field_name
|
field_name | True | string |
Bieżąca nazwa pola, które ma zostać zaktualizowane. |
|
renamed_as
|
renamed_as | string |
Zaktualizowano nazwę pola, jeśli zmiana nazwy jest przeznaczona. |
|
|
page_no
|
page_no | True | integer |
Numer strony, na którym ma zostać utworzone pole. |
|
x
|
x | True | double |
Lewa lokalizacja pola w pikselach. |
|
y
|
y | True | double |
Górna lokalizacja pola w pikselach. |
|
width
|
width | True | double |
Szerokość pola w pikselach. |
|
height
|
height | True | double |
Wysokość pola w pikselach. |
Zwraca
- response
- object
Aktualizowanie pola podpisu cyfrowego
Aplikacje biznesowe mogą używać tego interfejsu API usługi do aktualizowania pola podpisu cyfrowego dokumentu w pakiecie.
Zwróć uwagę, że można zmienić wszystkie parametry wejściowe. Jeśli chcesz zachować bieżące ustawienie, prześlij je w wywołaniu bez zmian. W związku z tym można użyć tych samych parametrów co podczas dodawania pola wejściowego lub informacji zwracanych przez polecenie Pobierz pola dokumentu. Ten ostatni może być używany podczas stosowania szablonu lub tworzenia dokumentu przy użyciu interfejsu GUI.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, do którego jest dodawany dokument. |
|
Identyfikator dokumentu
|
documentId | True | integer |
Identyfikator dokumentu, dla którego ma zostać podjęta akcja. |
|
field_name
|
field_name | True | string |
Bieżąca nazwa pola, które ma zostać zaktualizowane. |
|
level_of_assurance
|
level_of_assurance | array of string |
Poziom zapewniania, który ma zostać zaktualizowany. Możliwe wartości to "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE" |
|
|
renamed_as
|
renamed_as | string |
Zaktualizowano nazwę pola, jeśli zmiana nazwy pola jest przeznaczona. |
|
|
page_no
|
page_no | True | integer |
Numer strony, na którym ma zostać utworzone pole. |
|
x
|
x | True | double |
Lewa lokalizacja pola w pikselach. |
|
y
|
y | True | double |
Górna lokalizacja pola w pikselach. |
|
width
|
width | True | double |
Szerokość pola w pikselach. |
|
height
|
height | True | double |
Wysokość pola w pikselach. |
|
wyświetlać
|
display | string |
Widoczność pola, które ma zostać zaktualizowane, możliwe wartości to "VISIBLE" i "INVISIBLE" |
|
|
enabled
|
enabled | True | boolean |
Prawda, jeśli dla pola jest włączone uwierzytelnianie. W przeciwnym razie fałsz. |
|
enabled
|
enabled | True | boolean |
Prawda, jeśli dla pola jest włączone uwierzytelnianie OTP wiadomości SMS/e-mail. W przeciwnym razie fałsz. |
|
mobile_number
|
mobile_number | string |
Numer telefonu komórkowego adresata, do którego przypisano pole. |
|
|
enabled
|
enabled | True | boolean |
Prawda, jeśli dla pola jest włączone uwierzytelnianie TOTP. W przeciwnym razie fałsz. |
|
Identyfikator folderu
|
x-folder-id | string |
Określ identyfikator folderu, aby pobrać elementy folderu, gdy jest zaangażowany folder przestrzeni udostępnionej. |
Zwraca
- response
- object
Aktualizowanie pola RadioBox
Aplikacje biznesowe mogą używać tego interfejsu API usługi do aktualizowania przycisku radiowego dokumentu w pakiecie.
Zwróć uwagę, że można zmienić wszystkie parametry wejściowe. Jeśli chcesz zachować bieżące ustawienie, prześlij je w wywołaniu bez zmian. W związku z tym można użyć tych samych parametrów co podczas dodawania pola wejściowego lub informacji zwracanych przez polecenie Pobierz pola dokumentu. Ten ostatni może być używany podczas stosowania szablonu lub tworzenia dokumentu przy użyciu interfejsu GUI.
Nie można zaktualizować szerokości i wysokości. Pozostaną one takie same, jak w przypadku ich dodania.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, do którego jest dodawany dokument. |
|
Identyfikator dokumentu
|
documentId | True | integer |
Identyfikator dokumentu, dla którego ma zostać podjęta akcja. |
|
field_name
|
field_name | True | string |
Bieżąca nazwa pola, które ma zostać zaktualizowane. |
|
renamed_as
|
renamed_as | string |
Zaktualizowano nazwę pola, jeśli zmiana nazwy jest przeznaczona. |
|
|
page_no
|
page_no | True | integer |
Numer strony, na którym ma zostać utworzone pole. |
|
wartość
|
value | string |
Wartość pola. Możliwe wartości to "true" lub "false" |
|
|
validation_rule
|
validation_rule | True | string |
Co najmniej jedna reguła sprawdzania poprawności możliwych wartości pól to "OBOWIĄZKOWE" lub "OPCJONALNE". |
|
radio_group_name
|
radio_group_name | True | string |
Nazwa grupy, do której należy pole. |
|
x
|
x | True | double |
Lewa lokalizacja pola w pikselach. |
|
y
|
y | True | double |
Górna lokalizacja pola w pikselach. |
|
width
|
width | True | double |
Szerokość pola w pikselach. |
|
height
|
height | True | double |
Wysokość pola w pikselach. |
Zwraca
- response
- object
Aktualizowanie pola tekstowego
Aplikacje biznesowe mogą używać tego interfejsu API usługi do aktualizowania pola tekstowego dokumentu w pakiecie.
Zwróć uwagę, że można zmienić wszystkie parametry wejściowe. Jeśli chcesz zachować bieżące ustawienie, prześlij je w wywołaniu bez zmian. W związku z tym można użyć tych samych parametrów co podczas dodawania pola wejściowego lub informacji zwracanych przez polecenie Pobierz pola dokumentu. Ten ostatni może być używany podczas stosowania szablonu lub tworzenia dokumentu przy użyciu interfejsu GUI.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, do którego jest dodawany dokument. |
|
Identyfikator dokumentu
|
documentId | True | integer |
Identyfikator dokumentu, dla którego ma zostać podjęta akcja. |
|
field_name
|
field_name | True | string |
Bieżąca nazwa pola, które ma zostać zaktualizowane. |
|
renamed_as
|
renamed_as | string |
Zaktualizowano nazwę pola, jeśli zmiana nazwy jest przeznaczona. |
|
|
page_no
|
page_no | True | integer |
Numer strony, na którym ma zostać utworzone pole. |
|
wartość
|
value | string |
Wartość pola. Dla parametru type = DATE oczekiwano wartości w formacie ISO 8601. Zgodnie z formatem RRRR-MM-DD hh:mm:ss +00. Ponieważ wartości dotyczą pól daty, aplikacje klienckie mogą wysyłaćMM-DD RRRR- i ignorować hh:mm:ss +00. Jeśli wartość nie jest w odpowiednim formacie, zostanie zwrócony błąd. |
|
|
max_length
|
max_length | True | integer |
Maksymalna długość wartości dozwolonej w polu. Musi należeć do zakresu od 1 do 9999 |
|
field_type
|
field_type | True | string |
Typ pola w odniesieniu do akceptowania typu wartości, możliwe wartości to "NUMBER" lub "TEXT". |
|
validation_rule
|
validation_rule | True | string |
Co najmniej jedna reguła sprawdzania poprawności możliwych wartości pól to "OBOWIĄZKOWE" lub "OPCJONALNE". |
|
nazwa
|
name | string |
Nazwa czcionki wybranej dla pola tekstowego. Możliwe wartości to "COURIER", "HELVETICA". |
|
|
size
|
size | string |
Rozmiar czcionki wybranej dla pola tekstowego. Możliwe wartości to 8, 10, 12, 14, 16, 18, 20 |
|
|
embedded_size
|
embedded_size | string |
Rozmiar czcionki w oryginalnym dokumencie PDF. |
|
|
x
|
x | True | double |
Lewa lokalizacja pola w pikselach. |
|
y
|
y | True | double |
Górna lokalizacja pola w pikselach. |
|
width
|
width | True | double |
Szerokość pola w pikselach. |
|
height
|
height | True | double |
Wysokość pola w pikselach. |
|
symbol zastępczy
|
placeholder | string |
Deweloperzy mogą udostępniać własne teksty zastępcze. Te symbole zastępcze są wyświetlane w polach tekstowych podczas wyświetlania dokumentu w przeglądarce. |
|
|
format
|
format | string |
Format tekstowy pola. Używane tylko dla pola typu daty. Możliwe wartości to
|
|
|
required
|
required | True | boolean | |
|
typ
|
type | string |
Określa typ reguły sprawdzania poprawności, która jest obecnie zawsze ustawiona na wartość EQUALS dla pola tekstowego. |
|
|
wartość
|
value | string |
Reprezentuje wartość używaną do walidacji. |
Zwraca
- response
- object
Aktualizowanie przestrzeni udostępnionej
Aplikacje biznesowe mogą używać tego interfejsu API usługi do aktualizowania przestrzeni udostępnionej. Dostępność aktualizacji przestrzeni udostępnionych podlega przypisanej roli użytkownika przedsiębiorstwa. Aby zezwolić na tę aprowizację administrator przedsiębiorstwa, włączy opcję "Zarządzaj przestrzenią udostępnioną" w obszarze Ustawienia dokumentu role>.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator przestrzeni udostępnionej
|
id | True | integer |
Identyfikator przestrzeni udostępnionej, którą chcesz zaktualizować |
|
nazwa
|
name | string |
Nazwa przestrzeni udostępnionej |
|
|
nazwa
|
name | True | string |
Nazwa elementu członkowskiego obszaru roboczego |
|
e-mail
|
True | string |
Adres e-mail członka obszaru roboczego |
Zwraca
- response
- object
Aktualizowanie przetwarzania końcowego
Aplikacje biznesowe mogą używać tego interfejsu API usługi do dodawania symbolu zastępczego do przepływu pracy dokumentu w pakiecie.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu dokumentu, dla którego jest aktualizowane przetwarzanie po zakończeniu przetwarzania. |
|
enabled
|
enabled | True | boolean |
Prawda, jeśli przetwarzanie końcowe jest włączone dla pakietu. |
|
contacts
|
contacts | array of string | ||
|
nazwa
|
name | True | string | |
|
e-mail
|
True | string | ||
|
komunikat
|
message | string |
Niestandardowy komunikat ciągu dla wszystkich kontaktów. Wiadomość staje się częścią wiadomości e-mail wysłanej do kontaktów. |
|
|
google_drive
|
google_drive | boolean |
Prawda, jeśli dokument ma zostać przekazany do podanego konta Google po zakończeniu przepływu pracy. |
|
|
Dropbox
|
dropbox | boolean |
Prawda, jeśli dokument ma zostać przekazany do podanego konta dropbox po zakończeniu przepływu pracy. |
|
|
onedrive
|
onedrive | boolean |
Prawda, jeśli dokument ma zostać przekazany do podanego konta usługi OneDrive po zakończeniu przepływu pracy. |
|
|
workflow_recipients
|
workflow_recipients | True | boolean |
Prawda, jeśli raport ukończenia przepływu pracy ma zostać wysłany do wszystkich adresatów przepływu pracy podczas przetwarzania końcowego. Wartość domyślna to false. |
|
document_processing_report
|
document_processing_report | True | boolean |
Prawda, jeśli opcja Wyślij raport przetwarzania dokumentów (XML) ma być włączona dla przepływu pracy |
Zwraca
- response
- object
Aktualizowanie przypomnień przepływu pracy
Aplikacje biznesowe mogą używać tego interfejsu API usługi do aktualizowania przypomnień przepływu pracy dla adresata, który został już dodany do przepływu pracy. Zwykle to wywołanie jest przydatne po zastosowaniu szablonu do dokumentu, a aplikacje biznesowe chcą zastąpić ustawienia przypomnień w przepływie pracy. Identyfikator dokumentu przepływu pracy jest podany w adresie URL zasobu, a odbiorca przepływu pracy jest identyfikowany przez kolejność, w której jest dodawany do przepływu pracy.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, dla którego mają zostać zaktualizowane przypomnienia dotyczące przepływu pracy. |
|
Zamówienie
|
order | True | integer |
Kolejność użytkownika, dla którego przypomnienia dotyczące przepływu pracy mają być aktualizowane. |
|
apply_to_all
|
apply_to_all | True | boolean |
Prawda, jeśli ustawienia przypomnienia mają być stosowane dla wszystkich adresatów w przepływie pracy. |
|
enabled
|
enabled | True | boolean |
Prawda, jeśli ustawienia przypomnienia mają być włączone. |
|
częstotliwość
|
frequency | string |
Częstotliwość przypomnienia. Możliwe wartości to DAYS | GODZIN. |
|
|
remind_after
|
remind_after | True | integer |
Wymagane, w przypadku włączonej właściwości będzie true. Liczba dni, po których pierwsze przypomnienie zostanie wysłane do użytkownika przepływu pracy. |
|
enabled
|
enabled | True | boolean |
Prawda, jeśli są włączone kolejne przypomnienia. |
|
częstotliwość
|
frequency | string |
Powtarzaj częstotliwość przypomnienia. Możliwe wartości to DAYS | GODZIN. |
|
|
keep_reminding_after
|
keep_reminding_after | True | integer |
Wymagane, w przypadku włączonej właściwości będzie true. Liczba dni, po których kolejne przypomnienia zostaną wysłane do użytkownika przepływu pracy. |
|
total_reminders
|
total_reminders | True | integer |
Wymagane, w przypadku włączonej właściwości będzie true. Liczba kolejnych przypomnień zostanie wysłana do użytkownika przepływu pracy. |
Zwraca
- response
- object
Aktualizowanie symbolu zastępczego
Aplikacje biznesowe mogą używać tego interfejsu API usługi do aktualizowania symbolu zastępczego w przepływie pracy. Zwykle to wywołanie jest przydatne po zastosowaniu szablonu do dokumentu, a aplikacje biznesowe chcą zastąpić szczegóły określonego właściciela miejsca w przepływie pracy. Identyfikator dokumentu przepływu pracy jest podany w adresie URL zasobu, a właściciel miejsca przepływu pracy jest identyfikowany przez kolejność, w której jest dodawany do przepływu pracy. Podczas przygotowywania dokumentów typu XML obsługiwane są tylko typy ról "SIGNER", "REVIEWER" i "CARBON_COPY"
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, dla którego ma zostać dodany symbol zastępczy. |
|
Zamówienie
|
order | True | integer |
Kolejność adresata w przepływie pracy. |
|
symbol zastępczy
|
placeholder | string |
Nazwa nowego symbolu zastępczego, który ma zostać dodany w przepływie pracy. Jeśli żadna wartość nie zostanie podana, stara wartość zostanie zachowana. |
|
|
email_notification
|
email_notification | boolean |
Ustawienie jej wartości na wartość "true" powoduje wysłanie powiadomienia e-mail do użytkownika po nadejściu jej zwrotu w przepływie pracy. Ustawienie jej wartości na "false" nie powoduje wysłania powiadomienia e-mail do użytkownika na jego kolei. Jeśli żadna wartość nie zostanie podana, stara wartość zostanie zachowana. |
|
|
rola
|
role | True | string |
Rola adresata do zaktualizowania. Możliwe wartości to "SIGNER", "REVIEWER", "EDITOR", "CARBON_COPY" lub "INPERSON_HOST". Jeśli żadna wartość nie zostanie podana, stara wartość zostanie zachowana. Jednak podczas przygotowywania dokumentów typu XML obsługiwane są tylko typy ról "SIGNER", "REVIEWER" i "CARBON_COPY" |
|
signing_order
|
signing_order | integer |
Kolejność, w której przepływ pracy zostanie podpisany przez adresatów. To zamówienie podpisywania jest ważne, gdy typ przepływu pracy jest ustawiony na "CUSTOM". |
Zwraca
- response
- object
Aktualizowanie szczegółów przepływu pracy
Aplikacje biznesowe mogą używać tego interfejsu API usługi do aktualizowania szczegółów przepływu pracy. Zwykle to wywołanie jest przydatne po zastosowaniu szablonu do dokumentu, ale aplikacje biznesowe chcą zastąpić uprawnienie certyfikacji lub szczegóły przetwarzania końcowego. Identyfikator pakietu jest podany w adresie URL zasobu.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, dla którego należy zaktualizować szczegóły przepływu pracy. |
|
workflow_type
|
workflow_type | string |
Typ przepływu pracy dla pakietu, np. SERIAL, PARALLEL, INDIVIDUAL, CUSTOM. Jeśli żadna wartość nie zostanie podana, stara wartość zostanie zachowana. |
|
|
workflow_mode
|
workflow_mode | string |
Tryb przepływu pracy pakietu, np. (ONLY_ME, ME_AND_OTHERS, ONLY_OTHERS). Jeśli tryb przepływu pracy jest ustawiony na ONLY_ME wówczas żaden współpracownik nie może zostać dodany do pakietu innego, a następnie uwierzytelniony użytkownik |
|
|
continue_on_decline
|
continue_on_decline | boolean |
Prawda, jeśli przepływ pracy musi kontynuować nawet wtedy, gdy jakikolwiek adresat odrzuci dokument. Jeśli żadna wartość nie zostanie podana, stara wartość zostanie zachowana. |
|
|
komunikat
|
message | string |
Niestandardowa wiadomość ciągu od właściciela dokumentu do każdego adresata, ta wiadomość jest wyświetlana w wiadomości e-mail do udostępniania, a także na ekranie. Jeśli żadna wartość nie zostanie podana, stara wartość zostanie zachowana. |
|
|
comments
|
comments | boolean |
Zezwalaj na komentarze |
Zwraca
- response
- object
Aktualizowanie uprawnień użytkownika przepływu pracy
Aplikacje biznesowe mogą używać tego interfejsu API usługi do aktualizowania uprawnień przepływu pracy dla użytkownika, który został już dodany do przepływu pracy. Zwykle to wywołanie jest przydatne po zastosowaniu szablonu do dokumentu, a aplikacje biznesowe chcą zastąpić uprawnienia w przepływie pracy. Identyfikator pakietu dokumentów jest podany w adresie URL zasobu, a użytkownik przepływu pracy jest identyfikowany przez kolejność, w której jest dodawany do przepływu pracy.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, dla którego uprawnienia przepływu pracy mają zostać zaktualizowane. |
|
Zamówienie
|
order | True | integer |
Kolejność adresata, dla którego uprawnienia przepływu pracy mają zostać zaktualizowane. |
|
apply_to_all
|
apply_to_all | True | boolean |
Prawda, jeśli uprawnienia mają być stosowane dla wszystkich adresatów w przepływie pracy. |
|
drukować
|
boolean |
Określa, czy odbiorca może drukować dokument. |
||
|
pobierać
|
download | boolean |
Określa, czy odbiorca może pobrać dokument. |
|
|
add_text
|
add_text | boolean |
Określa, czy odbiorca może dodawać pola tekstowe w dokumencie. |
|
|
change_recipients
|
change_recipients | boolean |
Umożliwia to użytkownikowi zmianę adresata, który jeszcze nie został podpisany. |
|
|
add_attachment
|
add_attachment | boolean |
Określa, czy odbiorca może dodawać załączniki w dokumencie PDF. |
|
|
enabled
|
enabled | True | boolean |
Prawda, jeśli jest włączone powiadomienie prawne. |
|
legal_notice_name
|
legal_notice_name | string |
Nazwa powiadomienia prawnego wybranego dla adresata. |
|
|
enabled
|
enabled | True | boolean |
Enabled |
|
Identyfikator folderu
|
x-folder-id | string |
Określ identyfikator folderu, aby pobrać elementy folderu, gdy jest zaangażowany folder przestrzeni udostępnionej. |
Zwraca
- response
- object
Aktualizowanie uwierzytelniania użytkownika przepływu pracy (otwieranie dokumentu) pakietu Enterprise
Aplikacje biznesowe mogą używać tego interfejsu API usługi do aktualizowania uwierzytelniania pakietów i czasu trwania dostępu dla adresatów. Ten interfejs API może być również używany przez administratora przedsiębiorstwa lub użytkownika przedsiębiorstwa, jeśli zmienna "scope" została użyta w żądaniu uwierzytelniania
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, dla którego należy zaktualizować zabezpieczenia i uwierzytelnianie dostępu do przepływu pracy. |
|
Kolejność adresatów
|
order | True | integer |
Kolejność adresata w przepływie pracy, dla którego ma zostać zaktualizowane zabezpieczenia dostępu i uwierzytelnianie. |
|
apply_to_all
|
apply_to_all | True | boolean |
Prawda, jeśli zabezpieczenia dostępu lub uwierzytelniania mają być stosowane dla wszystkich adresatów w przepływie pracy. |
|
enabled
|
enabled | True | boolean |
Prawda, jeśli dla pakietu jest włączone uwierzytelnianie. |
|
enabled
|
enabled | True | boolean |
Prawda, jeśli dla pakietu włączono uwierzytelnianie hasłem. |
|
user_password
|
user_password | string |
Ciąg hasła, jeśli pole hasła jest włączone. Jeśli hasło zostało już ustawione, a właściciel nie chce go zmienić, usuń pole z odpowiedzi lub wyślij wartość null. |
|
|
enabled
|
enabled | True | boolean |
Prawda, jeśli dla pakietu jest włączone uwierzytelnianie OTP programu SMS. |
|
mobile_number
|
mobile_number | string |
Numer telefonu komórkowego odbiorcy. Numer telefonu komórkowego jest wymagany do wysłania wiadomości SMS do adresata w celu uwierzytelnienia. |
|
|
enabled
|
enabled | True | boolean |
Enabled |
|
enabled
|
enabled | True | boolean |
Prawda, jeśli dla pakietu jest włączone uwierzytelnianie. |
|
mobile_number
|
mobile_number | string |
Numer telefonu komórkowego odbiorcy. Numer telefonu komórkowego jest wymagany do wysłania wiadomości SMS do adresata w celu uwierzytelnienia. |
|
|
enabled
|
enabled | True | boolean |
Enabled |
|
enabled
|
enabled | True | boolean |
Prawda, jeśli dla pakietu włączono zabezpieczenia czasu trwania dostępu. |
|
enabled
|
enabled | True | boolean |
Wartość true, jeśli zabezpieczenia dostępu są włączone przez czas trwania według daty i godziny. |
|
start_date_time
|
start_date_time | date-time |
Data i godzina, z której pakiet będzie dostępny dla adresata. |
|
|
end_date_time
|
end_date_time | date-time |
Data i godzina, po której pakiet nie będzie dostępny dla adresata. |
|
|
enabled
|
enabled | True | boolean |
Prawda, jeśli zabezpieczenia dostępu są włączone przez czas trwania o liczbę dni. |
|
total_days
|
total_days | True | integer |
Łączna liczba dni, dla których pakiet będzie dostępny dla adresata po otrzymaniu pakietu. |
Zwraca
- response
- object
Aktualizowanie użytkownika przepływu pracy
Aplikacje biznesowe mogą używać tego interfejsu API usługi do aktualizowania szczegółów adresata, grupy lub właściciela miejsca, który został już dodany do przepływu pracy. Zwykle to wywołanie jest przydatne po zastosowaniu szablonu do dokumentu, a aplikacje biznesowe chcą zastąpić szczegóły określonego użytkownika w przepływie pracy. Identyfikator dokumentu przepływu pracy jest podany w adresie URL zasobu, a odbiorca przepływu pracy jest identyfikowany przez kolejność, w której jest dodawany do przepływu pracy. Pamiętaj, że przygotowanie dokumentu typu XML obsługuje tylko typy ról "SIGNER", "REVIEWER" i "CARBON_COPY".
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, dla którego użytkownik przepływu pracy musi zostać zaktualizowany. |
|
Zamówienie
|
order | True | integer |
Kolejność użytkownika w przepływie pracy. |
|
user_email
|
user_email | string |
Adres e-mail nowego użytkownika, który ma zostać zaktualizowany w przepływie pracy. Jeśli żadna wartość nie zostanie podana, stara wartość zostanie zachowana. |
|
|
user_name
|
user_name | string |
Nazwa adresata, który ma zostać zaktualizowany. Jeśli żadna wartość nie zostanie podana, stara wartość zostanie zachowana. |
|
|
email_notification
|
email_notification | boolean |
Ustawienie jej wartości na wartość "true" powoduje wysłanie powiadomienia e-mail do użytkownika po nadejściu jej zwrotu w przepływie pracy. Ustawienie jej wartości na "false" nie powoduje wysłania powiadomienia e-mail do użytkownika na jego kolei. Jeśli żadna wartość nie zostanie podana, stara wartość zostanie zachowana. |
|
|
mobile_number
|
mobile_number | string |
Numer telefonu komórkowego. Jeśli żadna wartość nie zostanie podana, stara wartość zostanie zachowana. |
|
|
rola
|
role | True | string |
Rola adresata do zaktualizowania. Możliwe wartości to "SIGNER", "REVIEWER", "EDITOR", "CARBON_COPY" lub "INPERSON_HOST". Jeśli żadna wartość nie zostanie podana, stara wartość zostanie zachowana. Jednak podczas przygotowywania dokumentów typu XML obsługiwane są tylko typy ról "SIGNER", "REVIEWER" i "CARBON_COPY" |
|
signing_order
|
signing_order | integer |
Kolejność, w której przepływ pracy zostanie podpisany przez adresatów. To zamówienie podpisywania jest ważne, gdy typ przepływu pracy jest ustawiony na "CUSTOM". |
|
|
email_language_code
|
email_language_code | string |
kod języka poczty e-mail |
|
|
delivery_method
|
delivery_method | True | string |
Metoda dostarczania odbiorcy w przepływie pracy. Możliwe wartości to "EMAIL", "SMS" lub "EMAIL_AND_SMS". Wartość domyślna to EMAIL |
|
Identyfikator folderu
|
x-folder-id | string |
Określ identyfikator folderu, aby pobrać elementy folderu, gdy jest zaangażowany folder przestrzeni udostępnionej. |
Zwraca
Aktualizowanie zasad certyfikacji dla dokumentu
Aplikacje biznesowe mogą używać tego interfejsu API usługi do aktualizowania ustawień sygnatury certyfikacji dla dokumentu w pakiecie.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, do którego jest dodawany dokument. |
|
Identyfikator dokumentu
|
documentId | True | integer |
Identyfikator dokumentu, na którym ma zostać wykonana akcja. |
|
enabled
|
enabled | True | boolean |
Prawda, jeśli dla dokumentu mają być włączone ustawienia certyfikacji. |
|
uprawnienie
|
permission | True | string |
Certyfikowanie poziomu uprawnień, który ma zostać ustawiony dla dokumentu. Możliwe wartości to "NO_CHANGES_ALLOWED", "FORM_FILLING_ALLOWED" i "FORM_FILLING_WITH_ANNOTATIONS_ALLOWED". |
|
lock_form_fields
|
lock_form_fields | True | boolean |
Wartość true, jeśli pola formularza mają być zablokowane po ostatnim podpisie w bieżącym dokumencie. |
Zwraca
- response
- object
Dodaj pakiet
Ten interfejs API usługi służy do dodawania/tworzenia pakietu dokumentów do przechowywania co najmniej jednego dokumentu. Ten pakiet może następnie służyć do dodawania dokumentów i adresatów w celu uruchomienia nowego przepływu pracy.
Jak wspomniano wcześniej, to wywołanie jest obowiązkowe, jeśli chcesz pracować z dokumentami. Pakiet musi istnieć przed przekazaniem lub dodaniem dokumentów do witryny SigningHub.
Nawet pojedynczy dokument jest częścią pakietu: pakietu zawierającego jeden dokument.
Uwaga: w razie potrzeby można zmienić nazwę pakietu po utworzeniu.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
package_name
|
package_name | string |
Nazwa pakietu. Domyślna nazwa pakietu to zawsze "Bez tytułu", jeśli nie podano package_name. |
|
|
workflow_mode
|
workflow_mode | True | string |
Tryb przepływu pracy, istnieją trzy typy trybów przepływu pracy obsługiwanych w aplikacji. Możliwe wartości to "ONLY_ME", "ME_AND_OTHERS" i "ONLY_OTHERS" |
|
folder_name
|
folder_name | string |
Nazwa folderu. Będzie on używany do przekazywania pakietu w dowolnym folderze użytkownika— jest to folder niestandardowy lub folder udostępniony. |
Zwraca
- Body
- AddPackageResponse
Dodaj pole początkowe
Aplikacje biznesowe mogą używać tego interfejsu API usługi do dodawania pola inicjałów do dokumentu w pakiecie.
Co najmniej jeden użytkownik musi istnieć w przepływie pracy przed dodaniu pól (danych wejściowych i podpisów) do dokumentu w ten sposób. Numer zamówienia odpowiada odbiorcy w przepływie pracy. W związku z tym ta liczba musi być równa lub mniejsza niż całkowita liczba użytkowników w przepływie pracy. Poniższy przykład przypisuje to nowe pole podpisu do pierwszej osoby w przepływie pracy.
Aby uzyskać więcej informacji, zobacz Dodawanie użytkowników do przepływu pracy . Pamiętaj, że jeśli masz dokument z zastosowanym szablonem lub zastosowano go przy użyciu interfejsów API, przepływ pracy będzie już zawierać użytkowników.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, do którego jest dodawany dokument. |
|
Identyfikator dokumentu
|
documentId | True | integer |
Identyfikator dokumentu, dla którego ma zostać podjęta akcja. |
|
porządek
|
order | True | integer |
Kolejność użytkownika w przepływie pracy, dla którego jest dodawane pole. |
|
page_no
|
page_no | True | integer |
Numer strony, na którym ma zostać utworzone pole. |
|
field_name
|
field_name | string |
Nazwa pola, które ma zostać dodane. Jeśli nie zostanie podana, system przypisze unikatową nazwę wygenerowaną automatycznie do pola. |
|
|
x
|
x | True | double |
Lewa lokalizacja pola w pikselach. |
|
y
|
y | True | double |
Górna lokalizacja pola w pikselach. |
|
width
|
width | True | double |
Szerokość pola w pikselach. |
|
height
|
height | True | double |
Wysokość pola w pikselach. |
Zwraca
- Body
- AddFieldResponse
Dodaj pole RadioBox
Aplikacje biznesowe mogą używać tego interfejsu API usługi do dodawania pola wyboru do dokumentu w pakiecie.
Co najmniej jeden użytkownik musi istnieć w przepływie pracy przed dodaniu pól (danych wejściowych i podpisów) do dokumentu w ten sposób. Numer zamówienia odpowiada odbiorcy w przepływie pracy. W związku z tym ta liczba musi być równa lub mniejsza niż całkowita liczba użytkowników w przepływie pracy. Poniższy przykład przypisuje to nowe pole podpisu do pierwszej osoby w przepływie pracy.
Aby uzyskać więcej informacji, zobacz Dodawanie użytkowników do przepływu pracy . Pamiętaj, że jeśli masz dokument z zastosowanym szablonem lub zastosowano go przy użyciu interfejsów API, przepływ pracy będzie już zawierać użytkowników.
Jeśli nie podano parametrów szerokości i wysokości, zostanie przypisany domyślny rozmiar 10x10. Jeśli zostanie podana szerokość lub wysokość (lub obie), system porówna te podane wartości ze sobą. Większa wartość między szerokością a wysokością zostanie przypisana do obu wymiarów.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, do którego jest dodawany dokument. |
|
Identyfikator dokumentu
|
documentId | True | integer |
Identyfikator dokumentu, dla którego ma zostać podjęta akcja. |
|
porządek
|
order | True | integer |
Kolejność użytkownika w przepływie pracy, dla którego jest dodawane pole. |
|
page_no
|
page_no | True | integer |
Numer strony, na którym ma zostać utworzone pole. |
|
field_name
|
field_name | string |
Nazwa podanego pola, które ma zostać dodane. Jeśli nie zostanie podana, system przypisze unikatową nazwę wygenerowaną automatycznie do pola. |
|
|
wartość
|
value | string |
Wartość pola. Możliwe wartości to "true" lub "false" |
|
|
validation_rule
|
validation_rule | True | string |
Co najmniej jedna reguła sprawdzania poprawności możliwych wartości pól to "OBOWIĄZKOWE" lub "OPCJONALNE". |
|
radio_group_name
|
radio_group_name | True | string | |
|
x
|
x | True | double |
Lewa lokalizacja pola w pikselach. |
|
y
|
y | True | double |
Górna lokalizacja pola w pikselach. |
|
width
|
width | True | double |
Szerokość pola w pikselach. |
|
height
|
height | True | double |
Wysokość pola w pikselach. |
Zwraca
- Body
- AddFieldResponse
Dodawanie grup do przepływu pracy
Aplikacje biznesowe mogą używać tego interfejsu API usługi do dodawania grup jako adresata do przepływu pracy. Grupa SigningHub oznacza, że każdy członek grupy może wykonać akcję, tj. podpisać, w imieniu wszystkich członków grupy.
Zanotuj, że grupa zostanie dodana jako ostatni użytkownik/grupa w przepływie pracy. W związku z tym może być wymagana dalsza praca w celu usunięcia bieżącego użytkownika/grupy, która jest już obecna w przepływie pracy. Podczas przygotowywania dokumentów typu XML obsługiwane są tylko typy ról "SIGNER", "REVIEWER" i "CARBON_COPY"
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, dla którego ma zostać dodana grupa. |
|
nazwa_grupy
|
group_name | string |
Nazwa nowej grupy do dodania w przepływie pracy. |
|
|
email_notification
|
email_notification | True | boolean |
Ustawienie jej wartości na wartość "true" powoduje wysłanie powiadomienia e-mail do użytkownika po nadejściu jej zwrotu w przepływie pracy. Ustawienie jej wartości na "false" nie powoduje wysłania powiadomienia e-mail do użytkownika na jego kolei. Jeśli żadna wartość nie zostanie podana, zostanie ustawiona domyślna wartość "true". |
|
rola
|
role | True | string |
Rola adresata w przepływie pracy. Możliwe wartości to "SIGNER", "REVIEWER", "EDITOR", "CARBON_COPY" lub "INPERSON_HOST". Jednak podczas przygotowywania dokumentów typu XML obsługiwane są tylko typy ról "SIGNER", "REVIEWER" i "CARBON_COPY" |
|
signing_order
|
signing_order | integer |
Kolejność, w której przepływ pracy zostanie podpisany przez adresatów. To zamówienie podpisywania jest ważne, gdy typ przepływu pracy jest ustawiony na "CUSTOM". |
Zwraca
- response
- array of CollaboratorGroupResponse
Dodawanie kodu QR
Aplikacje biznesowe mogą używać tego interfejsu API usługi do dodawania kodu QR do dokumentu w pakiecie.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, do którego jest dodawany dokument. |
|
Identyfikator dokumentu
|
documentId | True | integer |
Identyfikator dokumentu, dla którego ma zostać podjęta akcja. |
|
page_no
|
page_no | True | integer |
Numer strony, na którym ma zostać utworzone pole. |
|
field_name
|
field_name | string |
Nazwa podanego pola, które ma zostać dodane. Jeśli nie zostanie podana, system przypisze unikatową nazwę wygenerowaną automatycznie do pola. |
|
|
x
|
x | True | double |
Lewa lokalizacja pola w pikselach. |
|
y
|
y | True | double |
Górna lokalizacja pola w pikselach. |
|
width
|
width | True | double |
Szerokość pola w pikselach. |
|
height
|
height | True | double |
Wysokość pola w pikselach. |
|
dane
|
data | string |
Dane zwykłego tekstu, które mają być zakodowane w kodzie QR. Wartość domyślna to adres URL wygenerowany w celu uzyskania dostępu do powiązanego dokumentu. np. {base_url}/document/{document_unique_id} |
|
|
error_correction_level
|
error_correction_level | True | string |
Poziom korekty błędów dla kodu QR, który określa ilość nadmiarowości danych. Opcje to: L (Niski), M (Średni), Q (Kwartyl) i H (Wysoki). Wyższe poziomy oferują większą odporność na błędy. Wartość domyślna to "Q" |
|
kodowanie
|
encoding | True | string |
Określa tryb kodowania znaków dla zawartości kodu QR. Obsługiwane opcje to: Domyślne, Iso8859_1, Iso8859_2 i Utf8. Wartość domyślna to "Default" (Wartość domyślna) |
|
pixels_per_module
|
pixels_per_module | True | integer |
Określa liczbę pikseli na moduł w kodzie QR. Większa liczba powoduje zwiększenie i bardziej szczegółowy kod QR. Wartość domyślna to "20" Możliwe wartości to: 20 | 30 | 40 | 50 |
|
add_margins
|
add_margins | True | boolean |
Wskazuje, czy strefy ciche (marginesy) powinny być rysowane wokół kodu QR. Strefy ciche pomagają skanerom wykrywać i dekodować kod QR dokładniej. Wartość domyślna to "true" |
|
kropki
|
dots | string |
Reprezentuje ciemny kolor używany dla kropek w kodzie QR. Wartość domyślna to "black". np. "#0000000" |
|
|
tło
|
background | string |
Reprezentuje jasny kolor używany na tle kodu QR. Wartość domyślna to "biały". np. "#ffffff" |
|
|
base64
|
base64 | string |
Opcjonalna ikona (base64) do umieszczenia w środku kodu QR. |
|
|
hide_background_dots
|
hide_background_dots | True | boolean |
Kolor tła za ikoną, jeśli zostanie podana ikona. Jeśli kolor nie jest dostarczany przezroczyste tło jest zaimplementowane. |
|
size
|
size | True | integer |
Rozmiar ikony jako procent rozmiaru kodu QR, jeśli zostanie podana ikona. Wartość domyślna to "15". Możliwe wartości to: 10 | 15 | 20 | 25 | 30 | 35 | 40 |
Zwraca
- Body
- AddQrCodeResponse
Dodawanie lub aktualizowanie dokumentu z biblioteki
Aplikacje biznesowe mogą używać tego interfejsu API usługi do dodawania dokumentu z biblioteki użytkownika do pakietu. Identyfikator pakietu jest podany w adresie URL. Identyfikator dokumentu powinien być również podany jako "document_id" w adresie URL zasobu, aby zidentyfikować dokument biblioteki do skopiowania.
Pamiętaj, że pakiet musi już istnieć, zanim będzie można dodać dokument przy użyciu tego wywołania.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, do którego jest dodawany dokument. |
|
Identyfikator dokumentu
|
documentId | True | integer |
Identyfikator dokumentu biblioteki, który musi zostać dodany/zaktualizowany |
|
Stary identyfikator dokumentu
|
x-document-id | string |
Identyfikator starego dokumentu bieżącego pakietu, który należy zaktualizować |
Zwraca
Dodawanie pola CheckBox
Aplikacje biznesowe mogą używać tego interfejsu API usługi do dodawania pola wyboru do dokumentu w pakiecie.
Co najmniej jeden użytkownik musi istnieć w przepływie pracy przed dodaniu pól (danych wejściowych i podpisów) do dokumentu w ten sposób. Numer zamówienia odpowiada odbiorcy w przepływie pracy. W związku z tym ta liczba musi być równa lub mniejsza niż całkowita liczba użytkowników w przepływie pracy. Poniższy przykład przypisuje to nowe pole podpisu do pierwszej osoby w przepływie pracy.
Aby uzyskać więcej informacji, zobacz Dodawanie użytkowników do przepływu pracy . Pamiętaj, że jeśli masz dokument z zastosowanym szablonem lub zastosowano go przy użyciu interfejsów API, przepływ pracy będzie już zawierać użytkowników.
Jeśli nie podano parametrów szerokości i wysokości, zostanie przypisany domyślny rozmiar 10x10. Jeśli zostanie podana szerokość lub wysokość (lub obie), system porówna te podane wartości ze sobą. Większa wartość między szerokością a wysokością zostanie przypisana do obu wymiarów.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, do którego jest dodawany dokument. |
|
Identyfikator dokumentu
|
documentId | True | integer |
Identyfikator dokumentu, dla którego ma zostać podjęta akcja. |
|
porządek
|
order | True | integer |
Kolejność użytkownika w przepływie pracy, dla którego jest dodawane pole. |
|
page_no
|
page_no | True | integer |
Numer strony, na którym ma zostać utworzone pole. |
|
field_name
|
field_name | string |
Nazwa podanego pola, które ma zostać dodane. Jeśli nie zostanie podana, system przypisze unikatową nazwę wygenerowaną automatycznie do pola. |
|
|
wartość
|
value | string |
Wartość pola. Możliwe wartości to "true" lub "false" |
|
|
x
|
x | True | double |
Lewa lokalizacja pola w pikselach. |
|
y
|
y | True | double |
Górna lokalizacja pola w pikselach. |
|
width
|
width | True | double |
Szerokość pola w pikselach. |
|
height
|
height | True | double |
Wysokość pola w pikselach. |
|
validation_rule
|
validation_rule | string |
Co najmniej jedna reguła sprawdzania poprawności możliwych wartości pól to "OBOWIĄZKOWE" lub "OPCJONALNE". |
Zwraca
- Body
- AddFieldResponse
Dodawanie pola osoby
Aplikacje biznesowe mogą używać tego interfejsu API usługi do dodawania pola podpisu osoby do dokumentu w pakiecie.
Co najmniej jeden użytkownik musi istnieć w przepływie pracy przed dodaniu pól (danych wejściowych i podpisów) do dokumentu w ten sposób. Numer zamówienia odpowiada odbiorcy w przepływie pracy. W związku z tym ta liczba musi być równa lub mniejsza niż całkowita liczba użytkowników w przepływie pracy. Poniższy przykład przypisuje to nowe pole podpisu do pierwszej osoby w przepływie pracy.
Aby uzyskać więcej informacji, zobacz Dodawanie użytkowników do przepływu pracy . Pamiętaj, że jeśli masz dokument z zastosowanym szablonem lub zastosowano go przy użyciu interfejsów API, przepływ pracy będzie już zawierać użytkowników.
Aby hostować spotkanie osobiście, użytkownik usługi SigningHub musi być częścią przepływu pracy. Należy je dodać z rolą "INPERSON_HOST" lub "SIGNER". W przypadku opcji hosta nie wymagają pola podpisu ani danych wejściowych w dokumencie, a pole podpisu osoby może być podpisane przez zarejestrowanego użytkownika bez podpisywania w usłudze.
Należy pamiętać, że jest to specjalny scenariusz przepływu pracy, w którym oczekiwano, że użytkownik i odbiorca usługi SigningHub będą znajdować się w tej samej lokalizacji. Ten typ podpisu nie jest przeznaczony do użycia w przypadku, gdy dokument jest udostępniany adresatom za pośrednictwem linku poczty e-mail w normalnej luźnej metodzie integracji.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, do którego jest dodawany dokument. |
|
Identyfikator dokumentu
|
documentId | True | integer |
Identyfikator dokumentu, dla którego ma zostać podjęta akcja. |
|
porządek
|
order | True | integer |
Kolejność użytkownika w przepływie pracy, dla którego jest dodawane pole. |
|
page_no
|
page_no | True | integer |
Numer strony, na którym ma zostać utworzone pole. |
|
field_name
|
field_name | string |
Nazwa pola, które ma zostać dodane. Jeśli nie zostanie podana, system przypisze unikatową nazwę wygenerowaną automatycznie do pola. |
|
|
symbol zastępczy
|
placeholder | True | string |
Identyfikator ciągu dla pola person, może to być Klient, Jack, CEO itp. |
|
x
|
x | True | double |
Lewa lokalizacja pola w pikselach. |
|
y
|
y | True | double |
Górna lokalizacja pola w pikselach. |
|
width
|
width | True | double |
Szerokość pola w pikselach. |
|
height
|
height | True | double |
Wysokość pola w pikselach. |
|
wyświetlać
|
display | string |
Widoczność pola, które ma zostać dodane, możliwe wartości to "VISIBLE" i "INVISIBLE" |
|
|
level_of_assurance
|
level_of_assurance | array of string |
Poziom zapewniania, który ma zostać zaktualizowany. Możliwe wartości to "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ELECTRONIC_SIGNATURE" |
|
|
enabled
|
enabled | True | boolean |
Prawda, jeśli dla pola jest włączone uwierzytelnianie. W przeciwnym razie fałsz. |
|
enabled
|
enabled | True | boolean |
Prawda, jeśli dla pola jest włączone uwierzytelnianie OTP wiadomości SMS/e-mail. W przeciwnym razie fałsz. |
|
mobile_number
|
mobile_number | string |
Numer telefonu komórkowego adresata, do którego przypisano pole. |
|
|
enabled
|
enabled | True | boolean |
Prawda, jeśli dla pola jest włączone uwierzytelnianie TOTP. W przeciwnym razie fałsz. |
Zwraca
- Body
- AddFieldResponse
Dodawanie pola podpisu cyfrowego
Aplikacje biznesowe mogą używać tego interfejsu API usługi do dodawania pola podpisu cyfrowego do dokumentu w pakiecie.
Co najmniej jeden użytkownik musi istnieć w przepływie pracy przed dodaniu pól (danych wejściowych i podpisów) do dokumentu w ten sposób. Numer zamówienia odpowiada odbiorcy w przepływie pracy. W związku z tym ta liczba musi być równa lub mniejsza niż całkowita liczba użytkowników w przepływie pracy. Poniższy przykład przypisuje to nowe pole podpisu do pierwszej osoby w przepływie pracy.
Aby uzyskać więcej informacji, zobacz Dodawanie użytkowników do przepływu pracy . Pamiętaj, że jeśli masz dokument z zastosowanym szablonem lub zastosowano go przy użyciu interfejsów API, przepływ pracy będzie już zawierać użytkowników.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, dla którego należy zaktualizować szczegóły przepływu pracy. |
|
Identyfikator dokumentu
|
documentId | True | integer |
Identyfikator dokumentu, w którym ma zostać dodane pole. |
|
porządek
|
order | True | integer |
Kolejność adresata, dla którego jest tworzone pole. |
|
page_no
|
page_no | True | integer |
Numer strony, w którym pole ma zostać utworzone. |
|
field_name
|
field_name | string |
Nazwa pola, które ma zostać dodane. Jeśli nie zostanie podana, system przypisze unikatową nazwę wygenerowaną automatycznie do pola. |
|
|
level_of_assurance
|
level_of_assurance | array of string |
Poziom zapewniania, który ma zostać dodany. Możliwe wartości to "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE" |
|
|
x
|
x | True | double |
Lewa lokalizacja pola w pikselach. |
|
y
|
y | True | double |
Górna lokalizacja pola w pikselach. |
|
width
|
width | True | double |
Szerokość pola w pikselach. |
|
height
|
height | True | double |
Wysokość pola w pikselach. |
|
wyświetlać
|
display | string |
Widoczność pola, które ma zostać dodane, możliwe wartości to "VISIBLE" i "INVISIBLE" |
|
|
enabled
|
enabled | True | boolean |
Prawda, jeśli dla pola jest włączone uwierzytelnianie. W przeciwnym razie fałsz. |
|
enabled
|
enabled | True | boolean |
Prawda, jeśli dla pola jest włączone uwierzytelnianie OTP wiadomości SMS/e-mail. W przeciwnym razie fałsz. |
|
mobile_number
|
mobile_number | string |
Numer telefonu komórkowego adresata, do którego przypisano pole. |
|
|
enabled
|
enabled | True | boolean |
Prawda, jeśli dla pola jest włączone uwierzytelnianie TOTP. W przeciwnym razie fałsz. |
Zwraca
Dodawanie pola tekstowego
Aplikacje biznesowe mogą używać tego interfejsu API usługi do dodawania pola wprowadzania tekstu do dokumentu w pakiecie.
Co najmniej jeden użytkownik musi istnieć w przepływie pracy przed dodaniu pól (danych wejściowych i podpisów) do dokumentu w ten sposób. Numer zamówienia odpowiada odbiorcy w przepływie pracy. W związku z tym ta liczba musi być równa lub mniejsza niż całkowita liczba użytkowników w przepływie pracy. Poniższy przykład przypisuje to nowe pole podpisu do pierwszej osoby w przepływie pracy.
Aby uzyskać więcej informacji, zobacz Dodawanie użytkowników do przepływu pracy . Pamiętaj, że jeśli masz dokument z zastosowanym szablonem lub zastosowano go przy użyciu interfejsów API, przepływ pracy będzie już zawierać użytkowników.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, do którego jest dodawany dokument. |
|
Identyfikator dokumentu
|
documentId | True | integer |
Identyfikator dokumentu, dla którego ma zostać podjęta akcja. |
|
porządek
|
order | True | integer |
Kolejność użytkownika w przepływie pracy, dla którego jest dodawane pole. |
|
page_no
|
page_no | True | integer |
Numer strony, na którym ma zostać utworzone pole. |
|
typ
|
type | True | string |
Typ pola, możliwe wartości to "TEXT", "NAME", "EMAIL", "COMPANY", "JOBTITLE", "DATE". Wszystkie pola tekstowe inne niż TEKST są wypełniane automatycznie w trybie oczekiwania z atrybutami/danymi adresata. |
|
wartość
|
value | string |
Wartość pola. Dla parametru type = DATE oczekiwano wartości w formacie ISO 8601. Zgodnie z formatem RRRR-MM-DD hh:mm:ss +00. Ponieważ wartości dotyczą pól daty, aplikacje klienckie mogą wysyłaćMM-DD RRRR- i ignorować hh:mm:ss +00. Jeśli wartość nie jest w odpowiednim formacie, zostanie zwrócony błąd. |
|
|
symbol zastępczy
|
placeholder | string |
Tekst zastępczy pola tekstowego. W przypadku nazwy, poczty e-mail, firmy, stanowiska i daty symbol zastępczy może mieć wartość "NAME", "EMAIL", "COMPANY", "JOBTITLE", "DATE". Deweloperzy mogą wysyłać własne symbole zastępcze, aby zastąpić wartości domyślne. W przypadku "TEXT" deweloperzy mogą udostępniać własne teksty zastępcze. Te symbole zastępcze są wyświetlane w polach tekstowych podczas wyświetlania dokumentu w przeglądarce. |
|
|
max_length
|
max_length | True | integer |
Maksymalna długość wartości dozwolonej w polu. Musi należeć do zakresu od 1 do 9999 |
|
format
|
format | string |
Format tekstowy pola. Używane tylko dla pola typu daty. Możliwe wartości to
|
|
|
field_name
|
field_name | string |
Nazwa pola, które ma zostać dodane. Jeśli nie zostanie podana, system przypisze unikatową nazwę wygenerowaną automatycznie do pola. |
|
|
field_type
|
field_type | True | string |
Typ pola w odniesieniu do akceptowania typu wartości, możliwe wartości to "NUMBER" lub "TEXT". |
|
validation_rule
|
validation_rule | True | string |
Co najmniej jedna reguła sprawdzania poprawności możliwych wartości pól to "OBOWIĄZKOWE" lub "OPCJONALNE". |
|
required
|
required | True | boolean | |
|
typ
|
type | string |
Określa typ reguły sprawdzania poprawności, która jest obecnie zawsze ustawiona na wartość EQUALS dla pola tekstowego. |
|
|
wartość
|
value | string |
Reprezentuje wartość używaną do walidacji. |
|
|
nazwa
|
name | string |
Nazwa czcionki wybranej dla pola tekstowego. Możliwe wartości to "COURIER", "HELVETICA". |
|
|
size
|
size | string |
Rozmiar czcionki wybranej dla pola tekstowego. Możliwe wartości to 8, 10, 12, 14, 16, 18, 20 |
|
|
embedded_size
|
embedded_size | string |
Rozmiar czcionki w oryginalnym dokumencie PDF. |
|
|
x
|
x | True | double |
Lewa lokalizacja pola w pikselach. |
|
y
|
y | True | double |
Górna lokalizacja pola w pikselach. |
|
width
|
width | True | double |
Szerokość pola w pikselach. |
|
height
|
height | True | double |
Wysokość pola w pikselach. |
|
wielowierszowy
|
multiline | True | boolean |
Jeśli zostanie ustawiona wartość true, zostanie utworzone pole obszaru tekstowego |
Zwraca
- Body
- AddFieldResponse
Dodawanie symbolu zastępczego do przepływu pracy
Aplikacje biznesowe mogą używać tego interfejsu API usługi do dodawania symbolu zastępczego do przepływu pracy w pakiecie. Posiadacz zastępczy jest wymagany, jeśli nie znasz tożsamości zamierzonego adresata w przepływie pracy.
Zanotuj, że symbol zastępczy zostanie dodany jako ostatni użytkownik w przepływie pracy. W związku z tym może być wymagana dalsza praca w celu usunięcia bieżącego użytkownika/grupy, która jest już obecna w przepływie pracy.
Dodanie posiadacza zastępczego umożliwia kontynuowanie i dodawanie do dokumentu pól podpisów i/lub danych wejściowych, które następnie można przypisać do poszczególnych użytkowników na późniejszym etapie. Podczas przygotowywania dokumentów typu XML obsługiwane są tylko typy ról "SIGNER", "REVIEWER" i "CARBON_COPY"
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, dla którego ma zostać dodany symbol zastępczy. |
|
symbol zastępczy
|
placeholder | string |
Nazwa nowego symbolu zastępczego, który ma zostać dodany w przepływie pracy. |
|
|
email_notification
|
email_notification | True | boolean |
Ustawienie jej wartości na wartość "true" powoduje wysłanie powiadomienia e-mail do użytkownika po nadejściu jej zwrotu w przepływie pracy. Ustawienie jej wartości na "false" nie powoduje wysłania powiadomienia e-mail do użytkownika na jego kolei. |
|
rola
|
role | True | string |
Rola adresata w przepływie pracy. Możliwe wartości to "SIGNER", "REVIEWER", "EDITOR", "CARBON_COPY" lub "INPERSON_HOST". Jednak podczas przygotowywania dokumentów typu XML obsługiwane są tylko typy ról "SIGNER", "REVIEWER" i "CARBON_COPY" |
|
signing_order
|
signing_order | integer |
Kolejność, w której przepływ pracy zostanie podpisany przez adresatów. To zamówienie podpisywania jest ważne, gdy typ przepływu pracy jest ustawiony na "CUSTOM". |
Zwraca
Dodawanie użytkowników do przepływu pracy
Aplikacje biznesowe mogą używać tego interfejsu API usługi do dodawania adresatów do przepływu pracy. To wywołanie spowoduje dodanie adresata tylko do przepływu pracy. Oznacza to, że żadne pola aktualnie w dokumencie nie będą automatycznie przypisywane do nowych adresatów ani nie będą tworzyć nowych pól.
Zanotuj, że adresaci zostaną dodani jako ostatnia osoba w przepływie pracy. W związku z tym może być wymagana dalsza praca w celu usunięcia bieżących adresatów już obecnych w przepływie pracy.
Co najmniej jeden użytkownik musi istnieć w przepływie pracy, zanim do dokumentu można dodać pola (dane wejściowe i podpis).
Zwróć uwagę, że dane wejściowe akceptują co najmniej jednego użytkownika w jednym wywołaniu.
W tym konkretnym wywołaniu użytkownik jest znaną osobą fizyczną. Jednak te same reguły dotyczą grup i symboli zastępczych. W jednym z tych przypadków odbiorca staje się grupą użytkowników, w której dowolny członek grupy może podpisać dokument lub symbol zastępczy. Ten ostatni przypadek jest używany, gdy nie znasz tożsamości zamierzonego sygnatariusza.
Uwaga Kolejność podpisywania przepływu pracy usługi SigningHub rozpoczyna się od "1". W związku z tym dodanie użytkownika do przepływu pracy bez bieżących adresatów rozpoczyna nową liczbę zamówień podpisywania. Parametr "signing_order" jest obowiązkowy, jeśli typ przepływu pracy to "niestandardowy".
Ważne, użycie tego wywołania interfejsu API może mieć wpływ na typ przepływu pracy. Jeśli w przepływie pracy sekwencyjnym znajdują się bieżąci adresaci, a nowy jest dodawany z tą samą kolejnością podpisywania co bieżący odbiorca, ta część przepływu pracy zmienia się automatycznie z sekwencyjnego na równoległy. W związku z tym ogólny przepływ pracy jest teraz typu niestandardowy, w przeciwieństwie do czysto sekwencyjnych. Dodanie adresata z tym samym zamówieniem podpisywania co dwa lub równoległe adresaty nie zmienia przepływu pracy. W tym konkretnym punkcie przepływu pracy znajduje się tylko trzech lub więcej adresatów; wszystkie w kolejności równoległej.
Pamiętaj, że podczas przygotowywania dokumentów typu XML obsługiwane są tylko typy ról "SIGNER", "REVIEWER" i "CARBON_COPY"
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu SigningHub, do którego mają zostać dodani adresaci. |
|
user_email
|
user_email | string |
Adres e-mail użytkownika, który ma zostać dodany w przepływie pracy. |
|
|
user_name
|
user_name | True | string |
Nazwa adresata, który ma zostać dodany w przepływie pracy. |
|
user_national_id
|
user_national_id | string |
Identyfikator krajowy użytkownika odbiorcy |
|
|
email_notification
|
email_notification | True | boolean |
W przypadku ustawienia wartości true usługa SigningHub będzie wysyłać powiadomienia do użytkownika za pośrednictwem poczty e-mail zgodnie z ustawieniami właściciela dokumentu i powiadomienia użytkownika. Wartość false oznacza, że żadne powiadomienia nie będą wysyłane do użytkownika w całym przepływie pracy. |
|
rola
|
role | True | string |
Rola adresata w przepływie pracy. Możliwe wartości to "SIGNER", "REVIEWER", "EDITOR", "CARBON_COPY" lub "INPERSON_HOST". Jednak podczas przygotowywania dokumentów typu XML obsługiwane są tylko typy ról "SIGNER", "REVIEWER" i "CARBON_COPY" |
|
signing_order
|
signing_order | integer |
Kolejność adresata w przepływie pracy. To zamówienie podpisywania jest obowiązkowe, gdy typ przepływu pracy to "CUSTOM". |
|
|
delivery_method
|
delivery_method | True | string |
Metoda dostarczania odbiorcy w przepływie pracy. Możliwe wartości to "EMAIL", "SMS" lub "EMAIL_AND_SMS". Wartość domyślna to EMAIL |
|
mobile_number
|
mobile_number | string |
Numer telefonu komórkowego |
Zwraca
- response
- array of CollaboratorResponse
Dokument odrzuć strażnika
Aplikacje biznesowe mogą używać tego interfejsu API usługi do odrzucania dokumentu przez określonego użytkownika w podanej kolejności.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, który ma zostać odrzucony. |
|
powód
|
reason | string |
Przyczyna podana przez użytkownika w celu spadku. |
Zwraca
- response
- object
Dokument zatwierdzania strażnika
Aplikacje biznesowe mogą używać tego interfejsu API usługi do zatwierdzania dokumentu przez określonego użytkownika w podanej kolejności.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu do zatwierdzenia. |
|
powód
|
reason | string |
Przyczyna zatwierdzenia pakietu. |
|
|
Hasło dostępu do dokumentu
|
x-password | string |
Hasło ustawione przez właściciela dokumentu na potrzeby uzyskiwania dostępu do dokumentu, jeśli istnieje. Jeśli hasło nie zostało ustawione, wartość będzie równa null. |
|
|
Hasło One-Time dokumentu
|
x-otp | string |
Hasło One-Time (OTP) ustawione przez właściciela dokumentu na potrzeby uzyskiwania dostępu do dokumentu, jeśli istnieje. Jeśli nie ustawiono protokołu OTP, wartość będzie równa null. |
Zwraca
- response
- object
Inicjały wypełnienia
Aplikacje biznesowe mogą używać tego interfejsu API usługi do wypełniania pola inicjałów w dokumencie przez określonego użytkownika w podanej kolejności.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, do którego jest dodawany dokument. |
|
Identyfikator dokumentu
|
documentId | True | integer |
Identyfikator dokumentu. |
|
field_name
|
field_name | True | string |
Unikatowy identyfikator pola w dokumencie. |
|
obraz
|
image | True | string |
Obraz base64 używany do wypełniania inicjałów. |
|
metoda
|
method | integer |
0 = DRAW 1 = TEXT 2 = UPLOAD 3 = SIGNATURE_PAD 4 = NONE |
|
|
apply_to_all
|
apply_to_all | True | boolean |
Wartość True, jeśli wszystkie inicjały mają być wypełnione. |
|
Identyfikator folderu
|
x-folder-id | string |
Określ identyfikator folderu, aby pobrać elementy folderu, gdy jest zaangażowany folder przestrzeni udostępnionej. |
Zwraca
- response
- object
Kończenie przetwarzania
Aplikacje biznesowe mogą używać tego interfejsu API usługi do zakończenia przetwarzania dokumentów po podpisaniu wszystkich pól podpisu. Ta metoda jest używana głównie przez natywne aplikacje mobilne SigningHub dla systemów iOS i Android oraz przypadki użycia mobilnych sieci Web. Ogólne aplikacje biznesowe wykorzystujące ścisłą integrację z odpowiednim portalem nie muszą wywoływać tej metody. Jednak w przypadku korzystania z interfejsu API podpisywania dokumentu (i dlatego użytkownik nie jest wyświetlany z wizualną reprezentacją dokumentu, którego zażądano podpisania), wywołanie tego interfejsu API jest wymagane w celu zapewnienia, że odpowiedni przepływ pracy będzie kontynuowany lub zakończony. Na przykład po zastosowaniu wszystkich podpisów przy użyciu wywołania interfejsu API "ślepego" podpisywania dokumentu dokument nie będzie wyświetlany jako stan "Ukończono" dla właściciela do momentu wywołania tego interfejsu API. Właściciel dokumentu zobaczy stan "W toku" do momentu wywołania tego interfejsu API.
W ramach natywnych aplikacji mobilnych usługi SigningHub i mobilnych przypadków użycia sieci Web to wywołanie jest niezbędne, aby upewnić się, że każdy użytkownik wykonuje odpowiednie działania w odniesieniu do aplikacji SigningHub.Na przykład po podpisaniu dokumentu w aplikacji SigningHub ta metoda jest wywoływana przez aplikację, aby upewnić się, że przepływ pracy będzie nadal przetwarzany, a następny sygnatariusz jest powiadamiany, a stan dokumentu jest dostępny za pośrednictwem skonfigurowanego adresu URL wywołania zwrotnego.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, który ma zostać ukończony. |
|
Identyfikator folderu
|
x-folder-id | string |
Określ identyfikator folderu, aby pobrać elementy folderu, gdy jest zaangażowany folder przestrzeni udostępnionej. |
Zwraca
- response
- object
Odrzuć dokument
Aplikacje biznesowe mogą używać tego interfejsu API usługi do odrzucania dokumentu przez określonego użytkownika w podanej kolejności.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, który ma zostać odrzucony. |
|
powód
|
reason | string |
Przyczyna podana przez użytkownika w celu spadku. |
|
|
Identyfikator folderu
|
x-folder-id | string |
Określ identyfikator folderu, aby pobrać elementy folderu, gdy jest zaangażowany folder przestrzeni udostępnionej. |
Zwraca
- response
- object
Odwołaj dokument
Aplikacje biznesowe mogą używać tego interfejsu API usługi, aby zatrzymać przepływ pracy w toku. Identyfikator dokumentu jest podany w adresie URL zasobu. Po odwołaniu stanu dokumentu automatycznie zmieni się na "WERSJA ROBOCZA".
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, który ma zostać odwołany. |
Zwraca
- response
- object
Pakiety podpisywania zbiorczego
Aplikacje biznesowe mogą używać tego interfejsu API do podpisywania/udostępniania/podpisywania i udostępniania wielu dokumentów (zarówno elektronicznych, jak i cyfrowych) bez wyświetlania dokumentów użytkownikowi końcowemu. Ten interfejs API wymaga informacji z aplikacji biznesowej na temat pakietów dokumentów oraz szczegółów podpisów, pól osobiście i inicjałów. Po pomyślnym zakończeniu transakcji podpisywania zbiorczego interfejs API zwróci stany i identyfikatory transakcji pakietów dokumentów.
W przeciwieństwie do interfejsu API podpisywania dokumentu ten interfejs API nie tylko podpisuje pakiet dokumentu, ale także oznacza go jako zatwierdzony i przeglądany w oparciu o to, czy odbiorca jest użytkownikiem podpisanym, edytorem czy recenzentem. Każdy pakiet dokumentów, dla którego stan jest zwracany jako ukończony, został podpisany, zatwierdzony lub przejrzyszony przez ten interfejs API.
Podpisywanie zbiorcze działa ze wszystkimi metodami uwierzytelniania w czasie podpisywania.
Jeśli funkcja SIGN zostanie przekazana jako bulk_action, a pakiet jest w stanie Wersja robocza, znak i udział zostaną wykonane automatycznie.
Ten interfejs API należy wywołać po interfejsie API dokumentów wstępnego podpisywania zbiorczego .
Jeśli przed podpisaniem musisz wprowadzić zmiany w dowolnym dokumencie, interfejs API pól formularza wypełnienia powinien być wywoływany przed wywołaniem interfejsu API dokumentu podpisywania wstępnego. Pamiętaj, że wszystkie obowiązkowe pola wejściowe w dokumencie wymagają ukończenia przed pomyślnym ukończeniem tego interfejsu API; natomiast pola wypełnione automatycznie (takie jak Nazwa, Adres e-mail, Data, Stanowisko itp.) zostaną wypełnione automatycznie.
Sygnatariusz jest identyfikowany przez token dostępu przedstawiony w wywołaniu. W związku z tym uwierzytelnianie sygnatariusza jest wymagane przed wykonaniem tego wezwania. Nie można uwierzytelnić się jako administrator przedsiębiorstwa za pomocą zmiennej zakresu i podpisać dokument w imieniu użytkownika. Token dostępu musi zostać wystawiony sygnatariuszowi w wyniku uwierzytelniania bezpośredniego.
Po podpisaniu dokumentu można zobaczyć odpowiedź weryfikacyjną z interfejsu API stanu podpisywania zbiorczego .
Pierwsze lub drugie użycie protokołu OTP na potrzeby uwierzytelniania
W przypadku włączenia uwierzytelniania OTP dla operacji podpisywania po stronie serwera aplikacje klienckie będą musiały wygenerować protokół OTP dla numeru telefonu komórkowego przy użyciu uwierzytelniania podpisywania zbiorczego za pośrednictwem wywołania interfejsu API OTP. Odpowiednie aplikacje biznesowe muszą pobrać protokół OTP z użycia i przesłać go podczas wykonywania wywołania interfejsu API. Odbywa się to przy użyciu nagłówka "x-otp" w żądaniu.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Numery identyfikacyjne
|
ids | array of integer |
Tablica identyfikatorów pakietów dokumentów wybranych do podpisywania zbiorczego. |
|
|
hand_signature_initials_image
|
hand_signature_initials_image | string |
Obraz base64 używany do wypełniania inicjałów |
|
|
hand_signature_initials_method
|
hand_signature_initials_method | integer |
0 = DRAW 1 = TEXT 2 = UPLOAD 3 = SIGNATURE_PAD 4 = NONE |
|
|
hand_signature_image
|
hand_signature_image | string |
Obraz ciągów zakodowany w formacie Base64 przedstawiający widoczny wygląd podpisu |
|
|
hand_signature_method
|
hand_signature_method | integer |
0 = DRAW 1 = TEXT 2 = UPLOAD 3 = SIGNATURE_PAD 4 = NONE |
|
|
signing_reason
|
signing_reason | string |
Przyczyna podpisania dostarczona przez odbiorcę. |
|
|
signing_location
|
signing_location | string |
Ustawienia regionalne osoby podpisanej dostarczonej przez adresata |
|
|
contact_information
|
contact_information | string |
Informacje kontaktowe osoby podpisanej dostarczonej przez adresata |
|
|
appearance_design
|
appearance_design | string |
Nazwa wyglądu podpisu dostarczonego przez użytkownika do podpisywania. Jeśli nie podano nazwy wyglądu, zostanie użyty domyślny wybrany wygląd. Możliwe wartości to "COMPANY_LOGO", "DETAILED_SIGNATURE", "HAND_SIGNATURE" |
|
|
signing_server
|
signing_server | string |
Nazwa serwera podpisywania, przy użyciu którego dokument ma zostać podpisany |
|
|
signing_capacity
|
signing_capacity | string |
Nazwa profilu certyfikacji/pojemności podpisywania, przy użyciu której dokument ma zostać podpisany |
|
|
mechanism
|
mechanism | string |
Mechanizm uwierzytelniania. Możliwe wartości mechanizmu to: AUTHENTICATION_PASSWORD, AUTHENTICATION_ACTIVE_DIRECTORY, AUTHENTICATION_AZURE_ACTIVE_DIRECTORY, AUTHENTICATION_OFFICE_365, AUTHENTICATION_OAUTH2, AUTHENTICATION_OIDC |
|
|
hasło
|
password | string |
Jest to opcjonalny parametr, ale jest wymagany tylko w przypadku używania wartości "AUTHENTICATION_PASSWORD" jako wartości parametru w obszarze "mechanizm" |
|
|
kod przedpłaty
|
token | string |
Jest to opcjonalny parametr, który zostanie odebrany z serwera innej firmy, ale jest wymagany tylko w przypadku używania "AUTHENTICATION_AZURE_ACTIVE_DIRECTORY", "AUTHENTICATION_OFFICE_365", "AUTHENTICATION_OAUTH2" "AUTHENTICATION_OIDC" "AUTHENTICATION_GOOGLE" "AUTHENTICATION_LINKED_IN" "AUTHENTICATION_SALES_FORCE" jako wartości parametru w obszarze "mechanizm" |
|
|
user_identifier
|
user_identifier | string |
Jest to opcjonalny parametr, ale jest wymagany tylko w przypadku używania wartości "AUTHENTICATION_ACTIVE_DIRECTORY" lub "AUTHENTICATION_SAML" jako wartości parametru w obszarze "mechanizm" |
|
|
identyfikator
|
id | string |
Jest to opcjonalny parametr, ale jest wymagany tylko w przypadku używania wartości "AUTHENTICATION_SALES_FORCE" lub "AUTHENTICATION_IDFY" jako wartości parametru w obszarze "mechanizm". W przypadku elementu "AUTHENTICATION_IDFY" jest to identyfikator requestId |
|
|
code_verifier
|
code_verifier | string |
Weryfikator kodu, jeśli dla klienta jest włączona funkcja PKCE. |
|
|
identyfikator jednorazowy
|
nonce | string |
Wartość niezwiązana, jeśli jest włączona dla klienta. |
|
|
identyfikator_transakcji
|
transaction_id | string |
Identyfikator transakcji ponownego zainicjowania procesu podpisywania |
|
|
Identyfikator pakietu
|
packageId_bulkAction | True | string |
Akcja zbiorcza do wykonania. Możliwe wartości to: SIGN | UDOSTĘPNIJ |
|
Podpisywanie protokołu OTP
|
x-otp | string |
Protokół OTP/TOTP używany jako drugi czynnik/uwierzytelnianie podpisywania dokumentu dla operacji podpisywania. |
|
|
Hasło dostępu do dokumentu
|
x-open-password | string |
Hasło ustawione przez właściciela dokumentu na potrzeby uzyskiwania dostępu do dokumentu, jeśli istnieje. Jeśli hasło nie zostało ustawione, wartość będzie równa null. |
|
|
Hasło One-Time dokumentu
|
x-open-otp | string |
Hasło One-Time (OTP) ustawione przez właściciela dokumentu na potrzeby uzyskiwania dostępu do dokumentu, jeśli istnieje. Jeśli nie ustawiono protokołu OTP, wartość będzie równa null. |
|
|
Identyfikator folderu
|
x-folder-id | string |
Określ identyfikator folderu, aby pobrać elementy folderu, gdy jest zaangażowany folder przestrzeni udostępnionej. |
|
|
Twórca urządzeń przenośnych
|
x-mobile | string |
Definiowanie inicjatora (Sieci Web/Mobile) żądania/akcji |
Zwraca
- Body
- BulkSignResponse
Pobieranie pakietów
Aplikacje biznesowe mogą używać tego interfejsu API usługi, aby uzyskać listę dokumentów filtrowanych według różnych stanów. Użytkownicy mogą podzielić rekordy na strony, podając liczbę rekordów na stronę.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Stan dokumentu
|
document_status | True | string |
Filtruj według możliwych wartości stanu dokumentu to ALL, DRAFT, PENDING, SIGNED, DECLINED, INPROGRESS, EDITED, REVIEWED, COMPLETED, EXPIRING_IN_SEVEN_DAYS. |
|
Numer strony
|
pageNo | True | integer |
Numer strony, zgodnie z podziałem rekordów na stronę. |
|
Liczba rekordów na stronie
|
recordPerPage | True | integer |
Liczba rekordów potrzebnych do pobrania w jednym żądaniu. |
|
Nazwa pakietu
|
package-name | string |
Nazwa pakietu |
|
|
Identyfikator pakietu
|
package-id | integer |
Identyfikator pakietu |
|
|
Źródło
|
recipient-from | string |
Źródło |
|
|
Do
|
recipient-to | string |
Do |
|
|
Identyfikator dokumentu
|
document-id | integer |
Identyfikator dokumentu |
|
|
Wygaśnięcie (dni)
|
expiry | integer |
Wygaśnięcie (dni) |
|
|
Data modyfikacji
|
modified-from | date-time |
Data modyfikacji |
|
|
Data modyfikacji
|
modified-to | date-time |
Data modyfikacji |
|
|
Od rozmiaru (KB)
|
size-from | integer |
Od rozmiaru (KB) |
|
|
Do rozmiaru (KB)
|
size-to | integer |
Do rozmiaru (KB) |
|
|
Certyfikowane dokumenty
|
certified-documents | boolean |
Tylko certyfikowane podpisane dokumenty |
|
|
Pola formularza
|
form-fields | boolean |
Tylko dokumenty, które mają pola formularza |
|
|
Załączniki
|
attachments | boolean |
Tylko dokumenty, które mają załączniki |
|
|
Typ dokumentu
|
document-type | string |
Typ dokumentu, taki jak XML, PDF, DOCX itp. |
|
|
Sortuj wg
|
sort-by | string |
Sortuj wynikowe rekordy zgodnie z wybranym wyborem |
|
|
Kolejność rosnąca
|
asc | boolean |
Posortowane wynikowe rekordy według kolejności rosnącej lub malejącej |
|
|
Stany dokumentu
|
document-statuses | array |
Typ dokumentu |
|
|
Własnością
|
owned-by | string |
Możliwe wartości należą do filtru są ME_OTHERS, ME, INNE. |
|
|
Nazwa formularza inteligentnego
|
smart-form | string |
Nazwa formularza inteligentnego |
|
|
Nazwa folderu
|
x-folder | string |
Nazwa folderu, z którego mają być pobierane dokumenty. Możliwe wartości to INBOX i ARCHIVE. |
|
|
Tekst wyszukiwania
|
x-search-text | string |
Tekst wyszukiwania wysyłany w nagłówkach w celu dalszej filtrowania dokumentów. Można wyszukać identyfikator pakietu, nazwę i właściciela dokumentu. |
|
|
Łączna liczba rekordów
|
x-total-records | string |
Łączna liczba rekordów znalezionych przy użyciu podanych kryteriów wyszukiwania. |
|
|
Source
|
x-source | string |
Jest to identyfikacja źródła dokumentu, z którego dokument jest przekazywany, np. "Moja aplikacja". |
|
|
Szczegóły adresata
|
x-recipient-details | string |
Jeśli "true" zostanie przekazana szczegóły adresata dotyczące czasu trwania dostępu do dokumentu, zostaną podane wraz z informacjami o odrzuceniu |
Zwraca
- response
- array of GetPackagesResponse
Pobieranie przypomnienia o przepływie pracy
Aplikacje biznesowe mogą używać tego interfejsu API usługi do aktualizowania przypomnień dla adresatów, którzy zostali już dodani do przepływu pracy. Zwykle to wywołanie jest przydatne po zastosowaniu szablonu do dokumentu, a aplikacje biznesowe chcą zastąpić ustawienia przypomnień w przepływie pracy. Identyfikator dokumentu przepływu pracy jest podany w adresie URL zasobu, a odbiorca przepływu pracy jest identyfikowany przez kolejność, w której jest dodawany do przepływu pracy.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, dla którego mają zostać zaktualizowane przypomnienia dotyczące przepływu pracy. |
|
Zamówienie
|
order | True | integer |
Kolejność użytkownika, dla którego przypomnienia dotyczące przepływu pracy mają być aktualizowane. |
Zwraca
- Body
- ReminderResponse
Pobieranie pól dokumentu
Aplikacje biznesowe mogą używać tego interfejsu API usługi do pobierania pól dokumentów, np. inicjałów, osób, pól podpisu lub pól formularza.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, do którego jest dodawany dokument. |
|
Identyfikator dokumentu
|
documentId | True | integer |
Identyfikator dokumentu, dla którego są żądane pola. |
|
Brak strony
|
pageNo | True | integer |
Strona nie dokumentu, dla którego są żądane pola. Jeśli numer strony nie zostanie podany, zwracane są pola całego dokumentu. |
|
Pomysłodawca
|
x-mobile | string |
Definiowanie inicjatora (Sieci Web/Mobile) żądania/akcji |
Zwraca
- Body
- FieldsResponse
Pobieranie szablonów
Aplikacje biznesowe mogą używać tego interfejsu API usługi, aby uzyskać listę szablonów dla bieżącego użytkownika.
Można wyszukiwać na podstawie kryterium podanego w nagłówku "x-search-text". Ponadto można przeszukiwać szablony osobiste użytkownika lub szablony przedsiębiorstwa zgodnie z ich rolą użytkownika przez administratora przedsiębiorstwa.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Liczba rekordów na stronę
|
recordPerPage | True | integer |
Łączna liczba rekordów do pobrania na stronie. |
|
Numer strony do pobrania
|
pageNo | True | integer |
Numer strony do pobrania. |
|
Sortuj według kolumny
|
sort-by | string |
Sortuj według kolumny. Możliwe wartości to CREATED_ON i NAME. Wartość domyślna to sortowanie według CREATED_ON |
|
|
Asc
|
asc | boolean |
Wynikowa kolejność listy. Domyślna wynikowa lista będzie maleć |
|
|
Tekst wyszukiwania
|
x-search-text | string |
Wyszukaj tekst, jeśli jest to wymagane. Jest to opcjonalne i bez niego zwracana jest cała lista. |
|
|
Tylko szablony przedsiębiorstwa
|
x-enterprise | string |
Po ustawieniu wartości "true" zostanie zwrócona tylko lista szablonów przedsiębiorstwa. W przypadku wartości "false" zostanie zwrócona tylko lista szablonów użytkownika. Jeśli nie ustawisz nagłówka, zostaną zwrócone listy szablonów przedsiębiorstwa i użytkownika. |
|
|
Łączna liczba rekordów
|
x-total-records | string |
Łączna liczba rekordów znalezionych przy użyciu podanych kryteriów wyszukiwania. |
Zwraca
- response
- array of TemplateResponse
Pobieranie szablonów przedsiębiorstwa
Aplikacje biznesowe mogą używać tego interfejsu API usługi, aby uzyskać listę szablonów przedsiębiorstwa bieżącego użytkownika. Oznacza to, że administrator przedsiębiorstwa lub użytkownik przedsiębiorstwa, jeśli zmienna "scope" została użyta w żądaniu uwierzytelniania.
Można wyszukiwać na podstawie kryterium podanego w nagłówku "x-search-text".
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Liczba rekordów na stronę
|
recordPerPage | True | integer |
Łączna liczba rekordów do pobrania na stronie. |
|
Numer strony do pobrania
|
pageNo | True | integer |
Numer strony do pobrania. |
|
Sortuj według kolumny
|
sort-by | string |
Posortuj wynik według możliwych wartości wymienionych powyżej. |
|
|
Zamawianie zestawu wyników
|
asc | boolean |
Porządkowanie zestawu wyników przez rosnąco lub malejąco. |
|
|
Filtruj według identyfikatorów szablonu
|
id | array |
Wyszukaj według identyfikatorów szablonu. |
|
|
Tekst wyszukiwania
|
x-search-text | string |
Wyszukaj tekst, jeśli jest to wymagane. Jest to opcjonalne i bez niego zwracana jest cała lista. |
|
|
Łączna liczba rekordów
|
x-total-records | string |
Łączna liczba rekordów znalezionych przy użyciu podanych kryteriów wyszukiwania. |
Zwraca
- response
- array of EnterpriseTemplateResponse
Pobieranie szczegółów dokumentu
Aplikacje biznesowe mogą używać tego interfejsu API usługi, aby uzyskać szczegółowe informacje o dokumencie. Identyfikator dokumentu jest podany w adresie URL jako "{document_id}".
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, do którego jest dodawany dokument. |
|
Identyfikator dokumentu
|
documentId | True | integer |
Identyfikator dokumentu, dla którego są wymagane szczegóły dokumentu. |
|
Hasło dokumentu
|
x-password | string |
Hasło ustawione przez właściciela dokumentu na potrzeby uzyskiwania dostępu do dokumentu, jeśli istnieje. Jeśli hasło nie zostało ustawione, wartość będzie równa null. |
|
|
hasło One-Time (OTP)
|
x-otp | string |
Hasło One-Time (OTP) ustawione przez właściciela dokumentu na potrzeby uzyskiwania dostępu do dokumentu, jeśli istnieje. Jeśli nie ustawiono protokołu OTP, wartość będzie równa null. |
|
|
Identyfikator folderu
|
x-folder-id | string |
Określ identyfikator folderu, aby pobrać elementy folderu, gdy jest zaangażowany folder przestrzeni udostępnionej. |
Zwraca
Pobieranie szczegółów pakietu
Aplikacje biznesowe mogą używać tego interfejsu API usługi, aby uzyskać szczegółowe informacje o pakiecie. Ten interfejs API może być również używany przez aplikację biznesową do wykonywania akcji w imieniu użytkownika przedsiębiorstwa za pośrednictwem pozycji "Uwierzytelnianie zakresu".
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu dokumentu. |
Zwraca
Pobieranie szczegółów przepływu pracy
Aplikacje biznesowe mogą używać tego interfejsu API usługi do uzyskiwania szczegółów przepływu pracy dla pakietu.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu do pobrania. |
|
Identyfikator folderu
|
x-folder-id | string |
Określ identyfikator folderu, aby pobrać elementy folderu, gdy jest zaangażowany folder przestrzeni udostępnionej. |
Zwraca
Pobieranie uwierzytelniania użytkownika przepływu pracy (otwieranie dokumentu) pakietu Enterprise
Aplikacje biznesowe mogą używać tego interfejsu API usługi, aby uzyskać ustawienia zabezpieczeń dostępu włączone dla pakietu. Adresaci, dla których skonfigurowano zabezpieczenia, są identyfikowani przez kolejność w adresie URL. Identyfikator pakietu jest również identyfikowany w adresie URL żądania. Adresaci nie będą mogli uzyskać dostępu do pakietu dokumentów poza zakresem tego czasu trwania, jeśli włączono zabezpieczenia dostępu. Właściciel dokumentu może również skonfigurować zabezpieczenia pakietu na podstawie uwierzytelniania dla adresata.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, dla którego należy zaktualizować zabezpieczenia i uwierzytelnianie dostępu do przepływu pracy. |
|
Kolejność adresatów
|
order | True | integer |
Kolejność adresata w przepływie pracy, dla którego ma zostać zaktualizowane zabezpieczenia dostępu i uwierzytelnianie. |
Zwraca
Pobieranie użytkowników przepływu pracy
Aplikacje biznesowe mogą używać tego interfejsu API usługi do uzyskiwania szczegółów przepływu pracy dla pakietu.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu do pobrania. |
|
Identyfikator folderu
|
x-folder-id | string |
Określ identyfikator folderu, aby pobrać elementy folderu, gdy jest zaangażowany folder przestrzeni udostępnionej. |
Zwraca
- response
- array of WorkflowRecipient
Pobieranie załączników
Aplikacje biznesowe mogą używać tego interfejsu API usługi do pobierania załączników dokumentu.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, do którego jest dodawany dokument. |
|
Identyfikator dokumentu
|
documentId | True | integer |
Identyfikator dokumentu, do którego jest dodawany załącznik. |
|
Identyfikator folderu
|
x-folder-id | string |
Określ identyfikator folderu, aby pobrać elementy folderu, gdy jest zaangażowany folder przestrzeni udostępnionej. |
Zwraca
- response
- array of GetAttachmentResponse
Pobierz dokument
Aplikacje biznesowe mogą używać tego interfejsu API usługi do pobierania bajtów dokumentów. Identyfikator pakietu i identyfikator dokumentu są podane w adresie URL zasobu.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, do którego jest dodawany dokument. |
|
Identyfikator dokumentu
|
documentId | True | integer |
Identyfikator dokumentu do pobrania. |
|
Hasło dokumentu
|
x-password | string |
Hasło ustawione przez właściciela dokumentu na potrzeby uzyskiwania dostępu do dokumentu, jeśli istnieje. Jeśli hasło nie zostało ustawione, wartość będzie równa null. |
|
|
hasło One-Time (OTP)
|
x-otp | string |
Hasło One-Time (OTP) ustawione przez właściciela dokumentu na potrzeby uzyskiwania dostępu do dokumentu, jeśli istnieje. Jeśli nie ustawiono protokołu OTP, wartość będzie równa null. |
|
|
Identyfikator folderu
|
x-folder-id | string |
Określ identyfikator folderu, aby pobrać elementy folderu, gdy jest zaangażowany folder przestrzeni udostępnionej. |
Zwraca
- response
- object
Pobierz pakiet
Aplikacje biznesowe mogą używać tego interfejsu API usługi do pobierania pakietu dokumentów w formacie binarnym.
Identyfikator pakietu jest podany w adresie URL zasobu.
Jeśli pakiet zawiera tylko jeden dokument, pobieranie to binarny dokument PDF.
Alternatywnie, jeśli pakiet zawiera więcej niż jeden dokument, pobieranie jest plikiem zip binarnym wszystkich dokumentów.
Nagłówki x-password i x-otp są opcjonalne. Są one wymagane, jeśli właściciel dokumentu ustawił je podczas fazy tworzenia przepływu pracy.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId_bulkAction | True | integer |
Identyfikator pakietu do pobrania. |
|
Identyfikatory dokumentów
|
document-ids | array |
Parametr Identyfikatory dokumentów jest opcjonalny. Jeśli wartość x-combine-files ma wartość true, dokumenty zostaną scalone na podstawie wymienionych dokumentów pakietu. |
|
|
Hasło dostępu do dokumentu
|
x-password | string |
Hasło ustawione przez właściciela dokumentu na potrzeby uzyskiwania dostępu do dokumentu, jeśli istnieje. Jeśli hasło nie zostało ustawione, wartość będzie równa null. |
|
|
Hasło One-Time dokumentu
|
x-otp | string |
Hasło One-Time (OTP) ustawione przez właściciela dokumentu na potrzeby uzyskiwania dostępu do dokumentu, jeśli istnieje. Jeśli nie ustawiono protokołu OTP, wartość będzie równa null. |
|
|
Łączenie plików
|
x-combine-files | string |
Wartość domyślna to false, ustaw wartość "true", aby połączyć cały pakiet dokumentu w jeden plik PDF. |
|
|
Identyfikator folderu
|
x-folder-id | string |
Określ identyfikator folderu, aby pobrać elementy folderu, gdy jest zaangażowany folder przestrzeni udostępnionej. |
Zwraca
- response
- object
Pobierz załącznik
Aplikacje biznesowe mogą używać tego interfejsu API usługi do pobierania załącznika dokumentu.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, do którego jest dodawany dokument. |
|
Identyfikator dokumentu
|
documentId | True | integer |
Identyfikator dokumentu, do którego jest dodawany załącznik. |
|
Identyfikator załącznika
|
attachment_id | True | integer |
Identyfikator załącznika. |
|
Identyfikator folderu
|
x-folder-id | string |
Określ identyfikator folderu, aby pobrać elementy folderu, gdy jest zaangażowany folder przestrzeni udostępnionej. |
Zwraca
- response
- object
Podpisywanie dokumentu
Aplikacje biznesowe mogą używać tego interfejsu API usługi do podpisywania dokumentu (zarówno elektronicznego, jak i cyfrowego) bez wyświetlania dokumentu użytkownikowi końcowemu przy użyciu usługi SigningHub. Na przykład aplikacja biznesowa może mieć inną metodę wyświetlania dokumentu użytkownikowi, a wymagana jest tylko funkcja podpisywania usługi SigningHub lub w przypadku operacji zbiorczych może być uzasadnione podpisanie bez konieczności wyświetlania i zatwierdzania poszczególnych dokumentów przez użytkownika. Jeśli przed podpisaniem dokumentu zostaną zapisane zmiany, należy wywołać interfejs API pól formularza wypełnienia przed wywołaniem interfejsu API podpisywania dokumentu. Pamiętaj, że wszystkie obowiązkowe pola wejściowe w dokumencie wymagają ukończenia przed pomyślnym ukończeniem tego interfejsu API.
Sygnatariusz jest identyfikowany przez token dostępu przedstawiony w wywołaniu. W związku z tym uwierzytelnianie sygnatariusza jest wymagane przed wykonaniem tego wezwania. Nie można uwierzytelnić się jako administrator przedsiębiorstwa za pomocą zmiennej zakresu i podpisać dokument w imieniu użytkownika. Token dostępu musi zostać wystawiony sygnatariuszowi w wyniku uwierzytelniania bezpośredniego.
Po zakończeniu tego wywołania ważne jest, aby wywołanie wywołania interfejsu API zakończ dokument był ostatnim sygnatariuszem dokumentu. Przyczyną jest to, że bez wywoływania tego interfejsu API dokument pozostanie w stanie "W toku" właścicielowi dokumentu. Po wywołaniu interfejsu API stan zmieni się na "Ukończono" dla właściciela dokumentu.
Po podpisaniu dokumentu można zobaczyć odpowiedź weryfikacyjną z interfejsu API uzyskiwania weryfikacji dokumentu .
Pierwsze lub drugie użycie protokołu OTP na potrzeby uwierzytelniania
Jeśli uwierzytelnianie OTP jest włączone dla operacji podpisywania po stronie serwera, aplikacje klienckie będą musiały wygenerować OTP dla numeru telefonu komórkowego przy użyciu uwierzytelniania osoby podpisującego za pośrednictwem wywołania interfejsu API OTP. Odpowiednie aplikacje biznesowe muszą pobrać protokół OTP z użycia i przesłać go podczas wykonywania wywołania interfejsu API. Odbywa się to przy użyciu nagłówka "x-otp" w żądaniu.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu zawierającego dokument do podpisu. |
|
Identyfikator dokumentu
|
documentId | True | integer |
Identyfikator dokumentu do podpisania. |
|
field_name
|
field_name | True | string |
Unikatowy identyfikator pola podpisu w dokumencie. |
|
hand_signature_image
|
hand_signature_image | string |
Obraz ciągu zakodowanego w formacie Base64 przedstawiający widoczny wygląd podpisu, który jest umieszczany w dokumencie. Należy pamiętać, że można je pobrać z ustawień osobistych użytkownika przy użyciu tego wywołania. (Odpowiedź jest binarna, więc aplikacja biznesowa musi ją zakodować przed przesłaniem w tym wywołaniu interfejsu API). |
|
|
hand_signature_method
|
hand_signature_method | integer |
0 = DRAW 1 = TEXT 2 = UPLOAD 3 = SIGNATURE_PAD 4 = NONE |
|
|
signing_reason
|
signing_reason | string |
Przyczyna podpisania dostarczona przez odbiorcę. Uwaga: wskazanie typu zobowiązania dla dokumentów XML |
|
|
signing_location
|
signing_location | string |
Ustawienia regionalne osoby podpisanej dostarczonej przez adresata. |
|
|
contact_information
|
contact_information | string |
Informacje kontaktowe osoby podpisającego dostarczone przez odbiorcę. |
|
|
user_name
|
user_name | string |
Nazwa osoby podpisanej dostarczonej przez adresata. Należy pamiętać, że dotyczy to tylko operacji podpisywania osób. |
|
|
user_password
|
user_password | string |
Hasło udostępniane przez użytkownika pod warunkiem ustawienia podpisu użytkownika. |
|
|
appearance_design
|
appearance_design | string |
Nazwa wyglądu podpisu dostarczonego przez użytkownika do podpisywania. Jeśli nie podano nazwy wyglądu, zostanie użyty domyślny wybrany wygląd. Możliwe wartości to "COMPANY_LOGO", "DETAILED_SIGNATURE","HAND_SIGNATURE" |
|
|
signing_capacity
|
signing_capacity | string |
Nazwa pojemności profilu certyfikacji/podpisywania, przy użyciu której dokument ma zostać podpisany. Jeśli nie zostanie podana domyślna pojemność, zostanie użyta do podpisania. Podana nazwa musi być dokładnie taka sama jak rzeczywisty profil ze względu na ważność wielkości liter. |
|
|
skip_verification
|
skip_verification | True | boolean |
Nie jest zwracana weryfikacja podpisu w treści odpowiedzi, gdy jest ustawiona na wartość true. Wartość domyślna tego parametru ustawiona na wartość false. |
|
signing_server
|
signing_server | string |
Nazwa serwera podpisywania, przy użyciu którego dokument ma zostać podpisany. |
|
|
mechanism
|
mechanism | string |
Mechanizm uwierzytelniania. Możliwe wartości mechanizmu to: AUTHENTICATION_PASSWORD, AUTHENTICATION_ACTIVE_DIRECTORY, AUTHENTICATION_AZURE_ACTIVE_DIRECTORY, AUTHENTICATION_OFFICE_365, AUTHENTICATION_OAUTH2, AUTHENTICATION_OIDC |
|
|
hasło
|
password | string |
Jest to opcjonalny parametr, ale jest wymagany tylko w przypadku używania wartości "AUTHENTICATION_PASSWORD" jako wartości parametru w obszarze "mechanizm" |
|
|
kod przedpłaty
|
token | string |
Jest to opcjonalny parametr, który zostanie odebrany z serwera innej firmy, ale jest wymagany tylko w przypadku używania "AUTHENTICATION_AZURE_ACTIVE_DIRECTORY", "AUTHENTICATION_OFFICE_365", "AUTHENTICATION_OAUTH2" "AUTHENTICATION_OIDC" "AUTHENTICATION_GOOGLE" "AUTHENTICATION_LINKED_IN" "AUTHENTICATION_SALES_FORCE" jako wartości parametru w obszarze "mechanizm" |
|
|
user_identifier
|
user_identifier | string |
Jest to opcjonalny parametr, ale jest wymagany tylko w przypadku używania wartości "AUTHENTICATION_ACTIVE_DIRECTORY" lub "AUTHENTICATION_SAML" jako wartości parametru w obszarze "mechanizm" |
|
|
identyfikator
|
id | string |
Jest to opcjonalny parametr, ale jest wymagany tylko w przypadku używania wartości "AUTHENTICATION_SALES_FORCE" lub "AUTHENTICATION_IDFY" jako wartości parametru w obszarze "mechanizm". W przypadku elementu "AUTHENTICATION_IDFY" jest to identyfikator requestId |
|
|
code_verifier
|
code_verifier | string |
Weryfikator kodu, jeśli dla klienta jest włączona funkcja PKCE. |
|
|
identyfikator jednorazowy
|
nonce | string |
Wartość niezwiązana, jeśli jest włączona dla klienta. |
|
|
hasło One-Time (OTP)
|
x-otp | string |
OTP używane jako drugie uwierzytelnianie czynnikowe dla operacji podpisywania. |
|
|
Identyfikator folderu
|
x-folder-id | string |
Określ identyfikator folderu, aby pobrać elementy folderu, gdy jest zaangażowany folder przestrzeni udostępnionej. |
|
|
Twórca urządzeń przenośnych
|
x-mobile | string |
Definiowanie inicjatora (Sieci Web/Mobile) żądania/akcji |
Zwraca
- Body
- SignDocumentResponse
Pola automiejsowe
Aplikacje biznesowe mogą wywoływać ten interfejs API, aby dodać pola formularza zdefiniowane przez podpis lub użytkownika do dokumentu na podstawie podanego kryterium wyszukiwania. Opcje umieszczania to: po lewej stronie, po prawej stronie, u góry i u dołu. Dokument jest wyszukiwany, a wszystkie wystąpienia spełnianych kryteriów wyszukiwania są przetwarzane. Dzięki temu można dodać wiele pól z jednym wywołaniem. Na przykład przekaż dokument i automatycznie umieść pole podpisu po prawej stronie wszystkich wystąpień słowa "Podpisz tutaj:". Pozwala to zaoszczędzić czas i zagwarantować, że żadne podpisy nie zostaną pominięte w przepływie pracy.
Wywołanie interfejsu API obsługuje wszystkie typy pól; a mianowicie elektroniczne, cyfrowe, osobiście, inicjały i pole tekstowe itp.
Ponadto wywołanie interfejsu API obsługuje zmienną "order". Oznacza to, że można automatycznie przypisać zestaw pól podpisu do pojedynczego użytkownika. W związku z tym wywołanie można powtórzyć, aby umieścić pola podpisu i przypisać je do więcej niż jednego użytkownika w przepływie pracy.
Co najmniej jeden użytkownik musi istnieć w przepływie pracy, aby można było w ten sposób dodać pola podpisu do dokumentu. Numer zamówienia odpowiada odbiorcy w przepływie pracy. W związku z tym ta liczba musi być równa lub mniejsza niż całkowita liczba użytkowników w przepływie pracy. Poniższy przykład przypisuje to nowe pole podpisu do pierwszej osoby w przepływie pracy.
To wywołanie interfejsu API może być używane wiele razy w tym samym dokumencie. Powodem tego jest zaspokojenie wielu sygnatariuszy dokumentu. Odbiorca lub sygnatariusz jest identyfikowany przez zmienną "order" przekazaną w wywołaniu.
Aby uzyskać więcej informacji, zobacz Dodawanie użytkowników do przepływu pracy . Pamiętaj, że jeśli masz dokument z zastosowanym szablonem lub zastosowano go przy użyciu interfejsów API, przepływ pracy będzie już zawierać użytkowników.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, do którego jest dodawany dokument. |
|
Identyfikator dokumentu
|
documentId | True | integer |
Identyfikator dokumentu, dla którego są żądane pola. |
|
search_text
|
search_text | string |
Word, które należy wyszukać w dokumencie. |
|
|
porządek
|
order | True | integer |
Kolejność użytkownika, do którego pola zostaną przypisane automatycznie. Przepływ pracy w odbiorcach zamówień w usłudze SigningHub. Ta lista zaczyna się od "1" dla pierwszego wyznaczonego sygnatariusza. |
|
Umieszczenie
|
placement | string |
Jeśli tekst zostanie znaleziony, pola mają zostać umieszczone w dokumencie. Umieszczenie pola można wymienić w tym atrybucie. Możliwe wartości umieszczania pola to LEWA, PRAWA, GÓRNA, DOLNA. Jeśli żadna wartość nie zostanie podana, wartość domyślna będzie pozostawiona w lewo. |
|
|
field_type
|
field_type | string |
Typ pola do utworzenia w dokumencie. Możliwe wartości to "SIGNATURE", "IN_PERSON_SIGNATURE", "INITIALS", "TEXT", "NUMBER", "NAME", "EMAIL", "COMPANY", "JOBTITLE", "RADIOBOX", "CHECKBOX", "DATE", "ATTACHMENT" |
|
|
level_of_assurance
|
level_of_assurance | array of string |
Poziom zapewniania, który ma zostać zaktualizowany. Możliwe wartości to "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE" |
|
|
x
|
x | True | double |
Lewa lokalizacja pola w pikselach. |
|
y
|
y | True | double |
Górna lokalizacja pola w pikselach. |
|
width
|
width | True | double |
Szerokość pola w pikselach. |
|
height
|
height | True | double |
Wysokość pola w pikselach. |
|
symbol zastępczy
|
placeholder | string |
Podaj notatkę w przypadku obowiązkowego załącznika |
|
|
radio_group_name
|
radio_group_name | string |
Nazwa grupy wymagana tylko podczas dodawania pola Typ urządzenia radiowego do grupowania wielu pól radiowych. |
|
|
format
|
format | string |
Format tekstowy pola. Używane tylko dla pola typu daty. Możliwe wartości to
|
|
|
wartość
|
value | string |
Wartość, którą użytkownik chce wyświetlić w polu. |
|
|
max_length
|
max_length | True | integer |
Maksymalna długość wartości dozwolonej w polu. Musi należeć do zakresu od 1 do 9999 |
|
validation_rule
|
validation_rule | string |
Co najmniej jedna reguła sprawdzania poprawności możliwych wartości pól to "OBOWIĄZKOWE" lub "OPCJONALNE". |
|
|
required
|
required | True | boolean | |
|
typ
|
type | string |
Określa typ reguły sprawdzania poprawności, która jest obecnie zawsze ustawiona na wartość EQUALS dla pola tekstowego. |
|
|
wartość
|
value | string |
Reprezentuje wartość używaną do walidacji. |
|
|
nazwa
|
name | string |
Nazwa czcionki wybranej dla pola tekstowego. Możliwe wartości to "COURIER", "HELVETICA". |
|
|
size
|
size | string |
Rozmiar czcionki wybranej dla pola tekstowego. Możliwe wartości to 8, 10, 12, 14, 16, 18, 20 |
|
|
embedded_size
|
embedded_size | string |
Rozmiar czcionki w oryginalnym dokumencie PDF. |
|
|
wielowierszowy
|
multiline | True | boolean |
Należy to do typu pola Obszar tekstu, a jeśli ustawiono wartość true, pole obszaru tekstowego zostanie utworzone z opcją wielowierszową. |
Zwraca
- response
- array of AutoPlaceFieldsResponse
Przekazywanie dokumentu
Aplikacje biznesowe mogą używać tego interfejsu API usługi do dodawania dokumentu do pakietu dokumentów połączonego z kontem użytkownika przedsiębiorstwa. Informacje o dokumencie są wysyłane w nagłówku żądania HTTP, a bajty dokumentu są wysyłane w treści żądania HTTP. Uwaga Usługa SigningHub konwertuje obsługiwane formaty dokumentów na format PDF, jeśli nagłówek "x-convert-document" jest ustawiony na wartość "true". Jedynym obsługiwanym przypadkiem, w którym ta wartość jest ustawiona na wartość "false", jest zachowanie Word formatowania i dokumentów XML.
Usługa SigningHub obsługuje szeroką gamę formatów dokumentów, z których każdy można przekonwertować na format PDF po przekazaniu. Kliknij tutaj, aby uzyskać pełną listę.
Uwaga Dokumenty PDF nie są zmieniane podczas przekazywania do systemu.
Pamiętaj, że pakiet musi już istnieć, zanim będzie można dodać dokument przy użyciu tego wywołania.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, do którego jest dodawany dokument. |
|
Zawartość pliku
|
body | True | binary |
Jest to dokument w nieprzetworzonym formacie binarnym. |
|
Nazwa pliku
|
x-file-name | string |
Jest to nazwa pliku z rozszerzeniem. |
|
|
Konwertowanie dokumentu
|
x-convert-document | string |
Określa to, czy dokument ma zostać przekonwertowany na plik PDF, czy też powinien zostać zachowany w oryginalnym formacie. Zwróć uwagę, że obecnie obsługiwany jest jedyny obsługiwany format oryginalny Word & XML. Wszystkie inne typy dokumentów spowodują błąd, jeśli ta wartość nagłówka ma wartość "false". Jeśli przekaże dokument PDF, można pominąć ten nagłówek. |
|
|
Source
|
x-source | string |
Jest to identyfikacja źródła dokumentu, z którego dokument jest przekazywany, np. "Moja aplikacja". |
Zwraca
- Body
- UploadDocument
Przekaż załącznik
Aplikacje biznesowe mogą używać tego interfejsu API usługi do przekazywania załącznika w dokumencie.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, do którego jest dodawany dokument. |
|
Identyfikator dokumentu
|
documentId | True | integer |
Identyfikator dokumentu, do którego należy dodać załącznik. |
|
Zawartość pliku załącznika
|
body | True | binary |
Jest to dokument w nieprzetworzonym formacie binarnym. |
|
Nazwa pola
|
x-field-name | string |
Nazwa pola, jeśli jest to wymagane. Jest to opcjonalne i z polem załącznika nazwy pola jest przetwarzane. |
|
|
Nazwa pliku
|
x-file-name | True | string |
Jest to nazwa pliku z rozszerzeniem. |
|
Hasło dokumentu
|
x-password | string |
Hasło ustawione przez właściciela dokumentu na potrzeby uzyskiwania dostępu do dokumentu, jeśli istnieje. Jeśli hasło nie zostało ustawione, wartość będzie równa null. |
|
|
hasło One-Time
|
x-otp | string |
Hasło One-Time (OTP) ustawione przez właściciela dokumentu na potrzeby uzyskiwania dostępu do dokumentu, jeśli istnieje. Jeśli nie ustawiono protokołu OTP, wartość będzie równa null. |
|
|
Identyfikator folderu
|
x-folder-id | string |
Określ identyfikator folderu, aby pobrać elementy folderu, gdy jest zaangażowany folder przestrzeni udostępnionej. |
Zwraca
Przenoszenie pakietu do folderu Niestandardowe lub Udostępnione miejsce
Aplikacje biznesowe mogą używać tego interfejsu API usługi do przenoszenia pakietu dokumentów do folderu udostępnionego lub niestandardowego folderu użytkownika.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, który musi przejść do folderu |
|
folder_name
|
folder_name | True | string |
Nazwa folderu docelowego, w którym pakiet musi być przeniesiony |
Zwraca
- response
- object
Prześlij dokument
Jedną z ról usługi SigningHub jest "Edytor". Dzięki temu adresat może edytować pola wejściowe w dokumencie, ale nie wymaga podpisu. Po zakończeniu adresat przesyła swoje zmiany. Przycisk używany w graficznym interfejsie użytkownika nosi nazwę "Prześlij".
Jest to równoważna operacja dla edytora w celu przesłania zmian za pośrednictwem wywołania interfejsu API.
Kliknij pozycję SigningHub Roles (Role usługi SigningHub ), aby uzyskać opis wszystkich dostępnych ról adresata przepływu pracy.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu SigningHub zawierający dokument do przesłania. |
|
Hasło dostępu do dokumentu
|
x-password | string |
Hasło ustawione przez właściciela dokumentu na potrzeby uzyskiwania dostępu do dokumentu, jeśli istnieje. Jeśli hasło nie zostało ustawione, wartość będzie równa null. |
|
|
Hasło One-Time dokumentu
|
x-otp | string |
Hasło One-Time (OTP) ustawione przez właściciela dokumentu na potrzeby uzyskiwania dostępu do dokumentu, jeśli istnieje. Jeśli nie ustawiono protokołu OTP, wartość będzie równa null. |
|
|
Identyfikator folderu
|
x-folder-id | string |
Określ identyfikator folderu, aby pobrać elementy folderu, gdy jest zaangażowany folder przestrzeni udostępnionej. |
Zwraca
- response
- object
Przypisywanie pola dokumentu
Aplikacje biznesowe mogą używać tego interfejsu API usługi, aby przypisywać użytkowników do pól wejściowych, np. pól podpisu, a tym samym definiować kolejność podpisywania. Pola muszą być już obecne w dokumencie, a użytkownicy muszą być obecni w przepływie pracy. Identyfikator dokumentu przepływu pracy jest podany w adresie URL zasobu wraz z identyfikatorem pakietu.
Gdy adresaci znajdują się w przepływie pracy, są numerowani, zaczynając od jednego i licząc na każdy dodatkowy. W związku z tym, jeśli w przepływie pracy są ponumerowani trzej użytkownicy, numerowane są "1", "2" i "3" z szacunkiem. To wywołanie interfejsu API umożliwia przypisanie użytkownika według numeru zamówienia przepływu pracy do pola wejściowego w dokumencie.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, do którego jest dodawany dokument. |
|
Identyfikator dokumentu
|
documentId | True | integer |
Identyfikator dokumentu, dla którego użytkownik przepływu pracy musi zostać zaktualizowany. |
|
field_name
|
field_name | True | string |
Nazwa pola podpisu, które ma zostać przypisane. |
|
radio_group_name
|
radio_group_name | string |
podaj nazwę grupy dla pola radiowego |
|
|
porządek
|
order | True | integer |
Kolejność użytkownika w przepływie pracy, do którego jest przypisywane pole. |
|
level_of_assurance
|
level_of_assurance | array of string |
Poziom zapewniania, który ma zostać dodany. Możliwe wartości to "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE" |
Zwraca
- response
- object
Stan podpisywania zbiorczego
Aplikacje biznesowe mogą używać tego interfejsu API do uzyskiwania stanu określonej transakcji podpisywania zbiorczego wraz ze szczegółami pakietów dokumentów przetworzonych przez interfejs API pakietów podpisywania zbiorczego .
Ten interfejs API należy wywołać po interfejsie API pakietów podpisywania zbiorczego.
Sygnatariusz jest identyfikowany przez token dostępu przedstawiony w wywołaniu. W związku z tym uwierzytelnianie sygnatariusza jest wymagane przed wykonaniem tego wezwania. Nie można uwierzytelnić się jako administrator przedsiębiorstwa za pomocą zmiennej zakresu i podpisać dokument w imieniu użytkownika. Token dostępu musi zostać wystawiony sygnatariuszowi w wyniku uwierzytelniania bezpośredniego.
W przypadku podpisywania RAS właściwość ACTION będzie REMOTE_AUTHORIZATION_REQURIED, a właściwość STATUS będzie oczekująca, co oznacza, że żądanie musi być autoryzowane przy użyciu urządzenia przenośnego. Jeśli proces podpisywania zakończy się niepowodzeniem w niektórych dokumentach z powodu różnych poziomów zapewnienia skonfigurowanych, a użytkownik chce ponownie zainicjować proces podpisywania w celu ukończenia procesu podpisywania w dokumentach zakończonych niepowodzeniem, właściwość ACTION będzie REINITIATE_SIGNING_PROCESS, a właściwość STATUS będzie OCZEKUJĄCA.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator_transakcji
|
transaction_id | string |
Numer identyfikacyjny transakcji podpisywania zbiorczego |
|
|
Akcja zbiorcza
|
bulk_action | True | string |
Akcja zbiorcza do wykonania. Możliwe wartości to: SIGN | UDOSTĘPNIJ |
Zwraca
Stosowanie szablonu przepływu pracy
Aplikacje biznesowe mogą używać tego interfejsu API usługi do stosowania szablonu przepływu pracy do dokumentu. Identyfikator dokumentu, na którym należy zastosować szablon, znajduje się w adresie URL zasobu. Gdy identyfikator dokumentu ma wartość 0, szablon zostanie zastosowany do wszystkich dokumentów w pacakge.
Podczas stosowania szablonu należy pamiętać o tych dwóch ważnych kwestiach:
Punkt 1 — jeśli zastosowany szablon zostanie utworzony przy użyciu pliku PDF, który zawiera już pola formularza, upewnij się, że dokument, na którym jest teraz stosowany ten szablon, musi zawierać te pola formularza z wyprzedzeniem, a usługa SigningHub nie utworzy tych pól formularza za pośrednictwem szablonu, a jedynie zastosuje dane formularza i przypisze je do odpowiednich użytkowników.
Punkt 2 — jeśli zastosowany szablon jest tworzony, w którym pola formularza są dodawane ręcznie (stąd nie są one pierwotnie obecne w pliku PDF) za pośrednictwem witryny SigningHub, np. pola podpisu, początkowego, podpisu osoby, pól radiowych, pól radiowych, pól tekstowych itp., następnie przy zastosowaniu takiego szablonu te pola formularza zostaną utworzone w dokumencie docelowym, nawet jeśli te pola formularza były już obecne w dokumencie.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, do którego należy zastosować szablon. |
|
Identyfikator dokumentu
|
documentId | True | integer |
Identyfikator dokumentu, na którym należy zastosować szablon. Jeśli wartość jest ustawiona na 0, jeśli szablon ma być stosowany we wszystkich dokumentach w pakiecie. |
|
template_name
|
template_name | True | string |
Nazwa szablonu do zastosowania w dokumencie. |
|
apply_to_all
|
apply_to_all | True | boolean |
Prawda, jeśli szablon ma być stosowany we wszystkich dokumentach w pakiecie. |
Zwraca
Udostępnianie pakietu dokumentów
Aplikacje biznesowe mogą używać tego interfejsu API usługi do udostępniania pakietu dokumentów osobom podpisujący i uruchamiać nowy przepływ pracy. Dokument powinien być już przygotowany przez zastosowanie szablonu i opcjonalnie zaktualizowanie użytkowników i akcji zdefiniowanych w szablonie. Identyfikator pakietu, który ma zostać udostępniony, jest podany w adresie URL zasobu.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Pakiet dokumentu, który ma zostać udostępniony. |
Zwraca
- response
- array of StartWorkflowResponse
Ukończ przepływ pracy w środku (zakończ przepływ pracy)
Aplikacje biznesowe mogą oznaczać przepływ pracy ukończony nawet w środku przepływu pracy. Użyj tego interfejsu API usługi, aby zmienić stan przepływu pracy na ukończony. Jeśli istnieją adresaci, którzy jeszcze nie podpisali dokumentu. Ich podpis nie będzie już wymagany i nie będzie mógł zobaczyć dokumentu w skrzynce odbiorczej. Token elementu nośnego powinien należeć do właściciela dokumentu lub administratora przedsiębiorstwa może użyć zmiennej zakresu, aby uzyskać token dostępu w imieniu właściciela dokumentu w celu wykonania tej akcji.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, z którego ma zostać usunięty adresat. |
|
Identyfikator folderu
|
x-folder-id | string |
Określ identyfikator folderu, aby pobrać elementy folderu, gdy jest zaangażowany folder przestrzeni udostępnionej. |
Zwraca
- response
- object
Usuwanie użytkownika przepływu pracy
Aplikacje biznesowe mogą używać tego interfejsu API usługi do usuwania adresata przepływu pracy.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, z którego ma zostać usunięty adresat. |
|
Zamówienie
|
order | True | integer |
Kolejność adresata w przepływie pracy, który ma zostać usunięty. |
Zwraca
- response
- object
Usuń dokument
Aplikacje biznesowe mogą używać tego interfejsu API usługi do usuwania dokumentu w pakiecie.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, do którego jest dodawany dokument. |
|
Identyfikator dokumentu
|
documentId | True | integer |
Identyfikator dokumentu do usunięcia. |
Zwraca
- Body
- DocumentResponse
Usuń pakiet
Aplikacje biznesowe mogą używać tego interfejsu API usługi do usuwania dokumentu ze skrzynki odbiorczej użytkownika. Identyfikator pakietu jest podany w adresie URL zasobu jako "{package_id}". Jeśli stan dokumentu to OCZEKUJĄCE, zostanie on automatycznie odrzucony w wyniku operacji usuwania. Jeśli stan dokumentu jest udostępniony, dokument zostanie automatycznie odwołany i przepływ pracy zostanie zatrzymany przed usunięciem dokumentu.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId_bulkAction | True | integer |
Identyfikator pakietu zawierającego dokument. |
Zwraca
- response
- object
Usuń pole dokumentu
Aplikacje biznesowe mogą używać tego interfejsu API usługi do usuwania pola dokumentu w pakiecie.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, do którego jest dodawany dokument. |
|
Identyfikator dokumentu
|
documentId | True | integer |
Identyfikator dokumentu, dla którego ma zostać podjęta akcja. |
|
field_name
|
field_name | True | string |
Nazwa pola do usunięcia. |
Zwraca
- response
- object
Usuń przestrzeń udostępnioną
Aplikacje biznesowe mogą używać tego interfejsu API usługi do usuwania przestrzeni udostępnionej. Dostępność usuwania przestrzeni udostępnionych podlega przypisanej roli użytkownika przedsiębiorstwa. Aby zezwolić na tę aprowizację administrator przedsiębiorstwa, włączy opcję "Zarządzaj przestrzenią udostępnioną" w obszarze Ustawienia dokumentu role>.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator przestrzeni udostępnionej
|
id | True | integer |
Identyfikator przestrzeni udostępnionej, którą chcesz usunąć |
Zwraca
- response
- object
Usuń załącznik
Aplikacje biznesowe mogą używać tego interfejsu API usługi do usuwania załącznika dokumentu.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, do którego jest dodawany dokument. |
|
Identyfikator dokumentu
|
documentId | True | integer |
Identyfikator dokumentu, do którego jest dodawany załącznik. |
|
Identyfikator załącznika
|
attachment_id | True | integer |
Identyfikator załącznika. |
|
Identyfikator folderu
|
x-folder-id | string |
Określ identyfikator folderu, aby pobrać elementy folderu, gdy jest zaangażowany folder przestrzeni udostępnionej. |
Zwraca
- response
- object
Uzyskiwanie historii przepływu pracy
Aplikacje biznesowe mogą używać tego interfejsu API usługi do pobierania listy akcji wykonywanych w dokumencie. Identyfikator pakietu jest podany w adresie URL zasobu. Pole wyszukiwania (nagłówek x-search-text) jest przeznaczone dla poczty e-mail, nazwy dokumentu, akcji, klucza informacji i wartości infovalue.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator dokumentu, dla którego jest wymagany dziennik. |
|
Numer strony
|
pageNo | True | integer |
Numer strony do pobrania. |
|
Liczba rekordów na stronie
|
recordsPerPage | True | integer |
Łączna liczba rekordów do pobrania na stronie. |
|
Tekst wyszukiwania
|
x-search-text | string |
Pole wyszukiwania (nagłówek x-search-text) jest przeznaczone dla poczty e-mail, nazwy dokumentu, akcji, klucza informacji i wartości infovalue. |
Zwraca
Uzyskiwanie kontaktów
Aplikacje biznesowe mogą używać tego interfejsu API usługi do ponawiania prób kontaktów zarówno z kontaktów osobistych, jak i przedsiębiorstwa dla bieżącego użytkownika.
Można wyszukiwać na podstawie kryterium podanego w nagłówku "x-search-text". Ponadto istnieje możliwość przeszukiwania określonych kontaktów użytkownika lub przedsiębiorstwa, do którego należy użytkownik.
Informacje odpowiedzi wyszukiwania zawierają adres e-mail użytkownika i odpowiednią nazwę użytkownika.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Liczba rekordów na stronie
|
recordPerPage | True | integer |
Łączna liczba rekordów do pobrania na stronie. |
|
Numer strony
|
pageNo | True | integer |
Numer strony do pobrania. |
|
Sortuj wg
|
sort-by | string |
Posortuj wynik według możliwych wartości wymienionych powyżej. |
|
|
Rosnąco
|
asc | boolean |
Porządkowanie zestawu wyników przez rosnąco lub malejąco. |
|
|
Tekst wyszukiwania
|
x-search-text | string |
Wyszukaj tekst, jeśli jest to wymagane. Jest to opcjonalne i bez niego zwracana jest cała lista. |
|
|
Tylko kontakty przedsiębiorstwa
|
x-enterprise | string |
Po ustawieniu wartości "true" zostanie zwrócona tylko lista kontaktów przedsiębiorstwa. W przypadku wartości "false" zostanie zwrócona tylko lista kontaktów użytkownika. Jeśli nie ustawisz nagłówka, zostaną zwrócone listy kontaktów przedsiębiorstwa i użytkownika. |
|
|
Łączna liczba rekordów
|
x-total-records | string |
Łączna liczba rekordów znalezionych przy użyciu podanych kryteriów wyszukiwania. |
Zwraca
- response
- array of ContactResponse
Uzyskiwanie przestrzeni udostępnionej
Aplikacje biznesowe mogą korzystać z tego interfejsu API usługi, aby uzyskać określoną przestrzeń udostępnioną. Ten interfejs API zwraca informacje o przestrzeni udostępnionej, jego właścicielu i współpracowniku.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator przestrzeni udostępnionej
|
id | True | integer |
Identyfikator przestrzeni udostępnionej, którą chcesz uzyskać |
Zwraca
- Body
- WorkSpaceResponse
Uzyskiwanie raportu dowodów procesów
Aplikacje biznesowe mogą używać tego interfejsu API usługi do pobierania raportu dowodów procesu przepływu pracy dokumentu.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator dokumentu. |
|
Identyfikator folderu
|
x-folder-id | string |
Określ identyfikator folderu, aby pobrać elementy folderu, gdy jest zaangażowany folder przestrzeni udostępnionej. |
Zwraca
- response
- object
Uzyskiwanie uprawnień użytkownika przepływu pracy
Aplikacje biznesowe mogą używać tego interfejsu API usługi do uzyskiwania uprawnień do dokumentu dla adresata. Odbiorca jest identyfikowany przez kolejność w przepływie pracy. Identyfikator pakietu jest podany w adresie URL zasobu.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator dokumentu, dla którego użytkownik przepływu pracy musi zostać zaktualizowany. |
|
Zamówienie
|
order | True | integer |
Kolejność użytkownika w przepływie pracy, dla którego są wymagane uprawnienia. Podając wartość 0 w kolejności, usługa zwróci uprawnienia ostatnio dodanego współpracownika w przepływie pracy. |
Zwraca
Uzyskiwanie zasad certyfikacji dla dokumentu
Aplikacje biznesowe mogą używać tego interfejsu API usługi, aby uzyskać certyfikowanie ustawień podpisu dokumentu w pakiecie.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, do którego jest dodawany dokument. |
|
Identyfikator dokumentu
|
documentId | True | integer |
Identyfikator dokumentu do pobrania. |
Zwraca
Wypełnij pola formularza
Aplikacje biznesowe mogą używać tego interfejsu API usługi do wypełniania co najmniej jednego pola formularza w dokumencie przez określonego użytkownika w kolejności.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, do którego jest dodawany dokument. |
|
Identyfikator dokumentu
|
documentId | True | integer |
Identyfikator dokumentu. |
|
auto_save
|
auto_save | True | boolean |
Wartość domyślna to false. Prawda, jeśli pola formularza są zapisywane bez interwencji użytkownika, np. podczas zamykania dokumentu lub naciśnięcia z powrotem. W przypadku podpisywania, inicjałów, osób przeglądających, Prześlij akcje wartość ma wartość false. |
|
field_name
|
field_name | True | string |
Unikatowy identyfikator pola w dokumencie. |
|
wartość
|
value | string |
Wartość pola do zapisania w dokumencie. |
|
|
field_name
|
field_name | True | string |
Unikatowy identyfikator pola w dokumencie. |
|
radio_group_name
|
radio_group_name | string |
Nazwa grupy, do której należy przycisk radiowy. |
|
|
wartość
|
value | True | boolean |
Wartość pola do zapisania w dokumencie. |
|
field_name
|
field_name | True | string |
Unikatowy identyfikator pola w dokumencie. |
|
wartość
|
value | True | boolean |
Wartość pola do zapisania w dokumencie. |
|
field_name
|
field_name | True | string |
Unikatowy identyfikator pola w dokumencie. |
|
wartość
|
value | string |
Wartość pola do zapisania w dokumencie. |
|
|
field_name
|
field_name | True | string |
Unikatowy identyfikator pola w dokumencie. |
|
wartość
|
value | string |
Wartość pola do zapisania w dokumencie. |
|
|
Hasło dokumentu
|
x-password | string |
Hasło ustawione przez właściciela dokumentu na potrzeby uzyskiwania dostępu do dokumentu, jeśli istnieje. Jeśli hasło nie zostało ustawione, wartość będzie równa null. |
|
|
hasło One-Time (OTP)
|
x-otp | string |
Hasło One-Time (OTP) ustawione przez właściciela dokumentu na potrzeby uzyskiwania dostępu do dokumentu, jeśli istnieje. Jeśli nie ustawiono protokołu OTP, wartość będzie równa null. |
|
|
Identyfikator folderu
|
x-folder-id | string |
Określ identyfikator folderu, aby pobrać elementy folderu, gdy jest zaangażowany folder przestrzeni udostępnionej. |
Zwraca
- response
- object
Zatwierdzanie dokumentu
Aplikacje biznesowe mogą używać tego interfejsu API usługi do zatwierdzania dokumentu przez określonego użytkownika w podanej kolejności.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu do zatwierdzenia. |
|
powód
|
reason | string |
Przyczyna zatwierdzenia pakietu. |
|
|
Hasło dostępu do dokumentu
|
x-password | string |
Hasło ustawione przez właściciela dokumentu na potrzeby uzyskiwania dostępu do dokumentu, jeśli istnieje. Jeśli hasło nie zostało ustawione, wartość będzie równa null. |
|
|
Hasło One-Time dokumentu
|
x-otp | string |
Hasło One-Time (OTP) ustawione przez właściciela dokumentu na potrzeby uzyskiwania dostępu do dokumentu, jeśli istnieje. Jeśli nie ustawiono protokołu OTP, wartość będzie równa null. |
|
|
Identyfikator folderu
|
x-folder-id | string |
Określ identyfikator folderu, aby pobrać elementy folderu, gdy jest zaangażowany folder przestrzeni udostępnionej. |
Zwraca
- response
- object
Zmienianie nazwy dokumentu
Aplikacje biznesowe mogą używać tego interfejsu API usługi do zmiany nazwy dokumentu w pakiecie.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId | True | integer |
Identyfikator pakietu, do którego jest dodawany dokument. |
|
Identyfikator dokumentu
|
documentId | True | integer |
Identyfikator dokumentu, do którego ma zostać wykonana akcja. |
|
document_name
|
document_name | True | string |
Nowa nazwa dokumentu. |
Zwraca
- Body
- DocumentResponse
Zmienianie nazwy pakietu
Ten interfejs API usługi służy do zmieniania nazwy pakietu dokumentu.
Pakiet dokumentu jest identyfikowany przez jego unikatowy identyfikator w adresie URL wywołania.
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pakietu
|
packageId_bulkAction | True | integer |
Identyfikator pakietu w celu zmiany nazwy. |
|
package_name
|
package_name | True | string |
Nowa nazwa pakietu dokumentów. |
Zwraca
- response
- object
Definicje
ElectronicSealRecipient
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string | |
|
level_of_assurance
|
level_of_assurance | string |
PermissionLegalNoticeResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
enabled
|
enabled | boolean |
Prawda, jeśli powiadomienie prawne jest włączone i skonfigurowane dla adresata. |
|
allowed_notices
|
allowed_notices | array of LegalNoticeResponse |
Lista powiadomień prawnych dozwolonych właścicielowi dokumentu, z którego może wybrać jeden dla adresata. |
|
default_notice
|
default_notice | array of LegalNoticeResponse |
Domyślnie lub wybrane powiadomienie prawne dla adresata. |
LegalNoticeResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
legal_notice_id
|
legal_notice_id | integer | |
|
legal_notice_name
|
legal_notice_name | string |
LegalNoticeResponse |
|
legal_notice_html
|
legal_notice_html | string |
Zawartość HTML powiadomienia prawnego. |
AccessResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
uwierzytelnianie
|
authentication | AuthenticationResponse | |
|
authentication_signing
|
authentication_signing | AuthenticationSigningResponse | |
|
access_duration
|
access_duration | PermissionAccessDurationResponse |
AuthenticationResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
enabled
|
enabled | boolean |
Prawda, jeśli dla pakietu jest włączone uwierzytelnianie. |
|
hasło
|
password | AccessSecurityPasswordResponse | |
|
sms_otp
|
sms_otp | AccessSecuritySmsOtpResponse | |
|
Totp
|
totp | TotpPermissionResponse |
AccessSecurityPasswordResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
enabled
|
enabled | boolean |
Prawda, jeśli dla pakietu włączono uwierzytelnianie hasłem. |
|
user_password
|
user_password | string |
Hasło uwierzytelniania na potrzeby dostępu do dokumentu. |
AccessSecuritySmsOtpResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
enabled
|
enabled | boolean |
Prawda, jeśli dla pakietu jest włączone uwierzytelnianie OTP programu SMS. |
|
otp_length
|
otp_length | integer | |
|
retry_duration
|
retry_duration | integer | |
|
mobile_number
|
mobile_number | string |
Numer telefonu komórkowego odbiorcy. Numer telefonu komórkowego jest wymagany do wysłania wiadomości SMS do adresata w celu uwierzytelnienia. |
|
Metody
|
methods | array of string |
Dozwolone metody OTP |
TotpPermissionResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
enabled
|
enabled | boolean |
Enabled |
AuthenticationSigningResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
enabled
|
enabled | boolean |
Prawda, jeśli dla pakietu jest włączone uwierzytelnianie. |
|
sms_otp
|
sms_otp | AuthenticationSigningSmsOtpResponse | |
|
Totp
|
totp | TotpPermissionResponse |
AuthenticationSigningSmsOtpResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
otp_length
|
otp_length | integer | |
|
retry_duration
|
retry_duration | integer | |
|
mobile_number
|
mobile_number | string |
Numer telefonu komórkowego odbiorcy. Numer telefonu komórkowego jest wymagany do wysłania wiadomości SMS do adresata w celu uwierzytelnienia. |
|
Metody
|
methods | array of string |
Dozwolone metody OTP |
PermissionAccessDurationResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
enabled
|
enabled | boolean |
Prawda, jeśli dla pakietu włączono zabezpieczenia czasu trwania dostępu. |
|
duration_by_date
|
duration_by_date | AccessDurationByDateResponse | |
|
duration_by_days
|
duration_by_days | AccessDurationByDaysResponse |
AccessDurationByDateResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
enabled
|
enabled | boolean |
Wartość true, jeśli zabezpieczenia dostępu są włączone przez czas trwania według daty i godziny. |
|
Dostępne
|
accessible | boolean | |
|
duration
|
duration | DurationByDateResponse |
DurationByDateResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
start_date_time
|
start_date_time | string |
Data i godzina, z której pakiet będzie dostępny dla adresata. |
|
end_date_time
|
end_date_time | string |
Data i godzina, po której pakiet nie będzie dostępny dla adresata. |
AccessDurationByDaysResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
enabled
|
enabled | boolean |
Prawda, jeśli zabezpieczenia dostępu są włączone przez czas trwania o liczbę dni. |
|
Dostępne
|
accessible | boolean | |
|
duration
|
duration | DurationByDaysResponse |
DurationByDaysResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
total_days
|
total_days | integer |
Łączna liczba dni, dla których pakiet będzie dostępny dla adresata po otrzymaniu pakietu. |
ReminderResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
enabled
|
enabled | boolean |
Prawda, jeśli przypomnienia są włączone dla adresata |
|
częstotliwość
|
frequency | string |
Częstotliwość przypomnienia. Możliwe wartości to DAYS | GODZIN. |
|
remind_after
|
remind_after | integer |
Liczba dni, po których pierwsze przypomnienie zostanie wysłane do użytkownika przepływu pracy. |
|
powtórzyć
|
repeat | ReminderRepeat |
ReminderRepeat
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
enabled
|
enabled | boolean |
Prawda, jeśli są włączone kolejne przypomnienia. |
|
częstotliwość
|
frequency | string |
Powtarzaj częstotliwość przypomnienia. Możliwe wartości to DAYS | GODZIN. |
|
keep_reminding_after
|
keep_reminding_after | integer |
Liczba dni, po których kolejne przypomnienia zostaną wysłane do adresata przepływu pracy. |
|
total_reminders
|
total_reminders | integer |
Liczba kolejnych przypomnień do wysłania do użytkownika przepływu pracy. |
AddQrCodeResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
dane
|
data | string |
Wygenerowane dane kodu QR |
|
field_name
|
field_name | string |
Nazwa pola utworzonego w dokumencie. |
|
wartość
|
value | string |
Wartość będzie wartością base64 obrazu QrCode |
QrCodeOptions
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
error_correction_level
|
error_correction_level | ECCLevelAPI |
Poziom korekty błędów dla kodu QR, który określa ilość nadmiarowości danych. Opcje to: L (Niski), M (Średni), Q (Kwartyl) i H (Wysoki). Wyższe poziomy oferują większą odporność na błędy. Wartość domyślna to "Q" |
|
kodowanie
|
encoding | EciModeAPI |
Określa tryb kodowania znaków dla zawartości kodu QR. Obsługiwane opcje to: Domyślne, Iso8859_1, Iso8859_2 i Utf8. Wartość domyślna to "Default" (Wartość domyślna) |
|
pixels_per_module
|
pixels_per_module | integer |
Określa liczbę pikseli na moduł w kodzie QR. Większa liczba powoduje zwiększenie i bardziej szczegółowy kod QR. Wartość domyślna to "20" Możliwe wartości to: 20 | 30 | 40 | 50 |
|
add_margins
|
add_margins | boolean |
Wskazuje, czy strefy ciche (marginesy) powinny być rysowane wokół kodu QR. Strefy ciche pomagają skanerom wykrywać i dekodować kod QR dokładniej. Wartość domyślna to "true" |
ECCLevelAPI
Poziom korekty błędów dla kodu QR, który określa ilość nadmiarowości danych. Opcje to: L (Niski), M (Średni), Q (Kwartyl) i H (Wysoki). Wyższe poziomy oferują większą odporność na błędy. Wartość domyślna to "Q"
Poziom korekty błędów dla kodu QR, który określa ilość nadmiarowości danych. Opcje to: L (Niski), M (Średni), Q (Kwartyl) i H (Wysoki). Wyższe poziomy oferują większą odporność na błędy. Wartość domyślna to "Q"
EciModeAPI
Określa tryb kodowania znaków dla zawartości kodu QR. Obsługiwane opcje to: Domyślne, Iso8859_1, Iso8859_2 i Utf8. Wartość domyślna to "Default" (Wartość domyślna)
Określa tryb kodowania znaków dla zawartości kodu QR. Obsługiwane opcje to: Domyślne, Iso8859_1, Iso8859_2 i Utf8. Wartość domyślna to "Default" (Wartość domyślna)
QrCodeColor
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
kropki
|
dots | string |
Reprezentuje ciemny kolor używany dla kropek w kodzie QR. Wartość domyślna to "black". np. "#0000000" |
|
tło
|
background | string |
Reprezentuje jasny kolor używany na tle kodu QR. Wartość domyślna to "biały". np. "#ffffff" |
QrCodeLogo
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
base64
|
base64 | string |
Opcjonalna ikona (base64) do umieszczenia w środku kodu QR. |
|
hide_background_dots
|
hide_background_dots | boolean |
Kolor tła za ikoną, jeśli zostanie podana ikona. Jeśli kolor nie jest dostarczany przezroczyste tło jest zaimplementowane. |
|
size
|
size | integer |
Rozmiar ikony jako procent rozmiaru kodu QR, jeśli zostanie podana ikona. Wartość domyślna to "15". Możliwe wartości to: 10 | 15 | 20 | 25 | 30 | 35 | 40 |
AddFieldResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
field_name
|
field_name | string |
Nazwa pola utworzonego w dokumencie. |
|
created_on
|
created_on | string |
Data i godzina utworzenia pola. |
Validationrule
Co najmniej jedna reguła sprawdzania poprawności możliwych wartości pól to "OBOWIĄZKOWE" lub "OPCJONALNE".
Co najmniej jedna reguła sprawdzania poprawności możliwych wartości pól to "OBOWIĄZKOWE" lub "OPCJONALNE".
SignatureFieldResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
field_name
|
field_name | string |
Nazwa pola utworzonego w dokumencie. |
|
created_on
|
created_on | string |
Data i godzina utworzenia pola. |
UpdateQrCodeResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
wartość
|
value | string |
Wartość będzie wartością base64 obrazu QrCode |
FieldValidationValue
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
required
|
required | boolean | |
|
rules
|
rules | array of FieldValidationValueRule |
FieldValidationValueRule
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
typ
|
type | string |
Określa typ reguły sprawdzania poprawności, która jest obecnie zawsze ustawiona na wartość EQUALS dla pola tekstowego. |
|
wartość
|
value | string |
Reprezentuje wartość używaną do walidacji. |
PostProcessResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
enabled
|
enabled | boolean |
Prawda, jeśli dla pakietu włączono przetwarzanie końcowe. |
|
contacts
|
contacts | array of string |
Lista adresów e-mail, do których zostanie wysłana wiadomość e-mail po zakończeniu przepływu pracy. |
|
recipients
|
recipients | array of PostProcessRecipientResponse |
Lista nazw i adresów e-mail, do których wiadomości e-mail są wysyłane po zakończeniu przetwarzania po zakończeniu przepływu pracy. |
|
komunikat
|
message | string |
Dowolny niestandardowy komunikat ciągu, który ma zostać wysłany do kontaktów po zakończeniu przepływu pracy. |
|
google_drive
|
google_drive | boolean |
Prawda, jeśli przekazywanie dysku google jest włączone dla pakietu. Dokumenty zostaną przekazane na dysk google po zakończeniu przepływu pracy. |
|
one_drive
|
one_drive | boolean |
Prawda, jeśli dla pakietu jest włączone przekazywanie jednego dysku. Dokumenty zostaną przekazane na jeden dysk po zakończeniu przepływu pracy. |
|
Dropbox
|
dropbox | boolean |
Prawda, jeśli przekazywanie dropbox jest włączone dla pakietu. Dokumenty zostaną przekazane na dysk google po zakończeniu przepływu pracy. |
|
workflow_recipients
|
workflow_recipients | boolean |
Prawda, jeśli raport ukończenia przepływu pracy ma zostać wysłany do wszystkich adresatów przepływu pracy podczas przetwarzania końcowego. Wartość domyślna to false. |
|
document_processing_report
|
document_processing_report | boolean |
Prawda, jeśli opcja Wyślij raport przetwarzania dokumentów (XML) ma być włączona dla przepływu pracy |
PostProcessRecipientResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string | |
|
e-mail
|
string |
CertifyResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
enabled
|
enabled | boolean |
Prawda, jeśli dla dokumentu są włączone ustawienia podpisu certyfikowania. |
|
allowed_permissions
|
allowed_permissions | array of string |
Certyfikowanie poziomu uprawnień ustawionego dla dokumentu przy użyciu ustawień podpisu certyfikowania. |
|
default_permission
|
default_permission | string |
GroupMemberResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
user_email
|
user_email | string |
Adres e-mail członka grupy |
|
user_name
|
user_name | string |
Nazwa użytkownika członka grupy |
WspółpracownikResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
user_email
|
user_email | string |
Adres e-mail użytkownika |
|
signing_order
|
signing_order | integer |
Kolejność podpisywania |
|
guest_user
|
guest_user | boolean |
Czy użytkownik-gość |
|
email_language_code
|
email_language_code | string |
Kod języka poczty e-mail |
|
uprawnienie
|
permission | WorkflowPermissionResponse | |
|
Przypomnienie
|
reminder | ReminderResponse |
WorkflowPermissionResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
drukować
|
boolean |
Prawda, jeśli drukowanie jest dozwolone dla tego adresata. |
|
|
pobierać
|
download | boolean |
Prawda, jeśli pobieranie jest dozwolone. |
|
add_text
|
add_text | boolean |
Prawda, jeśli dodawanie adnotacji tekstowej w dokumencie jest dozwolone. |
|
change_recipients
|
change_recipients | boolean |
Prawda, jeśli adresat bieżącej kolejności może zmienić innych adresatów w przepływie pracy po udostępnieniu przepływu pracy. |
|
add_attachment
|
add_attachment | boolean |
Prawda, jeśli załączniki i scalanie dokumentów PDF są dozwolone. |
|
legal_notice
|
legal_notice | PermissionLegalNoticeResponse | |
|
załącznik
|
attachment | AttachmentPermissionResponse |
AttachmentPermissionResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
enabled
|
enabled | boolean |
Enabled |
EnterpriseTemplateResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Identyfikator szablonu |
|
nazwa
|
name | string |
Nazwa szablonu. |
|
publiczny
|
public | boolean |
Odpowiedź to "true", jeśli szablon przedsiębiorstwa jest oznaczony jako publiczny. W przeciwnym razie zostanie zwrócona wartość "false" |
|
read_only
|
read_only | boolean |
Odpowiedź "true", jeśli szablon jest tylko do odczytu, a użytkownik nie może wprowadzić żadnych zmian w przepływie pracy po zastosowaniu tego szablonu. W przeciwnym razie "false". |
|
opis
|
description | string |
Opis szablonu |
|
created_on
|
created_on | string |
Data i godzina utworzenia szablonu |
|
roles
|
roles | array of EnterpriseTemplateRole | |
|
Dokumentów
|
documents | array of TemplateDocumentResponse |
EnterpriseTemplateRole
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string |
Nazwa roli przedsiębiorstwa przypisanej do użytkownika. |
|
identyfikator
|
id | integer |
Identyfikator roli przedsiębiorstwa przypisanej do użytkownika. |
TemplateDocumentResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Identyfikator dokumentu szablonu |
|
nazwa
|
name | string |
Nazwa dokumentu szablonu. |
Next_signer_email
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
user_email
|
user_email | string |
Adres e-mail następnego sygnatariusza. |
|
user_name
|
user_name | string |
Nazwa następnego osoby podpisającego. |
Przepływ pracyRecipient
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
porządek
|
order | integer |
Kolejność adresata w przepływie pracy. |
|
user_email
|
user_email | string |
Adres e-mail odbiorcy, jeśli użytkownik nie jest grupą. |
|
user_name
|
user_name | string |
Nazwa adresata, jeśli użytkownik nie jest grupą. |
|
mobile_number
|
mobile_number | string |
Numer telefonu komórkowego |
|
delivery_method
|
delivery_method | string |
Metoda dostarczania możliwych wartości adresatów: EMAIL, SMS lub EMAIL_AND_SMS |
|
user_photo_url
|
user_photo_url | string |
Punkt końcowy interfejsu API umożliwiający uzyskanie dostępu do zasobu. Zostanie on udostępniony tylko dla głównych osób podpisujących. np. będzie mieć wartość null dla grupy/delegatora/strażnika itp. Ten adres URL nie zapewnia, że istnieje obraz logowania. Jeśli obraz istnieje, zostanie udostępniony przez naciśnięcie zdefiniowanego adresu URL. W przeciwnym razie będzie to pusty ciąg. |
|
nazwa_grupy
|
group_name | string |
Nazwa grupy adresata, jeśli adresat jest grupą. |
|
group_members
|
group_members | array of GroupMemberResponse |
Lista adresów e-mail członków grupy, jeśli adresat jest grupą. |
|
delegatee
|
delegatee | string |
Deleguj adres e-mail, jeśli adresat nie jest grupą. |
|
delegatee_name
|
delegatee_name | string |
Nazwa użytkownika delegowanego, jeśli adresat nie jest grupą. |
|
rola
|
role | string |
Rola przepływu pracy, w której dodano adresata. Ta rola nie jest rolą przedsiębiorstwa. Możliwe wartości to "SIGNER", "REVIEWER","CARBON_COPY" i "EDITOR". |
|
powód
|
reason | string |
Przyczyna podana przez użytkownika podczas odrzucania, zatwierdzania lub przesyłania dokumentu. |
|
process_status
|
process_status | string |
Stan przetwarzania dokumentu dla adresata. Możliwe wartości to "UN_PROCESSED", "IN_PROGRESS", "SIGNED", "REVIEWED", "DECLINED", "EDITED" lub "INVALID". |
|
processed_on
|
processed_on | string |
Data i godzina przetworzenia dokumentu. |
|
processed_as
|
processed_as | string |
Użytkownik może przetworzyć pole jako WSPÓŁPRACOWNIK , DELEGATOR, GROUP_MEMBER lub WŁAŚCICIEL. |
|
processed_by
|
processed_by | string |
Adres e-mail użytkownika, który przetworzył dokument. |
|
symbol zastępczy
|
placeholder | string |
Tekst zastępczy, jeśli adresat jest symbolem zastępczym |
|
signing_order
|
signing_order | integer |
Kolejność, w której przepływ pracy zostanie podpisany przez adresatów. To zamówienie podpisywania jest ważne, gdy typ przepływu pracy jest ustawiony na "CUSTOM". |
|
user_national_id
|
user_national_id | string |
Numer tożsamości krajowej użytkownika. Pomaga to zidentyfikować użytkownika w przepływie pracy |
|
guest_user
|
guest_user | boolean |
Gest user |
|
email_language_code
|
email_language_code | string |
kod języka poczty e-mail |
|
electronic_seal
|
electronic_seal | ElectronicSealRecipient | |
|
Strażników
|
gatekeepers | WorkflowGatekeeperResponse |
WorkflowGatekeeperResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
emails
|
emails | array of WorkflowGatekeeperUserResponse |
Getekeepers |
WorkflowGatekeeperUserResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
user_email
|
user_email | string |
EnterpriseAccessResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
uwierzytelnianie
|
authentication | EnterpriseAuthenticationResponse | |
|
authentication_signing
|
authentication_signing | EnterpriseAuthenticationSigningResponse | |
|
access_duration
|
access_duration | PermissionAccessDurationResponse |
EnterpriseAuthenticationResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
enabled
|
enabled | boolean |
Prawda, jeśli dla pakietu jest włączone uwierzytelnianie. |
|
hasło
|
password | AccessSecurityPasswordResponse | |
|
sms_otp
|
sms_otp | EnterpriseAccessSecuritySmsOtpResponse | |
|
Totp
|
totp | TotpPermissionResponse |
EnterpriseAccessSecuritySmsOtpResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
enabled
|
enabled | boolean |
Prawda, jeśli dla pakietu jest włączone uwierzytelnianie OTP programu SMS. |
|
otp_length
|
otp_length | integer | |
|
retry_duration
|
retry_duration | integer | |
|
mobile_number
|
mobile_number | string |
Numer telefonu komórkowego odbiorcy. Numer telefonu komórkowego jest wymagany do wysłania wiadomości SMS do adresata w celu uwierzytelnienia. |
EnterpriseAuthenticationSigningResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
enabled
|
enabled | boolean |
Prawda, jeśli dla pakietu jest włączone uwierzytelnianie. |
|
sms_otp
|
sms_otp | EnterpriseAuthenticationSigningSmsOtpResponse | |
|
Totp
|
totp | TotpPermissionResponse |
EnterpriseAuthenticationSigningSmsOtpResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
otp_length
|
otp_length | integer | |
|
retry_duration
|
retry_duration | integer | |
|
mobile_number
|
mobile_number | string |
Numer telefonu komórkowego odbiorcy. Numer telefonu komórkowego jest wymagany do wysłania wiadomości SMS do adresata w celu uwierzytelnienia. |
GetPackageDetailsResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string |
Nazwa pakietu dokumentów. |
|
właściciel
|
owner | DocumentOwner | |
|
read_only
|
read_only | boolean |
Wartość True, jeśli zastosowany szablon jest tylko do odczytu. Użytkownik nie będzie mógł wprowadzać żadnych zmian w przypadku zastosowania szablonu tylko do odczytu. |
|
document_status
|
document_status | string |
Stan dokumentu dla bieżącego zalogowanego użytkownika. Możliwe wartości to "DRAFT", "INPROGRESS", "PENDING", "DECLINED" lub "COMPLETED". |
|
Dokumentów
|
documents | array of DocumentDetails |
Właściciel dokumentu
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string |
Nazwa właściciela pakietu dokumentów. |
|
e-mail
|
string |
Adres e-mail właściciela pakietu dokumentów. |
DocumentDetails
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Identyfikator nowo utworzonego dokumentu. |
|
nazwa
|
name | string |
Nazwa dokumentu. |
|
uploaded_on
|
uploaded_on | string |
Data i godzina przekazania dokumentu. |
|
modified_on
|
modified_on | string |
Data i godzina ostatniej modyfikacji dokumentu. |
|
size
|
size | integer |
Rozmiar dokumentu w bajtach. |
|
typ
|
type | string |
Typ dokumentu, np. "PDF". |
|
przesłać źródło
|
source | string |
Określa miejsce przekazania dokumentu, np. "Moja aplikacja". |
SzablonResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
template_id
|
template_id | integer |
Identyfikator szablonu jest zwracany tutaj |
|
template_name
|
template_name | string |
Nazwa szablonu. |
|
template_public
|
template_public | boolean |
Odpowiedź to "true", jeśli szablon przedsiębiorstwa jest oznaczony jako publiczny. W przeciwnym razie zostanie zwrócona wartość "false" |
|
read_only
|
read_only | boolean |
Odpowiedź "true", jeśli szablon jest tylko do odczytu, a użytkownik nie może wprowadzić żadnych zmian w przepływie pracy po zastosowaniu tego szablonu. W przeciwnym razie "false". |
|
created_on
|
created_on | string |
Data i godzina utworzenia szablonu |
|
opis
|
description | string |
Opis szablonu |
|
przedsiębiorstwo
|
enterprise | boolean |
Prawda, jeśli użytkownik należy do przedsiębiorstwa. |
|
Dokumentów
|
documents | array of TemplateDocumentResponse | |
|
smart_form
|
smart_form | TemplateSmartFormResponse |
TemplateSmartFormResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
active_count
|
active_count | integer |
Liczba aktywnych |
|
total_count
|
total_count | integer |
Total |
StartWorkflowResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
package_id
|
package_id | integer |
Identyfikator pakietu właśnie udostępnionego. W przypadku pojedynczego udostępniania więcej niż jeden pakiet jest tworzony i udostępniany adresatom. Interfejs API zwraca tablicę pakietów wraz z identyfikatorami nowo utworzonych dokumentów. |
|
Dokumentów
|
documents | array of integer |
Tablica identyfikatorów dokumentów, które były częścią pakietu przed udostępnieniem. |
WorkflowDetailsResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
package_id
|
package_id | integer |
Identyfikator pakietu dokumentu. |
|
package_name
|
package_name | string |
Nazwa pakietu dokumentów. |
|
shared_package
|
shared_package | boolean |
pakiet udostępniony |
|
package_owner
|
package_owner | string |
Adres e-mail właściciela pakietu dokumentów. |
|
owner_name
|
owner_name | string |
Nazwa właściciela pakietu dokumentów. |
|
package_status
|
package_status | string |
Stan dokumentu dla bieżącego zalogowanego użytkownika. Możliwe wartości to "DRAFT", "INPROGRESS", "PENDING", "DECLINED", "APPROVED", "UPDATED" lub "COMPLETED". |
|
folder
|
folder | string |
Nazwa folderu zawierającego pakiet dokumentów. |
|
folder_id
|
folder_id | integer |
Identyfikator folderu zawierającego pakiet dokumentów. |
|
Strażnika
|
gatekeeper | boolean | |
|
next_signer
|
next_signer | string |
Nazwa następnego osoby podpisającego, jeśli dokument jest w stanie udostępnionym. |
|
next_signer_email
|
next_signer_email | array of Next_signer_email |
Obiekt zawierający następną nazwę użytkownika i adres e-mail osoby podpisujące. W przypadku podpisywania grupy będzie ona zawierać listę adresów e-mail wszystkich członków grupy. |
|
uploaded_on
|
uploaded_on | string |
Data i godzina przekazania dokumentu. |
|
modified_on
|
modified_on | string |
Data i godzina ostatniej modyfikacji dokumentu. |
|
przepływ pracy
|
workflow | WorkflowResponse | |
|
Dokumentów
|
documents | array of WorkflowDocumentsResponse |
Lista dokumentów przekazanych w pakiecie. |
|
users
|
users | array of WorkflowUserResponse |
Lista adresatów przepływu pracy. |
WorkflowResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
workflow_type
|
workflow_type | string |
Typ przepływu pracy— w aplikacji są obsługiwane cztery typy przepływów pracy. Możliwe wartości to "SERIAL", "PARALLEL", "INDIVIDUAL" i "CUSTOM". |
|
continue_on_decline
|
continue_on_decline | boolean |
Prawda, jeśli przepływ pracy musi być kontynuowany nawet po tym, jak odbiorca odrzuci się na jego kolei. |
|
workflow_status
|
workflow_status | string |
Stan przetwarzania przepływu pracy, możliwe wartości to "DRAFT", "IN_PRGORESS" i "COMPLETED". |
|
workflow_mode
|
workflow_mode | string |
Tryb przepływu pracy, istnieją trzy typy trybów przepływu pracy obsługiwanych w aplikacji. Możliwe wartości to "ONLY_ME", "ME_AND_OTHERS" i "ONLY_OTHERS" |
|
komunikat
|
message | string |
Dowolny niestandardowy komunikat ciągu, który ma zostać wysłany do wszystkich adresatów przepływu pracy przez właściciela dokumentu. |
|
read_only
|
read_only | boolean |
Jeśli jakikolwiek szablon zastosowany w dokumentach w tym przepływie pracy jest tylko do odczytu lub jest zablokowany, przepływ pracy jest tylko do odczytu. Usługa SigningHub nie zezwoli użytkownikom końcowym na wprowadzanie żadnych zmian w tym przepływie pracy w stanie roboczym, a ten przepływ pracy ma być udostępniany w taki sam sposób. |
|
post_process
|
post_process | PostProcessResponse | |
|
comments
|
comments | boolean |
Comments |
WorkflowDocumentsResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
document_id
|
document_id | integer |
Identyfikator dokumentu. |
|
document_name
|
document_name | string |
Nazwa dokumentu. |
|
document_type
|
document_type | string |
Oryginalne rozszerzenie dokumentu, gdy dokument został przekazany przed konwersją do pliku PDF. |
|
document_order
|
document_order | integer |
Kolejność dokumentu w pakiecie dokumentów. |
|
document_source
|
document_source | string |
Źródło dokumentu, z którego został przekazany dokument. |
|
update_required
|
update_required | boolean |
Prawda, jeśli dokument jest wymagany do aktualizacji |
|
document_height
|
document_height | integer |
Wysokość dokumentu PDF. |
|
document_width
|
document_width | integer |
Szerokość dokumentu PDF. |
|
document_pages
|
document_pages | integer |
Całkowita liczba stron w dokumencie. |
|
created_on
|
created_on | string |
Data i godzina przekazania dokumentu. |
|
modified_on
|
modified_on | string |
Data i godzina ostatniej modyfikacji dokumentu. |
|
form_fields
|
form_fields | boolean |
Prawda, jeśli dokument ma pola formularza. |
|
szablon
|
template | DocumentsTemplateResponse | |
|
Zaświadczam
|
certify | CertifyResponse | |
|
lock_form_fields
|
lock_form_fields | boolean |
Prawda, jeśli dokument jest ustawiony na blokowanie pól formularza przy użyciu ostatniego podpisu cyfrowego w dokumencie. |
|
zablokowany
|
locked | boolean | |
|
has_signed_signature_fields
|
has_signed_signature_fields | boolean |
Informacje meta dokumentu pdf: prawda, jeśli dokument pdf ma podpisane pola podpisu |
|
attachments
|
attachments | boolean |
Prawda, jeśli dokument zawiera załączniki. |
|
conformance_level
|
conformance_level | string |
Poziom zgodności dokumentu |
|
document_size
|
document_size | integer |
Rozmiar dokumentu. |
|
Sformatowany
|
formatted | boolean |
Ta właściwość jest przeznaczony dla dokumentu XML, który jest sformatowany lub nie |
DokumentyTemplateResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
template_id
|
template_id | integer |
Identyfikator szablonu zastosowanego do dokumentu. |
|
template_name
|
template_name | string |
Nazwa szablonu zastosowanego do dokumentu. |
|
read_only
|
read_only | boolean |
Prawda, jeśli szablon jest skonfigurowany jako tylko do odczytu. Po zastosowaniu szablonu tylko do odczytu nie należy wprowadzać żadnych zmian w przepływie pracy. |
WorkflowUserResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
porządek
|
order | integer |
Kolejność adresata w przepływie pracy. |
|
user_name
|
user_name | string |
Nazwa adresata, jeśli adresat nie jest grupą. Jeśli adresat jest symbolem zastępczym, będzie zawierać nazwę symbolu zastępczego. |
|
user_email
|
user_email | string |
Adres e-mail odbiorcy, jeśli adresat nie jest grupą lub symbolem zastępczym. |
|
mobile_number
|
mobile_number | string |
Numer telefonu komórkowego |
|
delivery_method
|
delivery_method | string |
Metoda dostarczania możliwych wartości adresatów: EMAIL, SMS lub EMAIL_AND_SMS |
|
user_photo_url
|
user_photo_url | string |
Punkt końcowy interfejsu API umożliwiający uzyskanie dostępu do zasobu. Zostanie on udostępniony tylko dla głównych osób podpisujących. np. będzie mieć wartość null dla grupy/delegatora/strażnika itp. Ten adres URL nie zapewnia, że istnieje obraz logowania. Jeśli obraz istnieje, zostanie udostępniony przez naciśnięcie zdefiniowanego adresu URL. W przeciwnym razie będzie to pusty ciąg. |
|
nazwa_grupy
|
group_name | string |
Nazwa grupy, jeśli adresat jest grupą. |
|
group_members
|
group_members | array of string |
Lista wszystkich adresów e-mail i nazwisk użytkowników. |
|
delegator
|
delegator | string |
Adres e-mail użytkownika, który jest delegorem do tego adresata. |
|
Strażnika
|
gatekeeper | string |
Adres e-mail użytkownika, który jest strażnikiem dla tego adresata. |
|
Strażników
|
gatekeepers | WorkflowGatekeeperResponse | |
|
rola
|
role | string |
Rola adresata, tj. "SIGNER", "REVIEWER", "EDITOR","CARBON_COPY" lub "INPERSON_HOST". |
|
process_status
|
process_status | string |
Stan przetwarzania dokumentu dla adresata. Możliwe wartości to "UN_PROCESSED", "IN_PROGRESS", "SIGNED", "REVIEWED", "DECLINED", "EDITED" lub "INVALID". |
|
processed_on
|
processed_on | string |
Data i godzina przetworzenia dokumentu. |
|
processed_as
|
processed_as | string |
Użytkownik może przetworzyć pole jako WSPÓŁPRACOWNIK, DELEGATOR, GROUP_MEMBER lub WŁAŚCICIEL. |
|
processed_by
|
processed_by | string |
Adres e-mail użytkownika, który przetworzył dokument. |
|
powód
|
reason | string |
Przyczyna podana przez użytkownika podczas odrzucania, zatwierdzania lub przesyłania dokumentu. |
|
symbol zastępczy
|
placeholder | string |
Tekst zastępczy, jeśli adresat jest symbolem zastępczym. |
|
uprawnienie
|
permission | WorkflowPermissionResponse | |
|
authentications
|
authentications | AccessResponse | |
|
Przypomnienie
|
reminder | ReminderResponse | |
|
signing_order
|
signing_order | integer |
Kolejność, w której przepływ pracy zostanie podpisany przez adresatów. To zamówienie podpisywania jest ważne, gdy typ przepływu pracy jest ustawiony na "CUSTOM". |
|
user_national_id
|
user_national_id | string |
Numer tożsamości krajowej użytkownika. Pomaga to zidentyfikować użytkownika w przepływie pracy |
|
guest_user
|
guest_user | boolean |
Gest user |
|
email_language_code
|
email_language_code | string |
Kod języka poczty e-mail |
|
electronic_seal
|
electronic_seal | ElectronicSealRecipient |
DocumentDetailsResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
document_id
|
document_id | integer |
Identyfikator nowo utworzonego dokumentu. |
|
document_name
|
document_name | string |
Nazwa dokumentu. |
|
document_order
|
document_order | integer | |
|
document_type
|
document_type | string |
Typ dokumentu, np. "PDF". |
|
document_width
|
document_width | integer |
Szerokość dokumentu w formacie PDF. |
|
document_height
|
document_height | integer |
Wysokość dokumentu w formacie PDF. |
|
document_source
|
document_source | string |
Określa miejsce przekazania dokumentu, np. "Moja aplikacja". |
|
document_pages
|
document_pages | integer |
Łączna liczba stron dokumentu. |
|
form_fields
|
form_fields | boolean |
Prawda, jeśli dokument ma pola formularza. |
|
lock_form_fields
|
lock_form_fields | boolean |
Wartość True, jeśli jest włączone blokowanie pól formularza z ostatnim podpisem. |
|
uploaded_on
|
uploaded_on | string |
Data i godzina przekazania dokumentu. |
|
modified_on
|
modified_on | string |
Data i godzina ostatniej modyfikacji dokumentu. |
|
Zaświadczam
|
certify | DocumentCertifyResponse | |
|
szablon
|
template | DocumentTemplateResponse |
DocumentCertifyResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
enabled
|
enabled | boolean |
Prawda, jeśli dla dokumentu włączono podpis certyfikowania. |
|
uprawnienie
|
permission | string |
Jest to uprawnienia do certyfikacji, które mają być stosowane w dokumencie PDF podczas tworzenia pierwszego podpisu. Możliwe wartości to "NO_CHANGES_ALLOWED", "FORM_FILLING_ALLOWED" i "FORM_FILLING_WITH_ANNOTATIONS_ALLOWED". |
DocumentTemplateResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
template_name
|
template_name | string |
Nazwa szablonu zastosowanego w dokumencie. |
|
read_only
|
read_only | boolean |
Wartość True, jeśli zastosowany szablon jest tylko do odczytu. Użytkownik nie będzie mógł wprowadzać żadnych zmian w przypadku zastosowania szablonu tylko do odczytu. |
AddAttachmentResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
attachment_id
|
attachment_id | integer |
Identyfikator załącznika |
GetAttachmentResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
attachment_id
|
attachment_id | integer |
Identyfikator załącznika |
|
attachment_name
|
attachment_name | string |
Nazwa załącznika |
AddPackageResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
package_id
|
package_id | integer |
Identyfikator pakietu, który ma być używany później do udostępniania, pobierania i pobierania stanu dokumentu. |
|
workflow_mode
|
workflow_mode | string |
Tryb przepływu pracy ustawiony podczas dodawania pakietu. |
|
workflow_type
|
workflow_type | string |
Typ przepływu pracy. Możliwe wartości to "SERIAL", "PARALLEL", "INDIVIDUAL" i "CUSTOM". |
GetPackagesResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
package_id
|
package_id | integer |
Identyfikator pakietu dokumentu. |
|
package_name
|
package_name | string |
Nazwa pakietu dokumentów. |
|
package_owner
|
package_owner | string |
Adres e-mail właściciela pakietu dokumentów. |
|
owner_name
|
owner_name | string |
Nazwa właściciela pakietu dokumentów. |
|
shared_package
|
shared_package | boolean |
Pakiet udostępniony |
|
gatekeeper_package
|
gatekeeper_package | boolean |
Pakiet gatekeeper |
|
package_status
|
package_status | string |
Stan dokumentu dla bieżącego zalogowanego użytkownika. Możliwe wartości to "DRAFT", "INPROGRESS", "PENDING", "DECLINED" lub "COMPLETED". |
|
rozszerzenie
|
extension | string |
Rozszerzenie pakietu dokumentów |
|
workflow_mode
|
workflow_mode | string |
Tryb przepływu pracy |
|
folder
|
folder | string |
Nazwa folderu zawierającego pakiet dokumentów. |
|
folder_id
|
folder_id | integer |
Identyfikator folderu zawierającego pakiet dokumentów. |
|
nieprzeczytany
|
unread | boolean |
Prawda, jeśli dokument nie jest jeszcze odczytywany przez adresata. |
|
next_signer
|
next_signer | string |
Nazwa następnego osoby podpisającego, jeśli dokument jest w stanie udostępnionym. |
|
next_signer_email
|
next_signer_email | array of Next_signer_email |
Obiekt zawierający następną nazwę użytkownika i adres e-mail osoby podpisujące. W przypadku podpisywania grupy będzie ona zawierać listę adresów e-mail wszystkich członków grupy. |
|
uploaded_on
|
uploaded_on | string |
Data i godzina przekazania dokumentu. |
|
modified_on
|
modified_on | string |
Data i godzina ostatniej modyfikacji dokumentu. |
|
access_duration
|
access_duration | RecipientAccessDurationDetails | |
|
Spadek
|
decline | RecipientDeclineDetails | |
|
size
|
size | integer |
Rozmiar dokumentu w bajtach. |
RecipientAccessDurationDetails
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
date_from
|
date_from | string |
Data/godzina rozpoczęcia dla adresata w celu uzyskania dostępu do dokumentu |
|
date_to
|
date_to | string |
Data/godzina zakończenia dla adresata w celu uzyskania dostępu do dokumentu |
RecipientDeclineDetails
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
powód
|
reason | string |
Definiowanie przyczyny odrzucenia dokumentu |
|
auto_decline
|
auto_decline | boolean |
Wskazanie dokumentu jest ręcznie/automatycznie odrzucone |
|
declined_by
|
declined_by | DeclineByDetails |
DeclineByDetails
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
user_name
|
user_name | string |
Nazwa użytkownika, który odrzucił przepływ pracy |
|
user_email
|
user_email | string |
Adres e-mail użytkownika, który odrzucił przepływ pracy |
DocumentResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
package_name
|
package_name | string |
Nazwa pakietu dokumentu |
UploadDocument
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
documentId
|
documentId | integer |
Ta właściwość jest zachowywana w celu zachowania zgodności z poprzednimi wersjami i zostanie usunięta w nowszych wersjach. Zamiast tego użyj document_id. |
|
documentid
|
documentid | integer |
Identyfikator dokumentu, który ma być używany później do udostępniania, pobierania i pobierania stanu dokumentu. zostanie usunięta później document_id zostanie użyta |
|
document_id
|
document_id | integer |
Identyfikator dokumentu, który ma być używany później do udostępniania, pobierania i pobierania stanu dokumentu. |
|
document_name
|
document_name | string |
Nazwa dokumentu. |
|
document_order
|
document_order | integer |
Kolejność dokumentów w pakiecie |
|
document_type
|
document_type | string |
Typ dokumentu, np. "PDF". |
|
document_source
|
document_source | string |
Określa miejsce przekazania dokumentu, np. "Moja aplikacja". |
|
document_width
|
document_width | integer |
Szerokość dokumentu w formacie PDF. |
|
document_height
|
document_height | integer |
Wysokość dokumentu w formacie PDF. |
|
document_pages
|
document_pages | integer |
Łączna liczba stron dokumentu. |
|
uploaded_on
|
uploaded_on | date-time |
Data i godzina przekazania dokumentu. |
|
modified_on
|
modified_on | date-time |
Data i godzina ostatniej modyfikacji dokumentu. |
|
lock_form_fields
|
lock_form_fields | boolean |
Wartość True, jeśli jest włączone blokowanie pól formularza z ostatnim podpisem. |
|
Zaświadczam
|
certify | CertifyPermissionResponse | |
|
document_size
|
document_size | integer |
Rozmiar przekazanego dokumentu w bajtach |
|
metadane
|
metadata | UploadDocumentMetaInfoDetail | |
|
package_name
|
package_name | string |
Nazwa pakietu dokumentu |
CertifyPermissionResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
enabled
|
enabled | boolean |
Prawda, jeśli dla dokumentu włączono podpis certyfikowania. |
|
allowed_permissions
|
allowed_permissions | array of string |
Zestaw dozwolonych poziomów uprawnień certyfikacji dla dokumentu. |
|
default_permission
|
default_permission | string |
Wybrany poziom uprawnień dla ustawień sygnatury certyfikacji. |
UploadDocumentMetaInfoDetail
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
attachments
|
attachments | boolean |
wartość true, jeśli dokument pdf ma jakikolwiek załącznik |
|
form_fields
|
form_fields | boolean |
wartość true, jeśli dokument pdf ma jakiekolwiek pole formularza |
|
blank_signatures
|
blank_signatures | boolean |
wartość true, jeśli dokument pdf ma puste pole podpisu |
|
signed_signatures
|
signed_signatures | boolean |
wartość true, jeśli dokument pdf ma jakiekolwiek podpisane pole podpisu |
|
Zgodność
|
conformance | string |
null/empty, jeśli dokument nie zawiera żadnego poziomu zgodności, w przeciwnym razie zawiera tworzenie, takie jak 1A, 1B itp. |
|
zablokowany
|
locked | boolean |
wartość true, jeśli dokument pdf jest zablokowany |
|
Zaświadczam
|
certify | string |
CertifyLevel dokumentu pdf. Możliwe wartości NotCertified, NoChangesAllowed, FormFilling, FormFillingAndAnnotations |
|
qr_code
|
qr_code | boolean |
true, jeśli dokument pdf ma jakikolwiek kod Qr, w przeciwnym razie jego fałsz |
CertifyPolicyResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Zaświadczam
|
certify | CertifyPermissionResponse | |
|
lock_form_fields
|
lock_form_fields | boolean |
Wartość True, jeśli pola formularzy mają być zablokowane w pliku PDF po ostatnim podpisie cyfrowym w bieżącym dokumencie. |
WeryfikacjaResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
field_name
|
field_name | string |
Nazwa pola, dla którego zażądano weryfikacji. |
|
signer_name
|
signer_name | string |
Nazwa osoby podpisającego. |
|
signature_status
|
signature_status | string |
Jeśli ogólny stan podpisu jest prawidłowy lub nie. Możliwe wartości to "VALID" lub "INVALID". |
|
signing_reason
|
signing_reason | string |
Przyczyna podana przez użytkownika podczas podpisywania pola. W przypadku podpisywania monitora zostanie ustawiona niestandardowa przyczyna podpisywania |
|
signing_location
|
signing_location | string |
Lokalizacja wprowadzona przez użytkownika podczas podpisywania pola. |
|
contact_information
|
contact_information | string |
Informacje kontaktowe wprowadzone przez użytkownika podczas podpisywania pola. |
|
signing_time
|
signing_time | string |
Data i godzina logowania w formacie 8601. Domyślna strefa czasowa od administratora SH jest obserwowana przez czas. |
|
Ltv
|
ltv | boolean |
Prawda, jeśli podpis ma wartość LTV. |
|
Kwalifikowaną
|
qualified | boolean |
Prawda, jeśli podpisy są kwalifikowane. |
|
Certyfikowane
|
certified | boolean |
Prawda, jeśli podpisy są certyfikowane. |
|
certify_permission
|
certify_permission | string |
Poziom uprawnień dla certyfikowanego podpisu cyfrowego. |
|
timestamp_at
|
timestamp_at | string |
Data i godzina podpisania sygnatury czasowej. |
|
timestamp_authority
|
timestamp_authority | string |
Urząd, za pomocą którego sygnatura została sygnatura czasowa. |
|
subject_dn
|
subject_dn | string |
Nazwa wyróżniająca podmiotu z certyfikatu używanego podczas podpisywania pola. |
|
issuer_dn
|
issuer_dn | string |
Wystawcy DN z certyfikatu używanego podczas podpisywania pola. |
|
cert_valid_from
|
cert_valid_from | string |
Data i godzina, z której certyfikat jest prawidłowy. |
|
cert_valid_to
|
cert_valid_to | string |
Data i godzina ważności certyfikatu. |
|
signature_type
|
signature_type | string |
Typ podpisów, możliwe wartości to "PADES_PART2" lub "PADES_PART4". |
|
signature_algorithm
|
signature_algorithm | string |
Algorytm podpisu używany podczas podpisywania pola. |
|
signature_application
|
signature_application | string |
Nazwa aplikacji, z której zostało podpisane pole. |
|
signature_policy_id
|
signature_policy_id | integer |
Identyfikator zasad podpisu. |
|
signature_policy_uri
|
signature_policy_uri | string |
Identyfikator URI zasad sygnatury. |
|
signer_photo
|
signer_photo | string |
Obraz base64 awatara sygnatariusza. |
|
signer_photo_url
|
signer_photo_url | string | |
|
signed_hash
|
signed_hash | string |
Skrót dokumentu, który został podpisany w odpowiednim podpisie. |
|
wyświetlać
|
display | string | |
|
page_number
|
page_number | integer |
Numer strony pola podpisu |
|
lei_number
|
lei_number | string |
Numer LEI, jeśli jest dostępny w certyfikacie |
|
lei_role
|
lei_role | string |
Rola LEI, jeśli jest dostępna w certyfikacie |
|
Error_message
|
error_message | string |
W przypadku, gdy aplikacja nie może uzyskać wyników weryfikacji, zostanie zwrócony komunikat o błędzie. |
BulkSignResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
stan
|
status | string | |
|
identyfikator_transakcji
|
transaction_id | string |
BulkSignStatusResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
stan
|
status | string | |
|
packages
|
packages | array of BulkSignPackagesStatus |
BulkSignPackagesStatus
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer | |
|
nazwa
|
name | string | |
|
stan
|
status | string | |
|
akcja
|
action | string |
Wymagany klucz akcji, jeśli istnieje |
|
błąd
|
error | string | |
|
procent
|
percentage | integer | |
|
Dokumentów
|
documents | array of BulkSignActionDocumentModel |
Dokumenty w bieżącym pakiecie |
BulkSignActionDocumentModel
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer | |
|
pola
|
fields | array of BulkSignActionFieldModel |
BulkSignActionFieldModel
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string | |
|
skrót
|
hash | string | |
|
hashing_algo
|
hashing_algo | string |
SignDocumentResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
field_name
|
field_name | string |
Nazwa pola, dla którego zażądano weryfikacji. |
|
stan
|
status | string |
Zwraca stan pola podpisu. Wartości to SIGNED , PENDING (OCZEKUJĄCE). Stan pomaga w podpisywaniu zdalnego autoryzowanego podpisywania w usłudze eIDAS. Jeśli żądanie podpisania jest wysyłane do urządzenia przenośnego, stan jest oczekujący. |
|
identyfikator_transakcji
|
transaction_id | string |
Ten parametr jest używany podczas podpisywania RAS |
|
weryfikacja
|
verification | VerificationResponse | |
|
authentication_access_token
|
authentication_access_token | string |
Będzie on zawierać id_token OIDC podczas uwierzytelniania użytkownika za pośrednictwem OIDC |
AutoPlaceFieldsResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
field_name
|
field_name | string |
Nazwa pola, które zostało wygenerowane automatycznie przez interfejs API. |
ContactResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
identyfikator kontaktu. |
|
user_name
|
user_name | string |
Nazwa użytkownika kontaktu. |
|
user_email
|
user_email | string |
Adres e-mail kontaktu. |
|
mobile_number
|
mobile_number | string |
Numer telefonu komórkowego kontaktu. |
|
przedsiębiorstwo
|
enterprise | boolean |
Prawda, jeśli kontakt to przedsiębiorstwo. |
|
user_national_id
|
user_national_id | string |
Numer tożsamości krajowej kontaktu |
|
created_on
|
created_on | string |
Data/godzina dodania kontaktu. |
WorkSpaceMembers
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string |
Nazwa elementu członkowskiego obszaru roboczego |
|
e-mail
|
string |
Adres e-mail członka obszaru roboczego |
WorkSpaceResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Identyfikator przestrzeni udostępnionej |
|
nazwa
|
name | string |
Nazwa przestrzeni udostępnionej |
|
właściciel
|
owner | WorkSpaceOwner | |
|
Członkowie
|
members | array of WorkSpaceMembers |
Członkowie przestrzeni udostępnionej |
Właściciel obszaru roboczego
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string |
Nazwa właściciela obszaru roboczego |
|
e-mail
|
string |
Adres e-mail właściciela obszaru roboczego |
UploadDocumentLibraryResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
document_id
|
document_id | integer |
Identyfikator nowo utworzonego dokumentu. |
|
document_name
|
document_name | string |
Nazwa dokumentu. |
|
document_size
|
document_size | integer |
Rozmiar przekazanego dokumentu w bajtach |
|
document_order
|
document_order | integer |
Kolejność dokumentu |
|
document_type
|
document_type | string |
Typ dokumentu, np. "PDF". |
|
document_source
|
document_source | string |
Określa miejsce przekazania dokumentu, np. "Moja aplikacja". |
|
document_width
|
document_width | integer |
Szerokość dokumentu w formacie PDF. |
|
document_height
|
document_height | integer |
Wysokość dokumentu w formacie PDF. |
|
document_pages
|
document_pages | integer |
Łączna liczba stron dokumentu. |
|
uploaded_on
|
uploaded_on | date-time |
Data i godzina przekazania dokumentu. |
|
modified_on
|
modified_on | date-time |
Data i godzina ostatniej modyfikacji dokumentu. |
|
form_fields
|
form_fields | boolean |
Prawda, jeśli dokument ma pola formularza. |
|
lock_form_fields
|
lock_form_fields | boolean |
Wartość True, jeśli jest włączone blokowanie pól formularza z ostatnim podpisem. |
|
Zaświadczam
|
certify | UploadDocumentLibraryCertifyResponse | |
|
szablon
|
template | UploadDocumentLibraryTemplateResponse | |
|
package_name
|
package_name | string |
Nazwa pakietu |
|
metadane
|
metadata | UploadDocumentMetaInfoDetail |
UploadDocumentLibraryCertifyResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
enabled
|
enabled | boolean |
Prawda, jeśli dla dokumentu włączono podpis certyfikowania. |
|
allowed_permissions
|
allowed_permissions | array of string |
Zestaw dozwolonych poziomów uprawnień certyfikacji dla dokumentu. |
|
default_permission
|
default_permission | string |
Wybrany poziom uprawnień dla ustawień sygnatury certyfikacji. |
|
uprawnienie
|
permission | string |
Jest to uprawnienia do certyfikacji, które mają być stosowane w dokumencie PDF podczas tworzenia pierwszego podpisu. Możliwe wartości to "NO_CHANGES_ALLOWED", "FORM_FILLING_ALLOWED" i "FORM_FILLING_WITH_ANNOTATIONS_ALLOWED". |
UploadDocumentLibraryTemplateResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
template_name
|
template_name | string |
Nazwa szablonu zastosowanego w dokumencie. |
|
read_only
|
read_only | boolean |
Wartość True, jeśli zastosowany szablon jest tylko do odczytu. Użytkownik nie będzie mógł wprowadzać żadnych zmian w przypadku zastosowania szablonu tylko do odczytu. |
Przepływ pracyHistoryResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
package_id
|
package_id | integer |
Identyfikator pakietu, dla którego żądana jest historia przepływu pracy. |
|
package_name
|
package_name | string | |
|
package_owner
|
package_owner | string |
Adres e-mail właściciela pakietu. |
|
owner_name
|
owner_name | string |
Nazwa właściciela pakietu. |
|
package_status
|
package_status | string |
Stan pakietu/dokumentu z bieżącym zalogowanym użytkownikiem. Możliwe wartości to "DRAFT", "INPROGRESS", "PENDING", "DECLINED", "APPROVED", "UPDATED" lub "COMPLETED". |
|
next_signer
|
next_signer | string |
Nazwa następnego adresata. |
|
next_signer_email
|
next_signer_email | array of Next_signer_email |
Obiekt o nazwie i adresie e-mail następnego adresata. |
|
Dokumentów
|
documents | array of WorkflowDocumentsResponse | |
|
działania
|
actions | array of DocumentLogsActions |
DocumentLogsActions
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Log_id
|
log_id | integer |
Identyfikator akcji wykonanej w dokumencie. |
|
date_time
|
date_time | string |
Data i godzina wykonania akcji. |
|
action_type
|
action_type | string | |
|
user_email
|
user_email | string |
Adres e-mail użytkownika, który wykonał akcję. |
|
user_name
|
user_name | string |
Nazwa użytkownika, który wykonał akcję. |
|
enterprise_name
|
enterprise_name | string |
Nazwa przedsiębiorstwa, do której należy użytkownik. Jeśli użytkownik nie należy do przedsiębiorstwa, ten element nie jest obecny. |
|
informacje
|
information | DocumentLogsActionsInformation |
DocumentLogsActionsInformation
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
typ
|
type | string |
Typ dodatkowych informacji o akcji, np. "SIGNING_METHOD", co oznacza, jaki użytkownik metody podpisywania użył do podpisania dokumentu. |
|
wartość
|
value | string |
Wartość dodatkowych informacji o akcji, np. "LOCAL", co oznacza, że użytkownik podpisał dokument przy użyciu poświadczeń przechowywanych lokalnie. |
UpdateCollaboratorResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
user_email
|
user_email | string |
Adres e-mail użytkownika |
|
signing_order
|
signing_order | integer |
Kolejność podpisywania |
|
guest_user
|
guest_user | boolean |
Czy użytkownik-gość |
|
email_language_code
|
email_language_code | string |
Kod języka poczty e-mail |
WspółpracownikGroupResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
uprawnienie
|
permission | WorkflowPermissionResponse | |
|
Przypomnienie
|
reminder | ReminderResponse | |
|
signing_order
|
signing_order | integer |
Kolejność podpisywania |
WspółpracownikPlaceholderResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
uprawnienie
|
permission | WorkflowPermissionResponse | |
|
Przypomnienie
|
reminder | ReminderResponse | |
|
signing_order
|
signing_order | integer |
Kolejność podpisywania |
PolaResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
podpis
|
signature | array of DigitalSignatureFieldResponse |
Lista wszystkich podpisów cyfrowych w dokumencie. |
|
hand_signature
|
hand_signature | array of HandSignatureFieldResponse | |
|
electronic_signature
|
electronic_signature | array of ElectronicSignatureFieldResponse | |
|
inicjały
|
initials | array of InitialFieldResponse | |
|
in_person_signature
|
in_person_signature | array of object | |
|
items
|
in_person_signature | object | |
|
SMS
|
text | array of TextFieldResponse | |
|
radio
|
radio | array of RadioFieldResponse | |
|
Checkbox
|
checkbox | array of CheckboxFieldResponse | |
|
lista rozwijana
|
dropdown | array of DropdownFieldResponse | |
|
Listbox
|
listbox | array of ListBoxFieldResponse | |
|
qrcode
|
qrcode | array of QrCodeResponse | |
|
załącznik
|
attachment | array of AttachmentFieldResponse | |
|
komentarz
|
comment | array of CommentFieldResponse | |
|
unique_identifier
|
unique_identifier | array of UniqueIdentifierFieldResponse |
DigitalSignatureFieldResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
porządek
|
order | integer |
Kolejność adresata, do którego przypisano to pole. Jeśli pole nie zostanie przypisane do nikogo, wartość będzie mieć wartość null. |
|
display_order
|
display_order | integer |
Wyświetl kolejność zgodnie z przeglądarką SigningHub. |
|
field_name
|
field_name | string |
Unikatowy identyfikator pola. |
|
page_no
|
page_no | integer |
Numer strony dokumentu, na którym istnieje pole. |
|
Osadzone
|
embedded | boolean |
Prawda, jeśli pole jest częścią dokumentu PDF. |
|
typ
|
type | string |
Jeśli pole jest przypisane lub nie, możliwe wartości to ASSIGNED, UN_ASSIGNED, SIGNED, LOGGED_IN_USER, HIDDEN i PLACEHOLDER. |
|
process_status
|
process_status | string |
Czy pole jest przetwarzane, czy nie. Możliwe wartości są UN_PROCESSED, PRZETWORZONE. |
|
processed_on
|
processed_on | string |
Data i godzina przetworzenia dokumentu. |
|
processed_as
|
processed_as | string |
Użytkownik, który przetworzył pole jako WSPÓŁPRACOWNIK, DELEGAT, GROUP_MEMBER lub WŁAŚCICIEL. |
|
created_on
|
created_on | string |
Data i godzina dodania pola |
|
processed_by
|
processed_by | string |
Adres e-mail użytkownika, który przetworzył pole. |
|
dimensions
|
dimensions | FieldDimenssionResponse | |
|
weryfikacja
|
verification | VerificationResponse | |
|
Nid
|
nid | string | |
|
wyświetlać
|
display | string |
Zwraca wartość widoczności pola podpisu cyfrowego, możliwe wartości to "VISIBLE" i "INVISIBLE". |
|
level_of_assurance
|
level_of_assurance | array of string | |
|
uwierzytelnianie
|
authentication | FieldAuthentication |
FieldDimenssionResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
pole
|
field | FieldResponse | |
|
page
|
page | PageResponse |
FieldResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
x
|
x | double |
Lewa lokalizacja pola w pikselach. |
|
y
|
y | double |
Górna lokalizacja pola w pikselach. |
|
width
|
width | double |
Szerokość pola w pikselach. |
|
height
|
height | double |
Wysokość pola w pikselach. |
PageResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
width
|
width | float |
Szerokość strony, na której pole jest umieszczane w pliku PDF. |
|
height
|
height | float |
Wysokość strony, na której znajduje się pole w pliku PDF. |
FieldAuthentication
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
enabled
|
enabled | boolean |
Prawda, jeśli uwierzytelnianie jest włączone dla pól podpisu elektronicznego. |
|
sms_otp
|
sms_otp | AccessSecuritySmsOtpResponse | |
|
Totp
|
totp | AccessSecurityTOTPResponse |
AccessSecurityTOTPResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
enabled
|
enabled | boolean |
Prawda, jeśli dla pakietu jest włączone uwierzytelnianie TOTP. |
HandSignatureFieldResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
porządek
|
order | integer |
Kolejność adresata, do którego przypisano to pole. Jeśli pole nie zostanie przypisane do nikogo, wartość będzie mieć wartość null. |
|
display_order
|
display_order | integer |
Wyświetl kolejność zgodnie z przeglądarką SigningHub. |
|
field_name
|
field_name | string |
Unikatowy identyfikator pola. |
|
page_no
|
page_no | integer |
Numer strony dokumentu, na którym istnieje pole. |
|
Osadzone
|
embedded | boolean |
Prawda, jeśli pole jest częścią dokumentu PDF. |
|
typ
|
type | string |
Jeśli pole jest przypisane lub nie, możliwe wartości to ASSIGNED, UN_ASSIGNED, SIGNED, LOGGED_IN_USER, HIDDEN i PLACEHOLDER. |
|
process_status
|
process_status | string |
Czy pole jest przetwarzane, czy nie. Możliwe wartości są UN_PROCESSED, PRZETWORZONE. |
|
processed_on
|
processed_on | string |
Data i godzina przetworzenia dokumentu. |
|
processed_as
|
processed_as | string |
Użytkownik, który przetworzył pole jako WSPÓŁPRACOWNIK, DELEGATE, GROUP_MEMBER lub WŁAŚCICIEL. |
|
processed_by
|
processed_by | string |
Adres e-mail użytkownika, który przetworzył pole. |
|
dimensions
|
dimensions | FieldDimenssionResponse | |
|
Nid
|
nid | string |
ElectronicSignatureFieldResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
porządek
|
order | integer |
Adres e-mail użytkownika, który przetworzył pole. |
|
display_order
|
display_order | integer |
Wyświetl kolejność zgodnie z przeglądarką SigningHub. |
|
field_name
|
field_name | string |
Unikatowy identyfikator pola. |
|
page_no
|
page_no | integer |
Numer strony dokumentu, na którym istnieje pole. |
|
Osadzone
|
embedded | boolean |
Prawda, jeśli pole jest częścią dokumentu PDF. |
|
typ
|
type | string |
Jeśli pole jest przypisane lub nie, możliwe wartości to ASSIGNED, UN_ASSIGNED, SIGNED, LOGGED_IN_USER, HIDDEN i PLACEHOLDER. |
|
process_status
|
process_status | string |
Czy pole jest przetwarzane, czy nie. Możliwe wartości są UN_PROCESSED, PRZETWORZONE. |
|
processed_on
|
processed_on | string |
Data i godzina przetworzenia dokumentu. |
|
processed_as
|
processed_as | string |
Użytkownik, który przetworzył pole jako WSPÓŁPRACOWNIK, DELEGATE, GROUP_MEMBER lub WŁAŚCICIEL. |
|
processed_by
|
processed_by | string |
Adres e-mail użytkownika, który przetworzył pole. |
|
dimensions
|
dimensions | FieldDimenssionResponse | |
|
signature_sub_type
|
signature_sub_type | string |
Podtyp podpisu może być podpisem MONITORa. Jeśli podpisy monitora są włączone w planie usługi, pola E-Signature są podpisane przy użyciu wspólnego certyfikatu współużytkowanego przez wszystkich użytkowników w planie usługi. Możliwe wartości to MONITOR lub NONE. |
|
uwierzytelnianie
|
authentication | FieldAuthentication | |
|
weryfikacja
|
verification | VerificationResponse | |
|
Nid
|
nid | string | |
|
wyświetlać
|
display | string |
Zwraca wartość widoczności pola podpisu elektronicznego, możliwe wartości to "VISIBLE" i "INVISIBLE". |
InitialFieldResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
porządek
|
order | integer |
Kolejność adresata, do którego przypisano to pole. Jeśli pole nie zostanie przypisane do nikogo, wartość będzie mieć wartość null. |
|
display_order
|
display_order | integer |
Wyświetl kolejność zgodnie z przeglądarką SigningHub. |
|
field_name
|
field_name | string |
Unikatowy identyfikator pola. |
|
page_no
|
page_no | integer |
Numer strony dokumentu, na którym istnieje pole. |
|
process_status
|
process_status | string |
Czy pole jest przetwarzane, czy nie. Możliwe wartości są UN_PROCESSED, PRZETWORZONE. |
|
processed_on
|
processed_on | string |
Data i godzina przetworzenia dokumentu. |
|
processed_as
|
processed_as | string |
Użytkownik, który przetworzył pole jako WSPÓŁPRACOWNIK, DELEGATE, GROUP_MEMBER lub WŁAŚCICIEL. |
|
processed_by
|
processed_by | string |
Adres e-mail użytkownika, który przetworzył pole. |
|
dimensions
|
dimensions | FieldDimenssionResponse | |
|
Osadzone
|
embedded | boolean |
Prawda, jeśli pole jest częścią dokumentu PDF. |
TextFieldResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
required
|
required | boolean |
Prawda, jeśli pole jest wymagane w pliku PDF |
|
porządek
|
order | integer |
Kolejność adresata, do którego przypisano to pole. Jeśli pole nie zostanie przypisane do nikogo, wartość będzie mieć wartość null. |
|
tab_order
|
tab_order | integer |
Kolejność tabulacji w dokumencie PDF |
|
display_order
|
display_order | integer |
Wyświetl kolejność zgodnie z przeglądarką SigningHub. |
|
field_name
|
field_name | string |
Unikatowy identyfikator pola. |
|
page_no
|
page_no | integer |
Numer strony dokumentu, na którym istnieje pole. |
|
Osadzone
|
embedded | boolean |
Prawda, jeśli pole jest częścią dokumentu PDF. |
|
typ
|
type | string |
Typ pola tekstowego, możliwe wartości to "TEXT", "NAME", "COMPANY", "JOBTITLE", "EMAIL", "DATE". |
|
wartość
|
value | string |
Wartość pola. Dla typu = DATE lub format_type = DATE, oczekiwana wartość ma być zgodne z formatem ISO 8601. Zgodnie z formatem RRRR-MM-DD hh:mm:ss +00. Ponieważ wartości dotyczą pól daty, aplikacje klienckie mogą wysyłaćMM-DD RRRR- i ignorować hh:mm:ss +00. Jeśli wartość nie jest w odpowiednim formacie, zostanie zwrócony błąd. |
|
read_only
|
read_only | boolean |
Prawda, jeśli pole jest oznaczone jako tylko do odczytu w dokumencie PDF. |
|
validation_rule
|
validation_rule | string |
Co najmniej jedna reguła sprawdzania poprawności pól, możliwe wartości to "OBOWIĄZKOWE" lub "OPCJONALNE". |
|
sprawdzanie poprawności
|
validation | FieldValidationValue | |
|
widoczny
|
visible | boolean |
Prawda, jeśli pole nie jest ukryte w dokumencie PDF. |
|
wielowierszowy
|
multiline | boolean |
Prawda, jeśli pole jest wielowierszowe w dokumencie PDF. |
|
font
|
font | FontResponse | |
|
max_length
|
max_length | integer |
Maksymalna długość zawartości może być wypełniona w polu. |
|
format_type
|
format_type | string |
Jeśli pole jest polem tekstowym, może być zgodne z różnymi typami danych wejściowych. Możliwe wartości to ALPHANUMERIC, NUMBER, TEXT, EMAIL, TIME lub DATE. |
|
symbol zastępczy
|
placeholder | string |
Tekst zastępczy pola tekstowego. |
|
format
|
format | string |
Format tekstowy pola. Używane tylko dla pola typu daty. Możliwe wartości to
|
|
color
|
color | string |
Kolor tekstu w polach formularza. |
|
kolor_obramowania
|
border_color | string |
Kolor obramowania pola formularza. |
|
etykietka narzędzia
|
tooltip | string |
etykietka narzędzia pola formularza. |
|
field_rotation
|
field_rotation | integer |
Rotacja pól |
|
wyrównać
|
align | string |
Wyrównanie tekstu dla pola formularza. Możliwe wartości to "RIGHT", "LEFT", "CENTER" lub "JUSTIFY" |
|
dimensions
|
dimensions | FieldDimenssionResponse |
RadioFieldResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
required
|
required | boolean |
Prawda, jeśli pole jest wymagane w pliku PDF |
|
porządek
|
order | integer |
Kolejność adresata, do którego przypisano to pole. Jeśli pole nie zostanie przypisane do nikogo, wartość będzie mieć wartość null. |
|
tab_order
|
tab_order | integer |
Kolejność tabulacji w dokumencie PDF. |
|
display_order
|
display_order | integer |
Wyświetl kolejność zgodnie z przeglądarką SigningHub. |
|
field_name
|
field_name | string |
Unikatowy identyfikator pola. |
|
page_no
|
page_no | integer |
Numer strony dokumentu, na którym istnieje pole. |
|
Osadzone
|
embedded | boolean |
Prawda, jeśli pole jest częścią dokumentu PDF. |
|
typ
|
type | string | |
|
wartość
|
value | boolean |
Wartość pola. |
|
read_only
|
read_only | boolean |
Prawda, jeśli pole jest oznaczone jako przeczytane w dokumencie PDF. |
|
validation_rule
|
validation_rule | string |
Co najmniej jedna reguła sprawdzania poprawności możliwych wartości pól to "OBOWIĄZKOWE" lub "OPCJONALNE". |
|
radio_group_name
|
radio_group_name | string |
Nazwa grupy, do której należy pole. |
|
sprawdzony
|
checked | boolean |
Prawda, jeśli pole jest zaznaczone |
|
widoczny
|
visible | boolean |
Wartość True, jeśli pole nie jest ukryte w dokumencie PDF. |
|
dimensions
|
dimensions | FieldDimenssionResponse | |
|
color
|
color | string |
Kolor tekstu w polach formularza. |
|
kolor_obramowania
|
border_color | string |
Kolor obramowania pola formularza. |
|
etykietka narzędzia
|
tooltip | string |
etykietka narzędzia pola formularza. |
|
field_rotation
|
field_rotation | integer |
Rotacja pól |
Pole wyboruFieldResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
required
|
required | boolean |
Prawda, jeśli pole jest wymagane w pliku PDF |
|
porządek
|
order | integer |
Kolejność adresata, do którego przypisano to pole. Jeśli pole nie zostanie przypisane do nikogo, wartość będzie mieć wartość null. |
|
tab_order
|
tab_order | integer |
Kolejność tabulacji w dokumencie PDF |
|
display_order
|
display_order | integer |
Wyświetl kolejność zgodnie z przeglądarką SigningHub. |
|
field_name
|
field_name | string |
Unikatowy identyfikator pola. |
|
page_no
|
page_no | integer |
Numer strony dokumentu, na którym istnieje pole. |
|
Osadzone
|
embedded | boolean |
Prawda, jeśli pole jest częścią dokumentu PDF. |
|
typ
|
type | string | |
|
wartość
|
value | boolean |
Wartość pola. |
|
read_only
|
read_only | boolean |
Prawda, jeśli pole jest oznaczone jako tylko do odczytu w dokumencie PDF. |
|
sprawdzony
|
checked | boolean |
Wartość True, jeśli pole jest zaznaczone. |
|
widoczny
|
visible | boolean |
Wartość True, jeśli pole nie jest ukryte w dokumencie PDF. |
|
validation_rule
|
validation_rule | string |
Co najmniej jedna reguła sprawdzania poprawności możliwych wartości pól to "OBOWIĄZKOWE" lub "OPCJONALNE". |
|
dimensions
|
dimensions | FieldDimenssionResponse | |
|
color
|
color | string |
Kolor tekstu w polach formularza. |
|
kolor_obramowania
|
border_color | string |
Kolor obramowania pola formularza. |
|
etykietka narzędzia
|
tooltip | string |
etykietka narzędzia pola formularza. |
|
field_rotation
|
field_rotation | integer |
Rotacja pól |
Lista rozwijanaFieldResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
required
|
required | boolean |
Prawda, jeśli pole jest wymagane w pliku PDF |
|
porządek
|
order | integer |
Kolejność adresata, do którego przypisano to pole. Jeśli pole nie zostanie przypisane do nikogo, wartość będzie mieć wartość null. |
|
tab_order
|
tab_order | integer |
Kolejność tabulacji w dokumencie PDF. |
|
display_order
|
display_order | integer |
Wyświetl kolejność zgodnie z przeglądarką SigningHub. |
|
field_name
|
field_name | string |
Unikatowy identyfikator pola. |
|
page_no
|
page_no | integer |
Numer strony dokumentu, na którym istnieje pole. |
|
Osadzone
|
embedded | boolean |
Prawda, jeśli pole jest częścią dokumentu PDF. |
|
validation_rule
|
validation_rule | string |
Co najmniej jedna reguła sprawdzania poprawności możliwych wartości pól to "OBOWIĄZKOWE" lub "OPCJONALNE". |
|
read_only
|
read_only | boolean |
Prawda, jeśli pole jest oznaczone jako tylko do odczytu w dokumencie PDF. |
|
wartość
|
value | string |
Wartość pola . |
|
choices
|
choices | array of string |
Opcje dostępne dla listy rozwijanej, z których można wybrać wartość. |
|
widoczny
|
visible | boolean |
Prawda, jeśli pole nie jest ukryte w dokumencie PDF. |
|
dimensions
|
dimensions | FieldDimenssionResponse | |
|
font
|
font | FontResponse | |
|
color
|
color | string |
Kolor tekstu w polach formularza. |
|
kolor_obramowania
|
border_color | string |
Kolor obramowania pola formularza. |
|
etykietka narzędzia
|
tooltip | string |
etykietka narzędzia pola formularza. |
|
field_rotation
|
field_rotation | integer |
Rotacja pól |
ListBoxFieldResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
porządek
|
order | integer |
Kolejność adresata, do którego przypisano to pole. Jeśli pole nie zostanie przypisane do nikogo, wartość będzie mieć wartość null. |
|
tab_order
|
tab_order | integer |
Kolejność tabulacji w dokumencie PDF. |
|
display_order
|
display_order | integer |
Wyświetl kolejność zgodnie z przeglądarką SigningHub. |
|
field_name
|
field_name | string |
Unikatowy identyfikator pola. |
|
page_no
|
page_no | integer |
Numer strony dokumentu, na którym istnieje pole. |
|
Osadzone
|
embedded | boolean |
Prawda, jeśli pole jest częścią dokumentu PDF. |
|
validation_rule
|
validation_rule | string |
Co najmniej jedna reguła sprawdzania poprawności możliwych wartości pól to "OBOWIĄZKOWE" lub "OPCJONALNE". |
|
read_only
|
read_only | boolean |
Prawda, jeśli pole jest oznaczone jako tylko do odczytu w dokumencie PDF. |
|
wartość
|
value | string |
Wartość pola. |
|
choices
|
choices | array of string |
Opcje dostępne dla listy rozwijanej, z których można wybrać wartość. |
|
widoczny
|
visible | boolean |
Prawda, jeśli pole nie jest ukryte w dokumencie PDF. |
|
dimensions
|
dimensions | FieldDimenssionResponse | |
|
font
|
font | FontResponse | |
|
color
|
color | string |
Kolor tekstu w polach formularza. |
|
kolor_obramowania
|
border_color | string |
Kolor obramowania pola formularza. |
|
etykietka narzędzia
|
tooltip | string |
etykietka narzędzia pola formularza. |
|
field_rotation
|
field_rotation | integer |
Rotacja pól |
FontResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string |
Nazwa czcionki pola tekstowego. W przypadku pól zdefiniowanych przez użytkownika usługa SigningHub obsługuje tylko "COURIER", "HELVETICA". W przypadku istniejących pól w pliku PDF wartość czcionki może być niczym ustawionym w pliku PDF. |
|
size
|
size | integer |
Rozmiar czcionki dla pola tekstowego. |
|
embedded_size
|
embedded_size | double |
Rozmiar czcionki w oryginalnym dokumencie PDF. |
QrCodeResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
field_name
|
field_name | string |
Unikatowy identyfikator pola. |
|
typ
|
type | string |
Typ pola PDF_FIELD_TYPE, taki jak QR |
|
page_no
|
page_no | integer |
Numer strony dokumentu, na którym istnieje pole. |
|
wartość
|
value | string |
Kod QrCode wygenerowany base64 zostanie udostępniony w trybie roboczym |
|
dimensions
|
dimensions | FieldDimenssionResponse | |
|
dane
|
data | string |
Dane zwykłego tekstu, które mają być zakodowane w kodzie QR. Wartość domyślna to adres URL wygenerowany w celu uzyskania dostępu do powiązanego dokumentu. np. {base_url}/document/{document_unique_id} |
|
options
|
options | QrCodeOptions | |
|
color
|
color | QrCodeColor | |
|
logo
|
logo | QrCodeLogo |
AttachmentFieldResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
porządek
|
order | integer |
Kolejność adresata, do którego przypisano to pole. |
|
display_order
|
display_order | integer |
Wyświetl kolejność zgodnie z przeglądarką SigningHub. |
|
field_name
|
field_name | string |
Unikatowy identyfikator pola. |
|
page_no
|
page_no | integer |
Numer strony dokumentu, na którym istnieje pole. |
|
process_status
|
process_status | string |
Czy pole jest przetwarzane, czy nie. Możliwe wartości są UN_PROCESSED, PRZETWORZONE. |
|
processed_on
|
processed_on | string |
Data i godzina przetworzenia dokumentu. |
|
processed_as
|
processed_as | string |
Użytkownik, który przetworzył pole jako WSPÓŁPRACOWNIK, DELEGATE, GROUP_MEMBER lub WŁAŚCICIEL. |
|
processed_by
|
processed_by | string |
Adres e-mail użytkownika, który przetworzył pole. |
|
attachmentRefId
|
attachmentRefId | integer |
Identyfikator ref attachmet |
|
notatka
|
note | string |
Uwaga attachmet tylko w przypadku reguły załącznika "OBOWIĄZKOWE" |
|
validation_rule
|
validation_rule | ValidationRule |
Co najmniej jedna reguła sprawdzania poprawności możliwych wartości pól to "OBOWIĄZKOWE" lub "OPCJONALNE". |
|
dimensions
|
dimensions | FieldDimenssionResponse |
CommentFieldResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Identyfikator pola komentarza |
|
page_no
|
page_no | integer |
Numer strony dokumentu, na którym istnieje pole. |
|
unread_count
|
unread_count | integer |
Nieprzeczytane komentarze |
|
prywatny
|
private | boolean |
Prywatne |
|
recipients
|
recipients | array of CommentFieldRecipientResponse |
Adresatów |
|
dimensions
|
dimensions | FieldDimenssionResponse |
UniqueIdentifierFieldResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
field_name
|
field_name | string |
Unikatowy identyfikator pola. |
|
wartość
|
value | string |
Wartość pola. |
|
page_no
|
page_no | integer |
Numer strony dokumentu, na którym istnieje pole. |
|
font
|
font | FontResponse | |
|
dimensions
|
dimensions | FieldDimenssionResponse |
CommentFieldRecipientResponse
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
user_name
|
user_name | string |
Nazwa użytkownika |
|
user_email
|
user_email | string |
Adres e-mail użytkownika |
obiekt
Jest to typ "object".