Zaloguj się do Adobe Sign jako administrator.
Nowości
Pierwsze kroki
- Skrócona instrukcja dla administratorów
- Skrócona instrukcja dla użytkowników
- Dla programistów
- Biblioteka samouczków wideo
- Często zadawane pytania
Administrowanie
- Przegląd Admin Console
- Zarządzanie użytkownikami
- Dodawanie użytkowników
- Tworzenie użytkowników w oparciu o funkcje
- Sprawdzanie pod kątem użytkowników z błędami obsługi
- Zmiana nazwiska/adresu e-mail
- Edytowanie członkostwa użytkownika w grupie
- Edytowanie członkostwa użytkownika w grupie za pomocą interfejsu grupy
- Awansowanie użytkownika do roli administratora
- Typy identyfikatorów użytkowników i SSO
- Przełączanie tożsamości użytkownika
- Uwierzytelnianie użytkowników z użyciem usługi MS Azure
- Uwierzytelnianie użytkowników z użyciem usługi Google Federation
- Profile produktowe
- Funkcja logowania
- Ustawienia konta/grupy
- Przegląd ustawień
- Ustawienia globalne
- Poziom i identyfikator konta
- Nowy interfejs odbiorcy
- Obiegi pracy samodzielnego podpisywania
- Wysyłka zbiorcza
- Formularze internetowe
- Niestandardowe obiegi pracy wysyłania
- Obiegi pracy Power Automate
- Dokumenty w bibliotece
- Zbieranie danych formularzy za pomocą umów
- Ograniczona widoczność dokumentu
- Załączanie kopii PDF podpisanej umowy
- Dołączanie łączy do wiadomości e-mail
- Dołączanie obrazu do wiadomości e-mail
- Pliki dołączone do wiadomości e-mail będą nazwane jako:
- Załączanie raportu kontroli do dokumentów
- Scalanie wielu dokumentów w jeden
- Pobierz pojedyncze dokumenty
- Przekaż podpisany dokument
- Delegacje dla użytkowników w moim koncie
- Zezwalanie odbiorcom zewnętrznym na delegowanie
- Upoważnienie do podpisania
- Upoważnienie do wysyłania
- Uprawnienia do dodawania pieczęci elektronicznych
- Ustawianie domyślnej strefy czasowej
- Ustawianie domyślnego formatu daty
- Użytkownicy w wielu grupach (UMG)
- Uprawnienia administratora grupy
- Zastępowanie odbiorcy
- Raport kontroli
- Stopka transakcji
- W komunikatach w produkcie i wskazówkach
- Przystępne pliki PDF
- Nowy sposób tworzenia
- Klient z sektora opieki zdrowotnej
- Konfiguracja konta
- Dodawanie logo
- Dostosowywanie nazwy hosta / adresu URL firmy
- Dodawanie nazwy firmy
- Przekierowanie adresu URL po umowie
- Preferencje dotyczące podpisu
- Dobrze sformatowane podpisy
- Zezwalanie odbiorcom na podpisywanie przez
- Sygnatariusze mogą zmieniać imiona i nazwiska
- Zezwalanie odbiorcom na korzystanie z zapisanych podpisów
- Niestandardowe warunki użytkowania i warunki ujawnienia danych klienta
- Prowadzenie odbiorców między polami formularza
- Ponowne uruchamianie obiegu pracy umowy
- Odmowa podpisania
- Zezwalanie na obiegi pracy stempli
- Wymaganie od sygnatariuszy podania stanowiska lub firmy
- Zezwalanie sygnatariuszom na wydrukowanie i złożenie podpisu pisemnego
- Pokazanie wiadomości podczas składania elektronicznego podpisu
- Wymaganie tworzenia przez sygnatariuszy podpisów za pomocą urządzenia mobilnego
- Prośba sygnatariuszy o adres IP
- Wykluczanie nazwy firmy i stanowiska w stemplach uczestnictwa
- Podpisy cyfrowe
- Pieczęcie elektroniczne
- Tożsamość cyfrowa
- Ustawienia raportu
- Nowy sposób raportowania
- Klasyczne ustawienia raportu
- Ustawienia zabezpieczeń
- Ustawienia pojedynczego logowania
- Ustawienia opcji Pamiętaj mnie
- Zasady dotyczące hasła logowania
- Siła hasła logowania
- Czas trwania sesji internetowej
- Typ szyfrowania PDF
- API
- Dostęp do informacji o użytkowniku i grupie
- Dozwolone zakresy IP
- Udostępnianie konta
- Zezwolenia na udostępnianie konta
- Ustawienia udostępniania umów
- Weryfikacja tożsamości sygnatariusza
- Hasło podpisywania umowy
- Siła hasła dokumentu
- Blokowanie sygnatariuszy według geolokalizacji
- Uwierzytelnianie telefoniczne
- Uwierzytelnianie oparte na wiedzy (KBA)
- Zezwalanie na wyodrębnianie stron
- Wygaśnięcie łącza dokumentu
- Przesłanie certyfikatu klienta dla elementów webhook / wywołań zwrotnych
- Znacznik czasowy
- Ustawienia wysyłania
- Wyświetlanie strony Wyślij po zalogowaniu
- Wymaganie nazwy odbiorcy przy wysyłaniu
- Blokowanie wartości nazw dla znanych użytkowników
- Dozwolone role odbiorcy
- Zezwól na e-osoby poświadczające
- Grupy odbiorców
- DW
- Dostęp do umowy odbiorcy
- Wymagane pola
- Załączanie dokumentów
- Spłaszczenie pola
- Modyfikowanie umowy
- Nazwa umowy
- Języki
- Wiadomości prywatne
- Dopuszczalne typy podpisu
- Przypomnienia
- Zabezpieczenie hasłem podpisanego dokumentu
- Wysyłanie powiadomień o umowie za pośrednictwem
- Opcje identyfikacji sygnatariusza
- Ochrona zawartości
- Włączanie transakcji Notarize
- Wygasanie dokumentu
- Wyświetlanie, ustawianie podpisów i dodawanie pól formularza
- Kolejność podpisywania
- Liquid Mode
- Niestandardowe elementy sterujące obiegiem pracy
- Opcje przesyłania na stronie podpisu elektronicznego
- Przekierowanie na inny adres URL potwierdzenia po podpisaniu
- Szablony wiadomości
- Ustawienia Bio-Pharma
- Integracja obiegu pracy
- Ustawienia notarializacji
- Integracja płatności
- Wiadomości sygnatariusza
- Ustawienia SAML
- Konfiguracja SAML
- Instalacja usługi federacyjnej Microsoft Active Directory
- Instalacja usługi Okta
- Instalacja usługi OneLogin
- Instalacja usługi Oracle Identity Federation
- Konfiguracja SAML
- Zarządzanie danymi
- Ustawienia znacznika czasowego
- Archiwum zewnętrzne
- Języki konta
- Ustawienia poczty e-mail
- Migracja z domeny echosign.com do adobesign.com
- Konfiguracja opcji dla odbiorców
- Wytyczne dotyczące wymogów regulacyjnych
- Dostępność
- HIPAA
- RODO
- 21 CFR część 11 i załącznik 11 EudraLex
- Klienci z sektora opieki zdrowotnej
- Obsługa IVES
- Umowy „archiwizowane”
- Kwestie do rozważenia w UE/Wielkiej Brytanii
- Zbiorcze pobieranie umów
- Przypisywanie domeny
- Łącza zgłaszania nadużycia
Wysyłanie i podpisywanie umów oraz zarządzanie nimi
- Opcje odbiorcy
- Anulowanie przypomnienia e-mail
- Opcje na stronie podpisu elektronicznego
- Przegląd strony podpisu elektronicznego
- Otwieranie w celu przeczytania umowy bez pól
- Odmowa podpisania umowy
- Delegowanie uprawnienia do podpisywania
- Ponowne uruchamianie umowy
- Pobieranie pliku PDF umowy
- Wyświetlanie historii umowy
- Wyświetlanie wiadomości umowy
- Konwertowanie z podpisu elektronicznego na pisemny
- Konwertowanie z podpisu pisemnego na podpis elektroniczny
- Nawigowanie po polach formularza
- Czyszczenie danych z pól formularza
- Powiększenie strony podpisu elektronicznego i nawigacja po niej
- Zmiana języka używanego w narzędziach i informacjach dotyczących umowy
- Przegląd informacji prawnych
- Dostosowywanie preferencji plików cookie Acrobat Sign
- Wysyłanie umów
- Tworzenie pól w dokumentach
- Środowisko tworzenia w aplikacji
- Automatyczne wykrywanie pól
- Przeciąganie i upuszczanie pól za pomocą środowiska tworzenia
- Przypisywanie pól formularza do odbiorców
- Rola Wstępne wypełnianie
- Stosowanie pól z szablonem pola wielokrotnego użytku
- Przenoszenie pól do nowego szablonu biblioteki
- Zaktualizowano środowisko tworzenia podczas wysyłania umów
- Tworzenie formularzy ze znacznikami tekstowymi
- Tworzenie formularzy przy pomocy programu Acrobat (AcroForm)
- Pola
- Tworzenie często zadawanych pytań
- Środowisko tworzenia w aplikacji
- Podpisywanie umów
- Zarządzaj umowami
- Omówienie strony Zarządzaj
- Delegowanie umowy
- Zastępowanie odbiorców
- Ograniczona widoczność dokumentu
- Anulowanie umowy
- Tworzenie nowych przypomnień
- Przeglądanie przypomnień
- Anulowanie przypomnienia
- Dostęp do obiegów Power Automate
- Więcej operacji…
- Działanie wyszukiwania
- Wyświetlanie umowy
- Tworzenie szablonu na podstawie umowy
- Ukrywanie/pokazywanie umów z widoku
- Przesyłanie podpisanej umowy
- Modyfikowanie plików i pól w wysłanych umowach
- Edytowanie sposobu uwierzytelniania odbiorcy
- Dodawanie lub modyfikacja daty wygaśnięcia
- Dodawanie uwagi do umowy
- Udostępnianie indywidualnej umowy
- Anulowanie udostępniania umowy
- Pobieranie poszczególnych umów
- Pobieranie pojedynczych plików umowy
- Pobieranie raportu kontroli dla umowy
- Pobieranie zawartości pola w umowie
- Raport kontroli
- Raportowanie i eksportowanie danych
- Omówienie
- Udzielanie użytkownikom dostępu do raportowania
- Wykresy raportu
- Eksport danych
- Zmiana nazwy raportu/eksportu
- Powielanie raportu/eksportu
- Planowanie raportu/eksportu
- Usuwanie raportu/eksportu
- Sprawdzanie użycia transakcji
Zaawansowane możliwości umów i obiegów pracy
- Formularze internetowe
- Tworzenie formularza internetowego
- Edycja formularza internetowego
- Wyłączanie/włączanie formularza internetowego
- Ukrywanie/pokazywanie formularza internetowego
- Znajdowanie adresu URL lub kodu skryptu
- Wstępne wypełnianie pól formularza internetowego przy użyciu parametrów adresu URL
- Zapisywanie formularza internetowego do późniejszego wypełnienia
- Zmiana rozmiaru formularza internetowego
- Szablony wielokrotnego użytku (Szablony biblioteki)
- Amerykańskie formularze urzędowe w bibliotece Acrobat Sign
- Tworzenie szablonu biblioteki
- Zmiana nazwy szablonu biblioteki
- Zmiana typu szablonu biblioteki
- Zmiana poziomu uprawnień szablonu biblioteki
- Kopiowanie, edytowanie i zapisywanie udostępnionego szablonu
- Pobieranie zagregowanych danych pól szablonu biblioteki
- Przenoszenie własności formularzy internetowych i szablonów bibliotek
- Obiegi pracy Power Automate
- Przegląd integracji Power Automate i dołączonych uprawnień
- Włączanie integracji usługi Power Automate
- Akcje kontekstowe na stronie Zarządzaj
- Śledzenie wykorzystania pakietu Power Automate
- Tworzenie nowego obiegu (przykłady)
- Aktywatory używane dla obiegów
- Importowanie obiegów spoza Acrobat Sign
- Zarządzanie obiegami
- Edycja obiegów
- Udostępnianie obiegów
- Wyłączanie lub włączanie obiegów
- Usuwanie obiegów
- Przydatne szablony
- Tylko administrator
- Zapisywanie wszystkich ukończonych dokumentów w usłudze SharePoint
- Zapisywanie wszystkich ukończonych dokumentów w usłudze OneDrive dla firm
- Zapisywanie wszystkich ukończonych dokumentów na Dysku Google
- Zapisywanie wszystkich ukończonych dokumentów w usłudze DropBox
- Zapisywanie wszystkich ukończonych dokumentów w usłudze Box
- Archiwizacja umowy
- Zapisywanie ukończonych dokumentów w usłudze SharePoint
- Zapisywanie ukończonych dokumentów w usłudze OneDrive dla firm
- Zapisywanie ukończonych dokumentów na Dysku Google
- Zapisywanie ukończonych dokumentów w usłudze DropBox
- Zapisywanie ukończonych dokumentów w Box
- Archiwizacja umowy formularza internetowego
- Zapisywanie ukończonych dokumentów formularzy internetowych w bibliotece SharePoint
- Zapisywanie ukończonych dokumentów formularzy internetowych w usłudze OneDrive dla firm
- Zapisywanie ukończonych dokumentów na dysku Google
- Zapisywanie ukończonych dokumentów formularzy internetowych w usłudze Box
- Wyodrębnianie danych umowy
- Powiadomienia o umowach
- Wysyłanie niestandardowych powiadomień mailowych z zawartością umowy i podpisaną umową
- Otrzymywanie powiadomień Adobe Acrobat Sign w kanale usługi Teams
- Otrzymywanie powiadomień Adobe Acrobat Sign w usłudze Slack
- Otrzymywanie powiadomień Adobe Acrobat Sign w usłudze Webex
- Generowanie umów
- Wygenerowanie dokumentu z formularza Power App i szablonu Word, wysłanie do podpisu
- Wygenerowanie umowy z szablonu programu Word w usłudze OneDrive i uzyskanie podpisu
- Wygenerowanie umowy dla wybranego wiersza programu Excel, wysłanie do recenzji i podpisu
- Tylko administrator
- Niestandardowe obiegi pracy wysyłania
- Udostępnianie użytkowników i umów
Integracja z innymi produktami
- Przegląd integracji Acrobat Sign
- Acrobat Sign dla Salesforce
- Acrobat Sign dla Microsoft
- Inne integracje
- Integracje zarządzane przez partnerów
- Jak uzyskać klucz integracji
Programista Acrobat Sign
- Interfejsy API REST
- Elementy webhook
Pomoc techniczna i rozwiązywanie problemów
Dostęp do interfejsu API jest zarezerwowany wyłącznie dla kont na licencji dla przedsiębiorstw i deweloperskiej.
Łącza do podstawowej dokumentacji
Przydatne łącza dotyczące interfejsu API REST w wersji 6:
- Zarejestruj konto klasy deweloperskiej: https://acrobat.adobe.com/us/en/sign/developer-form.html
- Wbudowane metody: https://secure.adobesign.com/public/docs/restapi/v6
- Przykłady: https://opensource.adobe.com/acrobat-sign/developer_guide/index.html#!adobedocs/adobe-sign/master/samples.md
- Elementy webhook: https://opensource.adobe.com/acrobat-sign/acrobat_sign_events/index.html
Obsługa starszych interfejsów API SOAP zakończyła się w maju 2021 r.
Wszyscy klienci korzystający z interfejsu API SOAP powinni jak najszybciej przeprowadzić migrację do interfejsu API REST.
Po zalogowaniu się przejdź do sekcji Konto > Interfejs API Acrobat Sign > Informacje o API > Dokumentacja i interfejsy API REST.
Ogólne pojęcia
Nie można utworzyć dokumentu, wyświetlając stronę w interfejsie internetowym, przeciągając i upuszczając lub przypisując role sygnatariusza za pomocą ciągu transientDocumentId za pośrednictwem interfejsu API.
Wywołanie transientDocuments zwraca ciąg transientDocumentID, który jest ważny przez 7 dni. Można go używać tylko do kolejnych wywołań interfejsu API. Jest przechowywany na serwerze API i ma przypisany do niego identyfikator. Prześlij plik, a następnie podaj jego identyfikator w kolejnych wywołaniach interfejsu API.
Nie można bezpośrednio przesłać dokumentu do umowy za pomocą interfejsu API REST.
Zgodnie z wymaganiami usługi REST najpierw utwórz dokument przejściowy, a następnie użyj tego identyfikatora w metodach umowy, widżetu lub biblioteki jako źródła pliku.
Dokument przejściowy jest plikiem źródłowym RAW, takim jak PDF, doc, docx, przesłanym na serwery firmy Adobe. Jest to wygodny sposób na przesłanie dokumentu bazowego na serwery API oraz dokumentu przejściowego w Internecie.
Tak. Umowy można publikować przy użyciu obiegów pracy w wersji 6, korzystając z wywołania interejsu API POST /agreements. Przekaż parametr workflowId w wywołaniu API.
Identyfikator workflowId obiegu pracy można uzyskać za pomocą wywołania GET /workflows.
-
-
Wybierz kolejno Konto > Interfejs API Adobe Sign > Dziennik żądań API.
-
Zaloguj się do konta Adobe Sign jako administrator.
-
Wybierz kolejno Konto > Interfejs API Adobe Sign > Informacje o API.
-
Kliknij łącze Przykłady interfejsu API REST.
Uwaga:Aby pobrać zestaw SDK JavaScript, patrz https://github.com/adobe-sign/AdobeSignJsSdk.
Począwszy od wersji 6, opcja „sendTroughWeb” nie jest już dostępna. Zastępuje ją Stan. Jest to stan, w którym znajduje się umowa. Pole stanu można podać tylko w wywołaniach POST. Nigdy nie jest zwracane w ramach polecenia GET /agreement/{ID} i jest ignorowane, jeśli podano je w wywołaniu PUT /agreement/{ID}. Ostateczny stan umowy można uzyskać dzięki poleceniu GET /Agreements/ID.
stan(ciąg) = [„AUTHORING” lub „DRAFT” lub „IN_PROCESS”].
Opcja AUTHORING umożliwia użytkownikowi tworzenie dokumentów umowy przed ich wysłaniem. Operacja tworzenia dotyczy tworzenia, edytowania i umieszczania pól formularzy wraz z ich konfiguracjami (osoba przypisana, warunki, typ danych itp.) w dokumentach umowy. Po opublikowaniu dokumentu w stanie Tworzenie dokument jest widoczny w sekcji Wersja robocza karty Zarządzaj Adobe Sign.
Opcja DRAFT jest przejściowym lub pierwotnym etapem docelowego zasobu, który można zaktualizować w celu utworzenia zasobu końcowego i nie jest widoczny w sekcji Wersja robocza karty Adobe Sign. W przypadku korzystania ze stanu Wersja robocza informacje o zestawie uczestników nie są wymagane i można je później przypisać podczas tworzenia parametru PUT /Agreements/agreementId w celu ukończenia tej wersji roboczej. Ten krok można powtarzać wiele razy, dopóki nie zostaną uzyskane wszystkie dane wymagane do utworzenia umowy.
Opcja IN_PROCESS zmienia stan umowy na Wysłana do podpisania i jest widoczna w sekcji Wysłana do podpisania na karcie Zarządzaj Adobe Sign.
Ciąg sendThroughWeb umożliwia interaktywne wysłanie umowy. Różne parametry w polu „opcje” żądania POST /agreements w wersji 5 umożliwiają użytkownikowi skonfigurowanie tego interaktywnego widoku (strona Wyślij). Wszystkie parametry konfiguracji strony, takie jak fileUploadOptions, zostały przeniesione do interfejsu API POST agreements/ID/views.
W rezultacie możliwe jest uzyskanie ciągu sendThroughWeb poprzez utworzenie umowy w stanie AUTHORING za pomocą interfejsu API POST/agreements. Następnie, aby poprosić o adres URL następnej strony w żądanej konfiguracji, należy wywołać interfejs API POST agreements/ID/views.
Wykonaj następujące kroki:
1. Przejdź do dokumentacji dotyczącej interfejsu API REST w wersji 6 i wybierz metodę POST/agreements.
2. Użyj następującego kodu żądania:
{ "fileInfos": [ { "transientDocumentId": "***************************" } ], "name": "test", "participantSetsInfo": [ { "memberInfos": [ { "email": "abc@gmail.com" } ], "order": 1, "role": "SIGNER" } ], "signatureType": "ESIGN", "state": "AUTHORING" }
3. Teraz użyj metody post /agreement/{agreementId}/views z poniższym kodem żądania:
{ "name": "AUTHORING" } |
Kod odpowiedzi zawiera adres URL do tworzenia pól.
Adres URL wywołania zwrotnego można zdefiniować w następujący sposób:
- W razie potrzeby użyj poniższego parametru, aby zdefiniować adres URL wywołania zwrotnego:
"callbackInfo": "",
- Skontaktuj się z działem pomocy technicznej Adobe Sign, aby ustawić domyślny adres URL wywołania zwrotnego dla pełnej wersji konta.
Interfejs użytkownika SOAP (SmartBear) otrzymuje błąd połączenia SSL podobny do poniższego, który pojawia się podczas wywoływania interfejsu API. Ten błąd występuje zazwyczaj w przypadku używania przestarzałego protokołu SSL lub protokołu TLS w wersji wcześniejszej niż TLS1.2
BŁĄD: Wyjątek w żądaniu: javax.net.ssl.SSLException: Otrzymano alert krytyczny: protocol_version
BŁĄD: Wystąpił błąd [Odebrano alert krytyczny: protocol_version], szczegółowe informacje można znaleźć w dzienniku błędów
-
Dodaj (-Dsoapui.https.protocols=SSLv3,TLSv1.2) do pliku VMOPTIONS w folderze Kosz.
-
Przejdź do lokalizacji C:\Program Files\SmartBear\SoapUI-5.2.1\bin (zależy to od tego, gdzie zainstalowano interfejs użytkownika SOAP). Można go znaleźć w katalogu C:\Program Files (x86)
-
W pliku VMOPTIONS włącz pełne uprawnienia do odczytu/zapisu pliku.
-
Kliknij prawym przyciskiem myszy plik VMOPTIONS>Właściwości>karta Zabezpieczenia>Wybierz opcję Użytkownik>Kliknij opcję Edytuj. (Ikona Kontrola dostępu użytkownika wyświetla się na przycisku Edycja)>Zaznacz wszystkie pola wyboru i kliknij przycisk OK.
-
Powtórz tę czynność dla administratorów, systemów i wszystkich pakietów aplikacji.
-
Otwórz plik za pomocą programu Notatnik.
-
Dodaj ten protokół na dole „-Dsoapui.https.protocols=SSLv3,TLSv1.2” i zapisz zmiany.
-
Zamknij interfejs użytkownika SOAP i uruchom go ponownie. Podczas wywoływania interfejsu API nie pojawia się błąd SSL. (Wykonaj wywołanie test ping, aby sprawdzić).
Poniżej przedstawiono kroki tworzenia identyfikatora klienta i tajnego klucza klienta w aplikacji Adobe Sign:
-
Zaloguj się do swojego konta Adobe Sign.
-
Wybierz kolejno Konto > Interfejs API Adobe Sign > Aplikacje API.
-
Aby utworzyć aplikację, kliknij ikonę +.
-
Wprowadź nazwę i nazwę wyświetlaną.
-
W obszarze Domena wybierz opcję KLIENT i kliknij przycisk Zapisz.
-
Podświetl aplikację jednym kliknięciem.
-
Kliknij opcję Skonfiguruj OAuth dla aplikacji.
-
Wprowadź identyfikator URI przekierowania.
-
Aby włączyć wymagane zakresy, zaznacz odpowiednie pola wyboru i kliknij przycisk Zapisz.
-
Zaloguj się do Adobe Sign jako administrator konta.
-
Wybierz kolejno Konto > Interfejs API Adobe Sign > Informacje o API.
-
Kliknij łącze Klucz integracji.
Uwaga:Jeśli łącze Klucz integracji nie jest widoczne, skontaktuj się z menedżerem ds. sukcesów klienta w celu włączenia konta.
-
- Nazwij klucz intuicyjną wartością.
- Wybierz zakresy wymagane dla funkcji aplikacji.
- Kliknij przycisk Zapisz po konfiguracji klucza.
-
Po zapisaniu klucz można znaleźć w: Konto > Preferencje osobiste > Tokeny dostępu.
Wyświetli się nazwa klucza i wszystkie włączone zakresy.
Kliknij opis klucza, aby wyświetlić łącza operacji:
- Klucz integracji - to łącze zawiera klucz literału
- Cofnij - powoduje trwałe cofnięcie i usunięcie tokena dostępu
-
Zaloguj się do swojego konta Adobe Sign.
-
Wybierz kolejno Konto > Interfejs API Adobe Sign > Aplikacje API.
-
Kliknij ikonę +, aby utworzyć aplikację.
-
Kliknij opcję Skonfiguruj OAuth dla aplikacji.
-
Wygeneruj kod autoryzacji przy użyciu poniższego łącza. Identyfikator klienta, identyfikator URI przekierowania i zakresy muszą być takie same, jak w poniższym adresie URL wybranym w aplikacji (należy unikać spacji w poniższym adresie URL, a atrybut Shard, np. „NA1”, jak w przypadku konta Adobe Sign):
https://secure.na1.echosign.com/public/oauth?redirect_uri=https://www.google.co.in&response_type=code&client_id=CBJCHBCAABAAo9FZgq31_5BVG_kcIXEe6gNtn-R-gdNe&scope=user_login:self+agreement_send:account -
Jeśli wywołanie zakończy się pomyślnie, wybierz kod autoryzacji z paska adresu.
-
Pobierz i zainstaluj aplikację Postman, korzystając z łącza https://www.getpostman.com/apps.
-
Po pobraniu i zainstalowaniu kliknij opcję NOWY, aby utworzyć POST.
-
Otwórz łącze https://secure.na1.echosign.com/oauth/token zgodnie z przynależnością konta Adobe Sign.
-
W sekcji Nagłówki wpisz Content-Type jako application/x-www-form-urlencoded.
-
Upewnij się, że w obszarze Treść zaznaczono opcję x-www-form-urlencoded i wprowadź poniższe parametry wraz z odpowiadającymi im wartościami z aplikacji utworzonej na koncie Adobe Sign, a następnie kliknij przycisk WYŚLIJ.
-
Jeśli wszystkie informacje są poprawne, w odpowiedzi zwracany jest token dostępu i odświeżania:
Podczas uruchamiania procesu OAuth należy pamiętać o następujących kwestiach:
1. Określenie poprawnego identyfikatora klienta i identyfikatora URI przekierowania.
2. Zakresy podane w adresie URL autoryzacji powinny być w pełni zgodne z zakresami podanymi w aplikacji Adobe Sign.
3. Użycie poprawnego fragmentu (na1, na2, au1, eu1, jp1) zgodnie z konfigurowanym kontem.
4. Usunięcie wszelkich spacji podanych w adresie URL autoryzacji (jeśli występują).
5. Sprawdzenie składni adresu URL autoryzacji:
https://secure.na1.echosign.com/public/oauth?redirect_uri=https://secure.na1.echosign.com/public/oauthDemo&
response_type=code&client_id=9MEJXY4Y4R7L2T&scope=agreement_send
Tokeny dostępu są ważne tylko przez 3600 sekund (jedna godzina), po czym wygasają.
Posiadacz żądania API może korzystać z tokenów odświeżania w celu generowania nowych tokenów dostępu w razie potrzeby.
Elementy webhook są obsługiwane w interfejsie API REST w wersji 6 i nowszych.
Jeśli odbiorca elementu webhook nie odpowie w ciągu 72 godzin, element webhook zostanie wyłączony i nie zostanie wysłane powiadomienie.
Jeśli docelowy adres URL elementu webhook nie działa z jakiegokolwiek powodu, usługa Adobe Sign dodaje plik JSON do kolejki i ponawia próbę wypchnięcia w cyklu progresywnym przez 72 godziny.
Niedostarczone zdarzenia zostają utrwalone w kolejce ponownych prób i w ciągu następnych 72 godzin dokłada się wszelkich starań, aby dostarczyć powiadomienia w kolejności, w jakiej wystąpiły.
Strategia ponownych prób dostarczenia powiadomień polega na podwojeniu czasu między próbami, począwszy od 1-minutowego odstępu, który wzrasta do 12 godzin, co daje 15 ponownych prób w ciągu 72 godzin.
Aby utworzyć element webhook bezpośrednio z interfejsu użytkownika usługi Adobe Sign, najpierw utwórz adres URL elementu webhook za pomocą aplikacji funkcyjnych usługi Azure AD, wykonując poniższe kroki:
-
Zaloguj się za pomocą konta Microsoft https://portal.azure.com/.
-
Zarejestruj się w celu korzystania z aplikacji funkcyjnych na koncie usługi AzureAD.
-
Przejdź do usługi AzureAD i wybierz kolejno opcje Aplikacje funkcyjne > Kliknij ikonę + dla funkcji.
-
Wybierz Webhook+API z językiem JavaScript i kliknij opcję Utwórz funkcję.
-
Zastąp plik Index.js następującym fragmentem kodu:
module.exports = function (context, req) { var clientId = req.headers['x-adobesign-clientid']; // Validate that the incoming ClientID is genuine if (clientId === '************************************') { context.res = { // status: 200, /* Defaults to 200 */ // any 2XX response is acceptable body: { 'xAdobeSignClientId' : clientId, }, headers : { 'Content-Type' : 'application/json' } }; } else { context.res = { status: 400, body: "Opps!! Illegitimate Call identified" }; } context.done(); };
-
Kliknij przycisk Test w prawym rogu i podaj następujący nagłówek:
X-AdobeSign-ClientId jako *************************
-
Kliknij przycisk Zapisz i uruchom.
-
Po otrzymaniu odpowiedzi 200 OK z następującym nagłówkiem kliknij przycisk Pobierz adres URL funkcji.
-
Skopiuj adres URL i przejdź do interfejsu użytkownika Adobe Sign > Elementy webhook > Kliknij ikonę +, aby utworzyć.
-
Wprowadź następujące informacje:
- Nazwa: sugerowana jest intuicyjna nazwa, którą inni administratorzy mogą łatwo zrozumieć.
- Zakres: jak szeroka jest sieć do przechwytywania elementów webhook. Konto i grupa są dostępne w interfejsie.
Interfejs API obsługuje zakresy Konto, Grupa, Użytkownik i Zasoby. - Można zdefiniować tylko jeden zakres na element webhook
- URL: docelowy adres URL, do którego usługa Adobe Sign wypchnęła ładunek JSON.
- Zdarzenia: wyzwalacz, który powoduje, że usługa Adobe Sign tworzy JSON i wypycha na adres URL.
Każde zdarzenie tworzy inny ładunek właściwy dla zdarzenia wyzwalacza.
Zdarzenia wielokrotne można dołączyć do jednego elementu webhook. - Parametry powiadomień: parametry powiadomień identyfikują sekcje ładunku JSON zdarzenia, umożliwiając wybranie tylko tych sekcji zdarzenia, które są ważne.
-
Po zdefiniowaniu elementu webhook kliknij przycisk Zapisz, a nowy element webhook zacznie reagować natychmiast na zdarzenia wyzwalacza.
Zasób umowy odnosi się do zasobu, za pomocą którego można utworzyć umowę, np. dokument biblioteki, widżet i sama umowa.
Aby wyszukać zdarzenia zasobów umowy, najpierw należy wysłać do interfejsu API żądanie utworzenia zdarzenia agreementAssetEvents z odpowiednimi parametrami wyszukiwania.
Odpowiedź to pierwsza strona wyników wraz z parametrem identyfikatora wyszukiwania i kursorem następnej strony. Za pomocą tej funkcji można pobierać kolejne strony z wynikami, jeśli są dostępne za pomocą interfejsu API, który pobiera zdarzenia agreementAssetEvents na podstawie identyfikatora wyszukiwania.
-
Otwórz dokumentację dotyczącą interfejsu API REST w wersji 5.
-
Przejdź do zdarzenia post/search/agreementAssetEvents i wygeneruj token dostępu z odpowiednimi zakresami.
-
W kodzie żądania zdefiniuj datę rozpoczęcia i zakończenia zgodnie z wymaganiami:
{ "endDate": "2018-05-22T22:33:33", "startDate": "2017-12-22T22:33:33" }
-
Kliknij opcję Wypróbuj. Pobiera identyfikatory zasobów umowy, które mogą być również używane jako identyfikatory umowy.
Zarządzanie użytkownikami/kontami
- Zaloguj się w usłudze Adobe Sign.
- Wybierz kolejno Konto > Interfejs API Adobe Sign > Dokumentacja dotycząca interfejsu API REST.
- Wybierz opcję Wersja 5.
- W metodzie post /users użyj kodu żądania wymienionego w metodzie
UserCreationInfo
{
"email": "email@email.com",
"firstName": "AA",
"lastName": "AB",
"password":"12******rte"
}
Konta Adobe Sign, które korzystają z konsoli administracyjnej (Adobe One) w celu zarządzania uprawnieniami użytkowników, nie mogą korzystać z interfejsu API Adobe Sign w celu tworzenia użytkowników lub zarządzania istniejącymi użytkownikami.
Konsola administracyjna Adobe One używa innego interfejsu API niż API Adobe Sign. Więcej informacji można znaleźć w następujących artykułach:
- https://helpx.adobe.com/enterprise/help/users.html
- https://www.adobe.io/apis/cloudplatform/umapi-new.html
Pobieranie identyfikatora grupy:
-
Przejdź do strony https://secure.na1.echosign.com/public/docs/restapi/v5.
-
W obszarze Zasoby i operacje kliknij opcję Grupy.
-
Kliknij opcję GET /groups.
-
Kliknij przycisk Token dostępu OAuth.
-
Wygeneruj token dostępu.
-
Kliknij przycisk Wypróbuj.
Otrzymasz następującą odpowiedź z nazwą grupy i identyfikatorem grupy:
{ "groupInfoList": [ { "groupId": "3AAABLblqZhB4o9EnlvmGB_m8CrG5O6XClTBO7vmojOOexu5r3G95LtEV2Sp7BuhNvQYSvWB7PmmwVPXnhPIiYSuHV98Cerkp", "groupName": "Default Group" }, { "groupId": "3AAABLblqZhC3dPT6za5h7r1-BOEWivCe_OcAVONhcsKa57SL9_iCwGr5v_JED1No5jE20Pcjv0mYH2J-LoY1AcmqS69vRkO7", "groupName": "test" }, ] }
Usuwanie grupy:
-
Kliknij opcję DELETE /groups/{groupId}.
-
Aby wygenerować token dostępu, kliknij przycisk Token dostępu OAuth.
-
W polu groupId dodaj identyfikator grupy otrzymany w odpowiedzi na poprzednie wywołanie, która ma zostać usunięta.
-
Kliknij opcję Wypróbuj.
Po usunięciu grupy otrzymasz odpowiedź: Brak zawartości
Nie można usunąć grupy, do której przypisano użytkownika. W zasadzie można usunąć tylko pustą grupę. Jeśli w grupie znajduje się użytkownik, otrzymasz odpowiedź:
"code": "GROUP_NOT_EMPTY", "message": "The group cannot be deleted because it is not empty." } |
Inicjowanie/wysyłanie umów
Generowanie dokumentu przejściowego
-
Kliknij ciąg transientDocuments i rozwiń metodę POST /transientDocuments.
-
Kliknij przycisk Token dostępu OAuth.
-
- Włącz zakresy dla transakcji.
- Kliknij przycisk Autoryzuj.
-
W razie potrzeby kliknij opcję Zezwól na dostęp.
-
Nastąpi powrót do strony metod API. Wartość autoryzacji jest teraz wypełniona.
- Wprowadź nazwę pliku w polu Nazwa pliku.
- Kliknij przycisk Wybierz plik i prześlij dokument dla umowy.
- Kliknij przycisk Wypróbuj!
-
Odpowiedź została wygenerowana.
Identyfikator dokumentu przejściowego można znaleźć w treści odpowiedzi:
Generowanie umowy przy użyciu dokumentu przejściowego
-
Kliknij umowy i rozwiń metodę POST /agreements.
-
- Kliknij przycisk Token dostępu OAuth.
- Włącz zakres OAuth.
- Kliknij przycisk Autoryzuj.
- W razie potrzeby kliknij opcję Zezwól na dostęp.
-
Nastąpi powrót do strony metod API. Wartość autoryzacji jest teraz wypełniona.
- Skopiuj poniższy skrypt do edytora tekstu (ten skrypt jest tylko minimalnie skonfigurowanym przykładem; kod produkcji będzie inny)
- Wstaw wartość trasientDocumentId do kodu, jeśli jest wskazana
{ "fileInfos": [ {"transientDocumentId":"PASTE YOUR TRANSIENTDOCUMENTID HERE"} ], "name": "test doc", "participantSetsInfo": [ { "memberInfos": [ { "email": "noreply@echosign.com" } ], "order": 1, "role": "SIGNER" } ], "signatureType": "ESIGN", "state": "DRAFT" }
- Skopiuj własny skrypt i wklej go w polu AgreementInfo.
- Kliknij przycisk Wypróbuj!
-
Odpowiedź została wygenerowana.
Identyfikator umowy można znaleźć w treści odpowiedzi:
Poniżej przedstawiono kroki dotyczące dodawania plików do parametru FileInfo:
-
Użyj identyfikatora przejściowego:
Przejdź do metody POST/transientDocuments i prześlij dokument, który ma być używany w systemie lokalnym.
Użyj identyfikatora przejściowego wygenerowanego w sekcji Informacje o pliku w metodzie POST/Agreements:"fileInfos": [ { "transientDocumentId": "" } ],
-
Użyj identyfikatora dokumentu biblioteki:
Przejdź do pulpitu nawigacyjnego. Kliknij opcję Dodaj dokument do biblioteki i zapisz szablon.
W sekcji Dokumentacja interfejsu API REST kliknij opcję GET /libraryDocuments i pobierz identyfikator biblioteki dla tworzonego szablonu.
W sekcji POST/Agreements podaj identyfikator dokumentu biblioteki:"libraryDocumentId": "", "libraryDocumentName": "",
-
Użyj publicznie dostępnego adresu URL:
Podaj publicznie dostępny adres URL, który ma być używany w parametrze FileInfo:
{ "documentURL": { "mimeType": "", "name": "", "url": "" },
-
Przejdź do strony https://secure.na1.adobesign.com/public/docs/restapi/v6.
-
Wybierz opcję Umowy > POST/agreements.
-
Wybierz opcję Token dostępu OAuth i podaj wymagane zakresy.
-
Po dodaniu tokena dostępu można użyć następującego kodu żądania:
{ "documentCreationInfo": { "recipientSetInfos": [ { "recipientSetRole": "SIGNER", "recipientSetMemberInfos": [{"email": "testemail@email.com"}] }, { "recipientSetRole": "SIGNER", "recipientSetMemberInfos": [{"email": "testemail@email.com"}] } ], "signatureFlow": "SEQUENTIAL", "name": "husband wife", "signatureType": "ESIGN", "fileInfos": [ { "transientDocumentId": "(SAMPLE VALUE)3AAABLblqZhAJ9H6e23kZAfBUbItPvIhHTEyA6eZhziEp4KSntYcULpo43OEXwuWiWa-IM1r1EExYW0044CjCkliP4WFL5yKBUDq5DYSmSxVlFypcD0at8kK-BX-Mu3T9c_3GUqgDg0ArX0MmzWT72GLR_0M4Jq--mtuqGzq-VK1s-WGR6GcbedVY7XWAf3b3h-SpE08Hc-iF3zO7jQzi9newXSl-iW2JJsb_55tggkyxkXAkj74C1WD6KkJzgblK0JU-seh6QPDd0Fv6_mfQe2EPQA31nXj50aXwD_xlUBq7mg5FeaBnZ5bzgoqIWGHkbyeD2taaFdw*"} ] } }
W wywołaniu POST /agreement dla parametru signatureflow można przekazać wartość SENDER_SIGNS_FIRST lub SENDER_SIGNS_LAST, aby dodać nadawcę odpowiednio jako pierwszego lub ostatniego sygnatariusza.
Oto przykład wywołania w formacie JSON:
{
"documentCreationInfo": {
"fileInfos": [
{ "transientDocumentId":"3AAABLblqZ-yourIDGoesHere"
}
],
"name": "Test",
"recipientSetInfos": [
{
"recipientSetMemberInfos": [
{
"email": "test@email.com"
}
],
"recipientSetRole": "SIGNER"
}
],
"signatureType": "ESIGN",
"signatureFlow": "SENDER_SIGNS_FIRST"
}
}
Opcja Wyślij w imieniu jest dostępna tylko w interfejsie API REST w wersji 6 z włączoną opcją zaawansowanego udostępniania.
Jeśli w ramach udostępniania nie jest określone uprawnienie do wysyłania lub opcja Udostępnianie zaawansowane nie jest włączona, otrzymasz poniższą odpowiedź:
{"code":"PERMISSION_DENIED","message":"User provided in x-on-behalf-of-user header does not have required permission to perform this operation."}
|
W przypadku funkcji Wyślij w imieniu włącz opcję Zaawansowane udostępnianie konta dla konta, aby użytkownicy mogli nadawać innym użytkownikom uprawnienia do wysyłania podczas udostępniania konta. Aby uzyskać informacje na temat zaawansowanego udostępniania, patrz Włączanie zaawansowanego udostępniania konta.
Po włączeniu funkcji udostępniania użytkowników wykonaj następujące czynności, aby użyć opcji Wyślij w imieniu:
Generowanie dokumentu przejściowego:
-
Przejdź do strony https://secure.adobesign.com/public/docs/restapi/v6.
-
W obszarze transientDocuments kliknij metodę POST /transientDocuments.
-
Aby wygenerować token dla autoryzacji, kliknij przycisk OAUTH ACCESS-TOKEN.
-
W polu x-on-behalf-of-user podaj adres e-mail użytkownika, dla którego chcesz wysłać w imieniu, w następującym formacie: e-mail:test@email.com
-
Aby wybrać plik, kliknij Wybierz plik i kliknij Wypróbuj.
Otrzymasz poniższą odpowiedź z ciągiem transientDocumentId:
{"transientDocumentId":"3AAABLblqZhB9Mjo0mrIu_pSgrf5VsMaKM68_Vmn80cimaqiUAD2OxrPp2e5H8GvjfiOxj4d5B8bCPkUfvaozW3KLisp_wseGVOL8A7oNZni1DWyFi4uNoxLQu4nUO44Wh63GQv9_HEJMePust0Pk94vJ_rbS96R7ic-vl7jbOkN0b4EB5-JMqlC-Fl_Vpyz8I1EQUrM5I4nB9ztMov4ad00yiOtDw0tB-Y2t5JdzM07P-mpJmwYEl8Fq2IeDuWjcR2tV7qY7TNGX2CNyh9jt0aMyduHeYa0GABr69z8Hm76eKdtaM_1E1ggWj205fSrNcwJsnpSO278*"}
Generowanie umowy przy użyciu dokumentu przejściowego:
-
W obszarze Umowy kliknij opcję POST /agreements.
-
Aby wygenerować token do autoryzacji, kliknij przycisk OAUTH ACCESS-TOKEN.
-
W polu x-on-behalf-of-user podaj adres e-mail użytkownika, który podano podczas tworzenia dokumentu przejściowego.
-
W polu AgreementInfo dodaj następujący kod i kliknij opcję Wypróbuj.
{ "fileInfos": [ { "transientDocumentId":"3AAABLblqZhB9Mjo0mrIu_pSgrf5VsMaKM68_Vmn80cimaqiUAD2OxrPp2e5H8GvjfiOxj4d5B8bCPkUfvaozW3KLisp_wseGVOL8A7oNZni1DWyFi4uNoxLQu4nUO44Wh63GQv9_HEJMePust0Pk94vJ_rbS96R7ic-vl7jbOkN0b4EB5-JMqlC-Fl_Vpyz8I1EQUrM5I4nB9ztMov4ad00yiOtDw0tB-Y2t5JdzM07P-mpJmwYEl8Fq2IeDuWjcR2tV7qY7TNGX2CNyh9jt0aMyduHeYa0GABr69z8Hm76eKdtaM_1E1ggWj205fSrNcwJsnpSO278*" } ], "name": "Test", "participantSetsInfo": [ { "memberInfos": [ { "email": "signer@email.com" } ], "order": 1, "role": "SIGNER" } ], "signatureType": "ESIGN", "state": "IN_PROCESS" }
Otrzymasz odpowiedź z następującą wartością agreementId:
{ "id": "CBJCHBCAABAAUlen3l_fzlj1Kbn_wGZAhYcIgN0J7Qtq" }
-
Zaloguj się w usłudze Adobe Sign.
-
Przejdź do Konto>Interfejs API Adobe Sign>Informacje o API i kliknij opcję Dokumentacja dotycząca metody interfejsu API REST.
-
POST /transientDocuments i przesłanie pliku oraz utworzenie przejściowego identyfikatora dokumentu.
-
Skopiuj przejściowy identyfikator dokumentu i użyj go w metodzie POST /agreement. W polu należy podać następujące żądanie JSON:
{ "documentCreationInfo": { "mergeFieldInfo": null, "recipientSetInfos": [{ "signingOrder": null, "recipientSetRole": "SIGNER", "recipientSetMemberInfos": [{ "securityOptions": null, "email": "test1@gmail.com" }], "privateMessage": "Hello 1", "securityOptions": null }, { "signingOrder": null, "recipientSetRole": "SIGNER", "recipientSetMemberInfos": [{ "securityOptions": null, "email": "test2@gmail.com" }], "privateMessage": "Hello 2", "securityOptions": null } ], "signatureType": "ESIGN", "callbackInfo": null, "message": "Please review and sign this document.", "locale": "en_US", "vaultingInfo": null, "securityOptions": null, "reminderFrequency": null, "ccs": null, "postSignOptions": null, "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED", "daysUntilSigningDeadline": null, "formFieldLayerTemplates": [], "name": "Adobe Sign Agreement", "formFields": null, "fileInfos": [{ "libraryDocumentName": null, "transientDocumentId": "XXXXXXXXXXXX", "documentURL": null, "libraryDocumentId": null }] } }
-
Aby wykonać żądanie JSON, kliknij przycisk Wypróbuj.
Prawidłowe żądanie JSON zwraca odpowiedź z identyfikatorem umowy.
Poniżej przedstawiono parametry, które można przekazać w kodzie w celu ustawienia hasła otwierania:
{ "documentCreationInfo": [{ "signatureType": "ESIGN", "recipientSetInfos": [{ "recipientSetMemberInfos": [{ "email": "abc@xyz.com" }],
"recipientSetRole": "SIGNER" }], "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED", "fileInfos": [ { "libraryDocumentId": "3AAABLblqZhBsm_vH7TVzU3hRdbtWuvzfTKDvBzaKZTiehjO2eGTk5Rlu02K-0BYn8HBJVFTWOmT_BQlrofPBlrCdjiJ_JI-V" } ], "name": "Open password to view document", "securityOptions": { "openPassword": "1234", "protectOpen": true } }] }
|
Aby utworzyć umowę przy użyciu interfejsu API ze stanem „AUTHORING”, wykonaj następujące czynności:
Przejdź do opcji Post /agreements i utwórz token dostępu z wymaganymi zakresami.
Użyj kodu żądania w następujący sposób:
{ "fileInfos": [ { "transientDocumentId": "*********************" } ], "name": "A1", "participantSetsInfo": [ { "memberInfos": [ { "email": "abc@xyz.com" } ], "order": 1, "role": "SIGNER" } ], "signatureType": "ESIGN", "state": "AUTHORING" }
|
Wersja 6 zawiera zestaw interfejsów API do tworzenia umów. W wersji 5 obiekty formFields są używane bezpośrednio w interfejsie API POST /agreements. Jednak w wersji 6 użytkownik może utworzyć umowę w stanie AUTHORING (stan = AUTHORING) za pomocą metody POST /agreements w wersji 6 i w dowolnym późniejszym czasie dodać pola formularza do dokumentów tej umowy za pomocą opcji PUT /agreements/ID/formFields.
Poniżej opisano następujące czynności:
-
Przejdź do dokumentacji dotyczącej interfejsu API REST w wersji 6 i wybierz metodę POST/agreements.
-
Użyj następującego kodu żądania:
{ "fileInfos": [ { "transientDocumentId": "***************************" } ], "name": "test", "participantSetsInfo": [ { "memberInfos": [ { "email": "abc@gmail.com" } ], "order": 1, "role": "SIGNER" } ], "signatureType": "ESIGN", "state": "AUTHORING" }
-
Użyj metody put /agreements/{agreementId}/formFields z następującym żądaniem jako przykład:
{ "fields": [ { "locations": [ { "height": 36, "left": 75, "pageNumber": "1", "top": 200, "width": 150 } ], "contentType": "SIGNATURE_BLOCK", "name": "sigBlock1", "inputType": "SIGNATURE", "recipientIndex":1 } ]}
Po zakończeniu żądania umowa zostanie wysłana do wspomnianego odbiorcy.
-
Zaloguj się w usłudze Adobe Sign.
-
Przejdź do Konto>Interfejs API Adobe Sign>Informacje o API i kliknij opcję Dokumentacja dotycząca metody interfejsu API REST.
-
POST /transientDocuments i przesłanie pliku oraz utworzenie przejściowego identyfikatora dokumentu.
-
Skopiuj przejściowy identyfikator dokumentu i użyj go w metodzie POST /agreement. W polu należy podać następujące żądanie JSON:
{ "documentCreationInfo": { "recipientSetInfos": [{ "recipientSetRole": "SIGNER", "recipientSetMemberInfos": [{ "email": "test1@gmail.com" }], "privateMessage": "Hello 1" }, { "recipientSetRole": "SIGNER", "recipientSetMemberInfos": [{ "email": "test2@gmail.com" }], "privateMessage": "Hello 2" } ], "signatureType": "ESIGN", "message": "Please review and sign this document.", "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED", "name": "Demo1", "fileInfos": [{ "transientDocumentId": "XXXXXXXXXX" }], "formFields": [{ "hidden": "1", "defaultValue": "test1@gmail.com", "name": "Signer Email (Applicant-1)", "inputType": "TEXT_FIELD", "readOnly": true, "locations": { "pageNumber": 1, "top": 100, "left": 100, "width": 100, "height": 30 }, "contentType": "SIGNER_EMAIL" }, { "name": "Signature (Applicant-2)", "inputType": "SIGNATURE", "locations": { "pageNumber": 1, "top": 520, "left": 162, "width": 280, "height": 30 }, "contentType": "SIGNATURE", "required": 1, "recipientIndex": 1 }, { "name": "Signature (Applicant-3)", "inputType": "SIGNATURE", "locations": { "pageNumber": 2, "top": 312, "left": 154, "width": 280, "height": 30 }, "contentType": "SIGNATURE", "required": 1, "recipientIndex": 1 }, { "defaultValue": "017/09/2018", "displayFormatType": "DATE", "name": "Signature Date (Applicant-4)", "format": "DATE_DD_MM_YYYY", "inputType": "TEXT_FIELD", "readOnly": true, "locations": { "pageNumber": 2, "top": 260, "left": 90, "width": 80, "height": 30 }, "contentType": "DATA", "required": 1, "recipientIndex": 1 }, { "name": "Signature (Applicant-5)", "inputType": "SIGNATURE", "locations": { "pageNumber": 3, "top": 199, "left": 179, "width": 276, "height": 30 }, "contentType ": "SIGNATURE", "required": 1, "recipientIndex": 1 }, { "contentType": "SIGNATURE_DATE", "defaultValue": "06/07/2018", "displayFormatType": "DATE", "name": "Signature Date (Applicant-6)", "format": "DATE_DD_MM_YYYY", "inputType": "TEXT_FIELD", "readOnly": true, "locations": { "pageNumber": 3, "top": 188, "left": 488, "width": 76, "height": 25 }, "required": 1, "recipientIndex": 1 }, { "name": "Signature (Applicant-7)", "inputType": "SIGNATURE", "locations": { "pageNumber": 3, "top": 370, "left": 37, "width": 210, "height": 26 }, "contentType ": "SIGNATURE", "required": 1, "recipientIndex": 2 }, { "contentType ": "SIGNATURE_DATE", "defaultValue": "01/02/2018", "name": "Signature Date (Applicant-8)", "locations": { "pageNumber": 3, "top": 370, "left": 300, "width": 76, "height": 26 }, "required": 1, "recipientIndex": 2 } ] } }
-
Aby wykonać żądanie JSON, kliknij przycisk Wypróbuj.
Prawidłowe żądanie JSON zwraca odpowiedź z identyfikatorem umowy.
-
Zaloguj się w usłudze Adobe Sign.
-
Przejdź do Konto>Interfejs API Adobe Sign>Informacje o API i kliknij opcję Dokumentacja dotycząca metody interfejsu API REST.
-
POST /transientDocuments i przesłanie pliku oraz utworzenie przejściowego identyfikatora dokumentu.
-
Skopiuj przejściowy identyfikator dokumentu i użyj go w metodzie POST /agreement. W polu należy podać następujące żądanie JSON:
{ "options": { "noChrome": true, "authoringRequested": true }, "documentCreationInfo": { "recipientSetInfos": [{ "recipientSetRole": "SIGNER", "recipientSetMemberInfos": [{ "email": "test1@gmail.com" }], "privateMessage": "Hello 1" }, { "recipientSetRole": "SIGNER", "recipientSetMemberInfos": [{ "email": "test2@gmail.com" }], "privateMessage": "Hello 44" } ], "signatureType": "ESIGN", "message": "Please review and sign this document.", "locale": "en_US", "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED", "formFieldLayerTemplates": [], "name": "Adobe Sign Agreement", "formFields": null, "fileInfos": [{ "libraryDocumentName": null, "transientDocumentId": "XXXXXXXXXXXX" }] } }
-
Aby wykonać żądanie JSON, kliknij przycisk Wypróbuj.
Prawidłowe żądanie JSON zwraca odpowiedź z identyfikatorem umowy.
-
Aby otworzyć umowę w trybie tworzenia, skopiuj adres URL i wklej go do paska adresu przeglądarki.
-
Przeciągnij i upuść pola formularza w odpowiednim miejscu.
-
Aby wysłać umowę do podpisania, kliknij przycisk Wyślij.
Użyj metody POST /agreements, aby utworzyć umowę. Wysyła ją do podpisania i zwraca identyfikator umowy w odpowiedzi na klienta. Poniżej przedstawiono format JSON wysyłania umowy przy użyciu metody uwierzytelniania telefonicznego.
{ "documentCreationInfo": { "mergeFieldInfo": null, "recipientSetInfos": [{ "signingOrder": null, "recipientSetRole": "SIGNER", "recipientSetMemberInfos": [{ "securityOptions": null, "email": "Signer@email.com" }],
"privateMessage": null, "securityOptions": [{ "authenticationMethod": "PHONE", "phoneInfos": [{ "phone": "1111111111", "countryCode": "+1" }] }] }],
"signatureType": "ESIGN", "callbackInfo": null, "message": "Please review and sign this document.", "locale": "en_US", "vaultingInfo": null, "securityOptions": null, "reminderFrequency": null, "ccs": null, "postSignOptions": null, "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED", "daysUntilSigningDeadline": null, "formFieldLayerTemplates": [], "name": "Adobe Sign Agreement-Phone authentication testing", "formFields": null, "fileInfos": [{ "libraryDocumentName": null, "transientDocumentId": "3AAABLYourTransactionID", "documentURL": null, "libraryDocumentId": null }] },
"options": { "autoLoginUser": true, "authoringRequested": false, "noChrome": true, "sendThroughWeb": null, "sendThroughWebOptions": null, "locale": "en_US" } }
|
Dane można scalić bezpośrednio w polach formularza, korzystając z następujących metod:
- Używanie szablonu biblioteki:
Jeśli używasz identyfikatora szablonu biblioteki w parametrze FileInfo, podaj dokładną nazwę pola i powiązane dane w poniższej sekcji:
"mergeFieldInfo": [ { "defaultValue": "", "fieldName": "" } ],
|
- Używanie znaczników tekstowych w dokumencie przesłanym jako dokument przejściowy:
Jeśli przesyłasz dokument, do którego dodano znaczniki tekstowe jako dokument przejściowy, upewnij się, żeby podać dokładną nazwę pola i powiązane z nim dane w poniższej sekcji:
"mergeFieldInfo": [ { "defaultValue": "", "fieldName": "" } ],
|
Jak wysłać umowę za pomocą interfejsu API, który zawiera wstępnie wypełnione wartości dla określonych pól formularza (mergefield)?
Warunkiem wstępnym tego wywołania jest ukończenie kroku „Przejściowe wysyłanie” i uzyskanie ciągu „transientDocumentId” (przy użyciu: secure.na1.echosign.com/public/docs/restapi/v5#!/transientDocuments/createTransientDocument) do użycia tutaj.
- To wywołanie zawiera sekcję „mergeFieldInfo”, w której podane są wartości domyślne dla określonych pól formularza.
- Wstępnie wypełnia to dane z innego systemu w wywołaniu interfejsu API.
- Te pola w umowie są edytowalne lub tylko do odczytu.
Wymagania wstępne:
- Identyfikator dokumentu przejściowego
- Nazwy pól i ich wartości
Przykładowe wywołanie żądania:
Żądanie: POST /api/rest/v5/agreements HTTP/1.1 Host: api.na1.echosign.com (lub można określić nazwę konta współdzielonego, którą można znaleźć za pomocą wywołania getbaseURis: https://secure.na1.echosign.com/public/docs/restapi/v5#!/base_uris/getBaseUris Token dostępu: 2AAABLblqZhA_D1mluNKQP7py5vXtt-1UHl9NR25e_C3LnKTUH14IblbrXODbXGRozyr7ChBkJNM* x-user-email: sender@yourdomain.com Content-Type: application/json Cache-Control: no-cache
{ "documentCreationInfo": { "signatureType": "ESIGN", "recipientSetInfos": [ { "recipientSetMemberInfos": [ { "email": “signerEmail@domain.com" } ], "recipientSetRole": "SIGNER" } ],
"signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED", "message": "Please Sign this from us!", "fileInfos": [ { "transientDocumentId": "3AAABLblqZhD1uP3ZnkJximC0JV1S677PR5xmybSJ-SJn6OtEy2tVqFyMN4xUAbhKTSkLw2Zb6HEF4zAGsrUd2ycoB8fFHQJhrci0O6267VztmIL4nCicSqvAjO7HckATHAsovVmuYwI9_FDDgHg0ogyti62L13HQFZIQRe9iyQMvvzbmksM7ODNK_HEepEKRCeJTtis9FOlz6uRCcIMNlbX_2GU8utWT" } ], "name": "MSA Edited”, "mergeFieldInfo": [ { "fieldName": "AccountName", "defaultValue": "Sam's Garage" }, { "fieldName": "AccountNumber", "defaultValue": "8756999" }, { "fieldName": "Zip", "defaultValue": "94501" }, { "fieldName": "City", "defaultValue": "CityVille" }, { "fieldName": "State", "defaultValue": "CA" }, { "fieldName": "Street", "defaultValue": "123 Some Road" }, { "fieldName": "Title1", "defaultValue": "COO" }, { "fieldName": "Description", "defaultValue": "Some new description here" } ] }
}
Odpowiedź na to wywołanie to wartość „agreementId”, którą należy przechowywać w systemie do kolejnych wywołań (signingUrl, status, formData itp.)
Odpowiedź: { "agreementId": "3AAABLblqZhCf_7xDcrOgKFwAabp1S-OFfvUdHf2wJsSMwlB95_x_WdUeab67jOkJi1IJzWuSJ0zdNNKugS1blZB4LT5vNVyJ" }
|
Podczas uruchamiania metody „post /megaSigns/{megaSignId}/views” wyświetlany jest błąd „Żądany widok nie jest dostępny dla zasobu w bieżącym stanie.”
Wyświetlany jest błąd, jeśli podana wartość parametru „name” jest nieprawidłowa w poniższym kodzie żądania:
{
"name": " "
}
Na przykład, jeśli umowa MegaSign ma już wartość „IN_PROCESS”, wówczas podanie wartości „AUTHORING” spowoduje wygenerowanie wspomnianego błędu. Upewnij się, że podana wartość jest zgodna z bieżącym stanem umowy.
Podczas uruchamiania metody „put /megaSigns/{megaSignId}/state” pojawia się błąd „Brak wartości dla informacji o anulowaniu MegaSign.”
Błąd jest spowodowany brakiem parametru w kodzie żądania:
"megaSignCancellationInfo": {
"comment": "",
"notifyOthers": false
}
Zamiast używać schematu "Minimal Schema", kliknij opcję "Complete Model Schema" i podaj pełny kod żądania w celu uruchomienia wywołania interfejsu API.
Aby zmienić stan umowy MegaSign, użyj polecenia /megaSigns/{megaSignId}/state i wykonaj następujące czynności:
- Przejdź do dokumentacji dotyczącej interfejsu API REST w wersji 6 i wybierz metodę
put /megaSigns/{megaSignId}/state. - Podaj wartość autoryzacji, a także elementy If-Match i megasignID.
- Aby pobrać element megasignID, użyj polecenia get /megaSigns
- Aby pobrać element If-Match, użyj polecenia get /megaSigns/{megaSignId} i w nagłówku znajdź element "Etag"
- {
"state": "CANCELED",
"megaSignCancellationInfo": {
"comment": "cancel",
"notifyOthers": false
}
}
Aby pomyślnie zarejestrować element webhook, adres URL elementu webhook odpowiada na to żądanie weryfikacji za pomocą kodu odpowiedzi 2XX, a ponadto może zwrócić tę samą wartość identyfikatora klienta za pomocą jednego z następujących dwóch sposobów:
- W nagłówku odpowiedzi X-AdobeSign-ClientId. Jest to ten sam nagłówek, który jest przekazywany w żądaniu i jest ponownie przywoływany w odpowiedzi.
- W treści odpowiedzi JSON z kluczem X-AdobeSign-ClientId i jego wartością jest ten sam identyfikator klienta, który został wysłany w żądaniu.
Aplikacja Adobe Sign otrzymuje odpowiedź 2xx z X-AdobeSign-ClientId. Użytkownik może sprawdzić, czy jest poprawnie skonfigurowany w elemencie webhook.
Adres URL elementu webhook nie odpowiada zgodnie z oczekiwanym zachowaniem. W przypadku każdego wysłanego przez usługę Adobe Sign powiadomienia POST adres URL odpowiada kodem stanu 2XX i odzwierciedla identyfikator klienta wysłany w nagłówkach żądania (X-AdobeSign-ClientId) w nagłówkach odpowiedzi.
Aby uzyskać pełne informacje, patrz następujące łącze:
https://www.adobe.io/apis/documentcloud/sign/docs.html#!adobedocs/adobe-sign/master/webhooks/webhook_events.md
Jeśli adres URL nie jest zgodny z tym protokołem, należy uznać, że usługa Adobe Sign nie zaakceptowała żądania i podjęła próbę zmiany harmonogramu zgodnie z wiarygodnymi zasadami.
Jeśli element webhook nie odpowie i zostanie przekroczony maksymalny czas ponawiania lub maksymalny interwał ponawiania prób, element webhook zostanie wyłączony.
Posty z serwisów Twitter™ i Facebook nie są objęte licencją Creative Co
Zarządzanie informacjami o umowach i pobieranie ich
Aby zmienić dokument już wysłany do podpisania, użyj metody PUT /agreements/{agreementId}, za pomocą której można zaktualizować istniejącą umowę. Podaj identyfikator przejściowy wraz z identyfikatorem umowy w poniższym kodzie żądania:
{ "documentUpdateInfo": { "fileInfos": [ { "agreementDocumentId": "", "transientDocumentId": "" } ] } }
|
Poniżej znajdują się instrukcje aktualizowania stanu z „AUTHORING” na „IN_PROCESS” przy użyciu opcji Put /agreements/{agreementId}/state:
-
Pobierz identyfikator umowy za pomocą metody POST/Agreement.
-
Użyj polecenia Get /agreements/{agreementId}, aby pobrać najnowszy element ETag.
-
Przejdź do opcji Put /agreements/{agreementId}/state i podaj następujące informacje: "state": "IN_PROCESS"
Nie.
W bieżącym interfejsie API REST nie ma metody przesyłania podpisanej kopii.
Nadawca musi przesłać podpisaną kopię ze strony Zarządzaj.
Polecenie DELETE /agreements/ID służy do ukrywania umowy na stronie zarządzania.
Adobe ma nowy interfejs API PUT /agreements/ID/me/visibility umożliwiający sterowanie widocznością umowy (w GET /agreements). Oprócz funkcji dostępnych w poleceniu DELETE /agreements/ID nowy punkt końcowy widoczności umożliwia również cofnięcie operacji „ukryj”, czyli ponowne wyświetlenie umowy.
Można również wykonać następujące szczegółowe kroki:
- Przejdź do metody get/agreements i pobierz identyfikator umowy.
- Kliknij opcję put /agreements/{agreementId}/me/visibility i podaj poniższe żądanie jako przykład:
{
"visibility": "HIDE"
}
Identyfikator umowy jest ukryty tylko w metodzie get /libraryDocuments, ale jest nadal widoczny w interfejsie karty Zarządzaj.
Funkcja przechowywania interfejsu API nie jest domyślnie włączona.
Aby włączyć operację DELETE/agreements, skontaktuj się z menedżerem ds. sukcesów klienta i poproś o włączenie funkcji przechowywania interfejsu API dla konta.
Więcej informacji na temat włączania funkcji przechowywania dla konta można znaleźć na stronie Adobe Sign - przechowywanie dokumentu.
-
Zaloguj się jako administrator Adobe Sign i przejdź do strony: https://secure.adobesign.com/public/docs/restapi/v6
-
- Kliknij umowy i rozwiń metodę GET /agreements.
- Kliknij przycisk TOKEN DOSTĘPU OAUTH.
- Włącz zakres agreement_read:self.
- Kliknij przycisk Autoryzuj.
- W razie potrzeby kliknij opcję Zezwól na dostęp.
- Kliknij przycisk Wypróbuj!
-
Odpowiedź została wygenerowana.
Identyfikator umowy można znaleźć w treści odpowiedzi:
-
DELETE /agreements/{agreementId}/documents: usuwa wszystkie dokumenty związane z umową. Sama umowa pozostaje widoczna na stronie Zarządzaj.
- Wybierz operację DELETE/agreements, która ma zostać uruchomiona.
- Kliknij przycisk TOKEN DOSTĘPU OAUTH i utwórz token dostępu z zakresem areement_retention.
- Podaj identyfikator umowy, którą chcesz usunąć.
- Po usunięciu umowy treść odpowiedzi nie ma zawartości.
Jeśli operacja DELETE/agreements nie jest włączona, wyświetli się następująca odpowiedź:
"code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED",
"message": "The operation requires some account settings to be enabled. Please contact the Adobe Sign team to enable the settings."
Jak pobrać podpisany dokument wraz z raportem kontroli i dokumentem uzupełniającym za pośrednictwem interfejsu API REST usługi Adobe Sign, zamiast wykonywać osobne wywołanie do pobrania raportu kontroli za pomocą następującej metody.
-
Przejdź do stronyhttps://secure.na1.adobesign.com/public/docs/restapi/v5.
-
Kliknij opcję GET /agreements/{agreementId}/combinedDocument.
-
Kliknij przycisk Token dostępu OAuth.
-
Token dostępu jest generowany automatycznie po zaakceptowaniu autoryzacji.
-
Podaj identyfikator umowy.
-
W sekcji attachSupportingDocuments wybierz wartość „prawdziwe” z menu rozwijanego.
-
W sekcji attachAuditReport wybierz z menu rozwijanego wartość „prawdziwe”.
-
Kliknij przycisk Wypróbuj!
Pobiera połączony plik PDF z podpisanym dokumentem uzupełniającym i raportem kontroli.
Aby pobrać dokumenty zbiorcze, dostępne jest tylko narzędzie do eksportowania dokumentów. Interfejs API umożliwia tylko pobieranie dokumentów pojedynczo. Poniżej przedstawiono metodę interfejsu API:
https://secure.na1.adobesign.com/public/docs/restapi/v5#!/agreements/getCombinedDocument
Szablony biblioteki i formularze internetowe
-
Zaloguj się w usłudze Adobe Sign jako administrator i przejdź do strony: https://secure.na1.adobesign.com/public/docs/restapi/v6
-
- Kliknij element libraryDocuments i rozwiń metodę GET /libraryDocuments.
- Kliknij przycisk TOKEN DOSTĘPU OAUTH.
- Włącz zakres library_read:self.
- Kliknij przycisk Autoryzuj.
- W razie potrzeby kliknij opcję Zezwól na dostęp.
- Kliknij przycisk Wypróbuj!
-
Odpowiedź została wygenerowana.
Element libraryDocumentId można znaleźć w treści odpowiedzi:
Adobe ma nowy interfejs API PUT/libraryDocuments/ID/me/visibility, który pozwala kontrolować widoczność umowy (w GET /agreements). Oprócz funkcji dostępnych w poleceniu DELETE /agreements/ID nowy punkt końcowy widoczności umożliwia również cofnięcie operacji „ukryj”, czyli ponowne wyświetlenie umowy.
Można wykonać następujące szczegółowe kroki:
- Przejdź do metody get /libraryDocuments i pobierz identyfikator umowy.
- Kliknij opcję put /libraryDocuments/{libraryDocumentId}/me/visibility i podaj poniższe żądanie jako przykład:
{
"visibility": "HIDE"
}
Identyfikator biblioteki jest ukryty tylko w metodzie get /libraryDocuments, ale jest nadal widoczny w interfejsie karty Zarządzaj.
- Prześlij żądanie do zespołu pomocy technicznej, aby włączyć możliwość usuwania biblioteki.
- Interfejs API usuwa dokument w bibliotece. Nie ma to jednak wpływu na umowy utworzone za pomocą tego dokumentu w bibliotece.
Generowanie identyfikatora libraryDocumentID
-
Przejdź do strony https://secure.echosign.com/public/docs/restapi/v5.
-
Kliknij element libraryDocuments.
-
Kliknij przycisk Token dostępu OAuth.
Autoryzuj dostęp — token dla konta, grupy lub użytkownika.
-
Wybierz element libraryTemplateType — Document lub Form_field_layer.
-
Kliknij opcję Wypróbuj.
Dla wszystkich szablonów można otrzymać odpowiedź w następującej postaci: (Skopiuj element libraryDocumentId dla szablonu biblioteki, który chcesz usunąć).
{ "libraryDocumentList": [ { "name": "testing fields", "modifiedDate": "2017-08-04T01:06:05-07:00", "scope": "PERSONAL", "libraryDocumentId": "3AAABLblqZhAK53Dvzq88Q1Ov0TEvMAySDPpIVjF1PWgUpy0H1uYggt4iwGiRSZYlWfl9ms_AcmgZ_uZMPPN2hNT9izwaspHc", "libraryTemplateTypes": [ "DOCUMENT" ] },
Usuwanie szablonów biblioteki
-
Skopiuj element libraryDocumentID z treści odpowiedzi.
-
Przejdź do opcji Usuń dokumenty biblioteki.
-
Kliknij przycisk Token dostępu OAuth. Autoryzacja dostępu — token dla konta, grupy lub użytkownika.
-
Wklej identyfikator libraryDocumentId w polu Wartość.
-
Kliknij opcję Wypróbuj.
Szablon został usunięty.Otrzymany kod odpowiedzi: 204
Tylko formularze internetowe w stanie Wersja robocza mogą być aktualizowane.
-
Utwórz widżet, używając opcji post /widgets.
-
Pobierz identyfikator widżetu z opcji get/widgets.
-
Po utworzeniu za pomocą metody GET /widgets/{widgetId} pobierz element Etag z nagłówka odpowiedzi.
-
W ramach polecenia put /widgets/{widgetId} użyj elementu Etag z opcji GET /widgets/{widgetId}. Pod parametrem If-Match wprowadź wartości widgetId i widgetInfo.
{ "fileInfos": [ { "transientDocumentId": "******" } ], "name": "Widht_Name", "status": "DRAFT", "widgetParticipantSetInfo": { "memberInfos": [ { "email": "" } ], "role": "SIGNER" } }
-
Przykłady
-
Wykonaj wywołanie get/agreement z właściwym parametrem x-api-user.
-
W treści odpowiedzi znajdź umowę wysłaną do podpisania, dla której chcesz znaleźć adres URL podpisywania i zanotuj identyfikator umowy.
-
Wykonaj wywołanie get/agreements/{agreementId}/signingUrls, używając identyfikatora umowy otrzymanego z wywołania get/agreements.
Wynik
Dane wyjściowe zwracają adres e-mail sygnatariusza/sygnatariuszy i adres URL podpisu elektronicznego.