Podręcznik użytkownika Anuluj

Interfejs API Adobe Acrobat Sign — często zadawane pytania

 

Podręcznik Adobe Acrobat Sign

Nowości

  1. Informacje przed wydaniem
  2. Informacje o wydaniu
  3. Powiadomienia o imporcie

Pierwsze kroki

  1. Skrócona instrukcja dla administratorów
  2. Skrócona instrukcja dla użytkowników
  3. Dla programistów
  4. Biblioteka samouczków wideo
  5. Często zadawane pytania

Administrowanie

  1. Przegląd Admin Console
  2. Zarządzanie użytkownikami
    1. Dodawanie użytkowników
      1. Dodawanie użytkownika
      2. Zbiorcze dodawanie użytkowników
      3. Dodawanie użytkowników z katalogu
      4. Dodawanie użytkowników z katalogu MS Azure Active
    2. Tworzenie użytkowników w oparciu o funkcje
      1. Konta techniczne — oparte na interfejsie API
      2. Konta usług — oparte na obsłudze ręcznej
    3. Sprawdzanie pod kątem użytkowników z błędami obsługi
    4. Zmiana nazwiska/adresu e-mail
    5. Edytowanie członkostwa użytkownika w grupie
    6. Edytowanie członkostwa użytkownika w grupie za pomocą interfejsu grupy
    7. Awansowanie użytkownika do roli administratora
    8. Typy identyfikatorów użytkowników i SSO
    9. Przełączanie tożsamości użytkownika
    10. Uwierzytelnianie użytkowników z użyciem usługi MS Azure
    11. Uwierzytelnianie użytkowników z użyciem usługi Google Federation
    12. Profile produktowe
    13. Funkcja logowania 
  3. Ustawienia konta/grupy
    1. Przegląd ustawień
    2. Ustawienia globalne
      1. Poziom i identyfikator konta
      2. Nowy interfejs odbiorcy
      3. Obiegi pracy samodzielnego podpisywania
      4. Wysyłka zbiorcza
      5. Formularze internetowe
      6. Niestandardowe obiegi pracy wysyłania
      7. Obiegi pracy Power Automate
      8. Dokumenty w bibliotece
      9. Zbieranie danych formularzy za pomocą umów
      10. Ograniczona widoczność dokumentu
      11. Załączanie kopii PDF podpisanej umowy 
      12. Dołączanie łączy do wiadomości e-mail
      13. Dołączanie obrazu do wiadomości e-mail
      14. Pliki dołączone do wiadomości e-mail będą nazwane jako:
      15. Załączanie raportu kontroli do dokumentów
      16. Scalanie wielu dokumentów w jeden
      17. Pobierz pojedyncze dokumenty
      18. Przekaż podpisany dokument
      19. Delegacje dla użytkowników w moim koncie
      20. Zezwalanie odbiorcom zewnętrznym na delegowanie
      21. Upoważnienie do podpisania
      22. Upoważnienie do wysyłania
      23. Uprawnienia do dodawania pieczęci elektronicznych
      24. Ustawianie domyślnej strefy czasowej
      25. Ustawianie domyślnego formatu daty
      26. Użytkownicy w wielu grupach (UMG)
        1. Uaktualnianie do użycia UMG
      27. Uprawnienia administratora grupy
      28. Zastępowanie odbiorcy
      29. Raport kontroli
        1. Omówienie
        2. Zezwalanie na nieuwierzytelniony dostęp na stronie weryfikacji transakcji
        3. Uwzględnianie przypomnień
        4. Uwzględnianie zdarzeń widoku
        5. Uwzględnianie stron umowy / liczby załączników
      30. Stopka transakcji
      31. W komunikatach w produkcie i wskazówkach
      32. Przystępne pliki PDF
      33. Nowy sposób tworzenia
      34. Klient z sektora opieki zdrowotnej
    3. Konfiguracja konta
      1. Dodawanie logo
      2. Dostosowywanie nazwy hosta / adresu URL firmy 
      3. Dodawanie nazwy firmy
      4. Przekierowanie adresu URL po umowie
    4. Preferencje dotyczące podpisu
      1. Dobrze sformatowane podpisy
      2. Zezwalanie odbiorcom na podpisywanie przez
      3. Sygnatariusze mogą zmieniać imiona i nazwiska
      4. Zezwalanie odbiorcom na korzystanie z zapisanych podpisów
      5. Niestandardowe warunki użytkowania i warunki ujawnienia danych klienta
      6. Prowadzenie odbiorców między polami formularza
      7. Ponowne uruchamianie obiegu pracy umowy
      8. Odmowa podpisania
      9. Zezwalanie na obiegi pracy stempli
      10. Wymaganie od sygnatariuszy podania stanowiska lub firmy
      11. Zezwalanie sygnatariuszom na wydrukowanie i złożenie podpisu pisemnego
      12. Pokazanie wiadomości podczas składania elektronicznego podpisu
      13. Wymaganie tworzenia przez sygnatariuszy podpisów za pomocą urządzenia mobilnego
      14. Prośba sygnatariuszy o adres IP
      15. Wykluczanie nazwy firmy i stanowiska w stemplach uczestnictwa
    5. Podpisy cyfrowe
      1. Omówienie
      2. Pobieranie i podpisywanie za pomocą programu Acrobat
      3. Podpisywanie za pomocą podpisów opartych na chmurze
      4. Dołącz metadane dla dostawców tożsamości
      5. Dostawcy podpisów opartych na chmurze objęci ograniczeniami
    6. Pieczęcie elektroniczne
    7. Tożsamość cyfrowa
      1. Brama cyfrowej tożsamości
      2. Zasady sprawdzania tożsamości
    8. Ustawienia raportu
      1. Nowy sposób raportowania
      2. Klasyczne ustawienia raportu
    9. Ustawienia zabezpieczeń
      1. Ustawienia pojedynczego logowania
      2. Ustawienia opcji Pamiętaj mnie
      3. Zasady dotyczące hasła logowania
      4. Siła hasła logowania
      5. Czas trwania sesji internetowej
      6. Typ szyfrowania PDF
      7. API
      8. Dostęp do informacji o użytkowniku i grupie
      9. Dozwolone zakresy IP
      10. Udostępnianie konta
      11. Zezwolenia na udostępnianie konta
      12. Ustawienia udostępniania umów
      13. Weryfikacja tożsamości sygnatariusza
      14. Hasło podpisywania umowy
      15. Siła hasła dokumentu
      16. Blokowanie sygnatariuszy według geolokalizacji
      17. Uwierzytelnianie telefoniczne
      18. Uwierzytelnianie oparte na wiedzy (KBA)
      19. Zezwalanie na wyodrębnianie stron
      20. Wygaśnięcie łącza dokumentu
      21. Przesłanie certyfikatu klienta dla elementów webhook / wywołań zwrotnych
      22. Znacznik czasowy
    10. Ustawienia wysyłania
      1. Wyświetlanie strony Wyślij po zalogowaniu
      2. Wymaganie nazwy odbiorcy przy wysyłaniu
      3. Blokowanie wartości nazw dla znanych użytkowników
      4. Dozwolone role odbiorcy
      5. Zezwól na e-osoby poświadczające
      6. Grupy odbiorców
      7. DW
      8. Dostęp do umowy odbiorcy
      9. Wymagane pola
      10. Załączanie dokumentów
      11. Spłaszczenie pola
      12. Modyfikowanie umowy
      13. Nazwa umowy
      14. Języki
      15. Wiadomości prywatne
      16. Dopuszczalne typy podpisu
      17. Przypomnienia
      18. Zabezpieczenie hasłem podpisanego dokumentu
      19. Wysyłanie powiadomień o umowie za pośrednictwem
      20. Opcje identyfikacji sygnatariusza
        1. Omówienie
        2. Hasło podpisywania
        3. Hasło jednorazowe w wiadomości e-mail
        4. Uwierzytelnianie Acrobat Sign
        5. Uwierzytelnianie telefoniczne
        6. Podpis cyfrowy oparty na chmurze
        7. Uwierzytelnianie oparte na wiedzy
        8. Dokument tożsamości
        9. Raporty tożsamości sygnatariusza
      21. Ochrona zawartości
      22. Włączanie transakcji Notarize
      23. Wygasanie dokumentu
      24. Wyświetlanie, ustawianie podpisów i dodawanie pól formularza
      25. Kolejność podpisywania
      26. Liquid Mode
      27. Niestandardowe elementy sterujące obiegiem pracy
      28. Opcje przesyłania na stronie podpisu elektronicznego
      29. Przekierowanie na inny adres URL potwierdzenia po podpisaniu
    11. Szablony wiadomości
    12. Ustawienia Bio-Pharma
      1. Omówienie
      2. Wymuszanie uwierzytelnienia tożsamości
      3. Powody podpisania
    13. Integracja obiegu pracy
    14. Ustawienia notarializacji
    15. Integracja płatności
    16. Wiadomości sygnatariusza
    17. Ustawienia SAML
      1. Konfiguracja SAML
      2. Instalacja usługi federacyjnej Microsoft Active Directory
      3. Instalacja usługi Okta
      4. Instalacja usługi OneLogin
      5. Instalacja usługi Oracle Identity Federation
    18. Zarządzanie danymi
    19. Ustawienia znacznika czasowego
    20. Archiwum zewnętrzne
    21. Języki konta
    22. Ustawienia poczty e-mail
      1. Obrazy nagłówka/stopki wiadomości e-mail
      2. Zezwalanie na stopki wiadomości e-mail poszczególnych użytkowników
      3. Dostosowywanie wiadomości e-mail z prośbą o podpisanie
      4. Dostosowywanie pól Do i DW
      5. Włączanie powiadomień bez łączy
      6. Dostosowywanie szablonów wiadomości e-mail
    23. Migracja z domeny echosign.com do adobesign.com
    24. Konfiguracja opcji dla odbiorców
  4. Wytyczne dotyczące wymogów regulacyjnych
    1. Dostępność
      1. Zgodność dostępności
      2. Tworzenie formularzy z ułatwieniami dostępu za pomocą programu Acrobat na komputery
      3. Tworzenie formularzy AcroForms z ułatwieniami dostępu
    2. HIPAA
    3. RODO
      1. RODO — omówienie
      2. Poprawianie użytkownika
      3. Poprawianie umów użytkownika .  
    4. 21 CFR część 11 i załącznik 11 EudraLex
      1. 21 pakiet walidacyjny CRF część 11
      2. Podręcznik 21 CFR i załącznik 11 EudraLex
      3. Analiza wspólnych obowiązków
    5. Klienci z sektora opieki zdrowotnej
    6. Obsługa IVES
    7. Umowy „archiwizowane”
    8. Kwestie do rozważenia w UE/Wielkiej Brytanii
      1. Transakcje transgraniczne między UE a Wielką Brytanią i eIDAS
      2. Wymagania dotyczące HMLR w odniesieniu do dokumentów podpisanych elektronicznie
      3. Wpływ Brexitu na przepisy dotyczące podpisu elektronicznego w Wielkiej Brytanii
  5. Zbiorcze pobieranie umów
  6. Przypisywanie domeny
  7. Łącza zgłaszania nadużycia

Wysyłanie i podpisywanie umów oraz zarządzanie nimi

  1. Opcje odbiorcy
    1. Anulowanie przypomnienia e-mail
    2. Opcje na stronie podpisu elektronicznego
      1. Przegląd strony podpisu elektronicznego
      2. Otwieranie w celu przeczytania umowy bez pól
      3. Odmowa podpisania umowy
      4. Delegowanie uprawnienia do podpisywania
      5. Ponowne uruchamianie umowy
      6. Pobieranie pliku PDF umowy
      7. Wyświetlanie historii umowy
      8. Wyświetlanie wiadomości umowy
      9. Konwertowanie z podpisu elektronicznego na pisemny
      10. Konwertowanie z podpisu pisemnego na podpis elektroniczny
      11. Nawigowanie po polach formularza
      12. Czyszczenie danych z pól formularza
      13. Powiększenie strony podpisu elektronicznego i nawigacja po niej
      14. Zmiana języka używanego w narzędziach i informacjach dotyczących umowy
      15. Przegląd informacji prawnych
      16. Dostosowywanie preferencji plików cookie Acrobat Sign
  2. Wysyłanie umów  
    1. Omówienie strony Wyślij
    2. Wysyłanie umowy wyłącznie do siebie
    3. Wysyłanie umów do innych osób
    4. Podpisy pisemne
    5. Kolejność podpisywania przez odbiorców
    6. Wysyłka zbiorcza
      1. Omówienie funkcji Wyślij zbiorczo
      2. Wysyłka zbiorcza – konfiguracja szablonu nadrzędnego
      3. Wysyłka zbiorcza – konfiguracja pliku CSV
      4. Anulowanie transakcji Wyślij zbiorczo
      5. Dodawanie przypomnień do funkcji Wyślij zbiorczo
      6. Raportowanie dla wysyłki zbiorczej
  3. Tworzenie pól w dokumentach
    1. Środowisko tworzenia w aplikacji
      1. Automatyczne wykrywanie pól
      2. Przeciąganie i upuszczanie pól za pomocą środowiska tworzenia
      3. Przypisywanie pól formularza do odbiorców
      4. Rola Wstępne wypełnianie
      5. Stosowanie pól z szablonem pola wielokrotnego użytku
      6. Przenoszenie pól do nowego szablonu biblioteki
      7. Zaktualizowano środowisko tworzenia podczas wysyłania umów
    2. Tworzenie formularzy ze znacznikami tekstowymi
    3. Tworzenie formularzy przy pomocy programu Acrobat (AcroForm)
      1. Tworzenie formularzy AcroForm
      2. Tworzenie dostępnych dokumentów PDF
    4. Pola
      1. Typy pól
        1. Typowe typy pól
        2. Obrazy w wierszu
        3. Obrazy stempli
      2. Wygląd zawartości pola
      3. Weryfikacja pola
      4. Wartości zamaskowanych pól
      5. Ustawianie warunków wyświetlania/ukrywania
      6. Pole obliczeniowe
    5. Tworzenie często zadawanych pytań
  4. Podpisywanie umów
    1. Podpisywanie umów wysłanych do Ciebie
    2. Wypełnij i podpisz
    3. Podpis automatyczny
  5. Zarządzaj umowami
    1. Omówienie strony Zarządzaj
    2. Delegowanie umowy
    3. Zastępowanie odbiorców
    4. Ograniczona widoczność dokumentu
    5. Anulowanie umowy 
    6. Tworzenie nowych przypomnień
    7. Przeglądanie przypomnień
    8. Anulowanie przypomnienia
    9. Dostęp do obiegów Power Automate
    10. Więcej operacji…
      1. Działanie wyszukiwania
      2. Wyświetlanie umowy
      3. Tworzenie szablonu na podstawie umowy
      4. Ukrywanie/pokazywanie umów z widoku
      5. Przesyłanie podpisanej umowy
      6. Modyfikowanie plików i pól w wysłanych umowach
      7. Edytowanie sposobu uwierzytelniania odbiorcy
      8. Dodawanie lub modyfikacja daty wygaśnięcia
      9. Dodawanie uwagi do umowy
      10. Udostępnianie indywidualnej umowy
      11. Anulowanie udostępniania umowy
      12. Pobieranie poszczególnych umów
      13. Pobieranie pojedynczych plików umowy
      14. Pobieranie raportu kontroli dla umowy
      15. Pobieranie zawartości pola w umowie
  6. Raport kontroli
  7. Raportowanie i eksportowanie danych
    1. Omówienie
    2. Udzielanie użytkownikom dostępu do raportowania
    3. Wykresy raportu
      1. Tworzenie nowego raportu
      2. Raporty dotyczące umów
      3. Raporty transakcji
      4. Raport aktywności dotyczących ustawień
      5. Edycja raportu
    4. Eksport danych 
      1. Tworzenie nowego eksportu danych
      2. Eksport danych formularza internetowego
      3. Edytowanie eksportu danych
      4. Odświeżanie zawartości eksportu danych
      5. Pobieranie eksportu danych
    5. Zmiana nazwy raportu/eksportu
    6. Powielanie raportu/eksportu
    7. Planowanie raportu/eksportu
    8. Usuwanie raportu/eksportu
    9. Sprawdzanie użycia transakcji

Zaawansowane możliwości umów i obiegów pracy

  1. Formularze internetowe 
    1. Tworzenie formularza internetowego
    2. Edycja formularza internetowego
    3. Wyłączanie/włączanie formularza internetowego
    4. Ukrywanie/pokazywanie formularza internetowego
    5. Znajdowanie adresu URL lub kodu skryptu 
    6. Wstępne wypełnianie pól formularza internetowego przy użyciu parametrów adresu URL
    7. Zapisywanie formularza internetowego do późniejszego wypełnienia
    8. Zmiana rozmiaru formularza internetowego
  2. Szablony wielokrotnego użytku (Szablony biblioteki) 
    1. Amerykańskie formularze urzędowe w bibliotece Acrobat Sign
    2. Tworzenie szablonu biblioteki
    3. Zmiana nazwy szablonu biblioteki
    4. Zmiana typu szablonu biblioteki
    5. Zmiana poziomu uprawnień szablonu biblioteki
    6. Kopiowanie, edytowanie i zapisywanie udostępnionego szablonu
    7. Pobieranie zagregowanych danych pól szablonu biblioteki
  3. Przenoszenie własności formularzy internetowych i szablonów bibliotek
  4. Obiegi pracy Power Automate
    1. Przegląd integracji Power Automate i dołączonych uprawnień
    2. Włączanie integracji usługi Power Automate
    3. Akcje kontekstowe na stronie Zarządzaj
    4. Śledzenie wykorzystania pakietu Power Automate
    5. Tworzenie nowego obiegu (przykłady)
    6. Aktywatory używane dla obiegów
    7. Importowanie obiegów spoza Acrobat Sign
    8. Zarządzanie obiegami
    9. Edycja obiegów
    10. Udostępnianie obiegów
    11. Wyłączanie lub włączanie obiegów
    12. Usuwanie obiegów
    13. Przydatne szablony
      1. Tylko administrator
        1. Zapisywanie wszystkich ukończonych dokumentów w usłudze SharePoint
        2. Zapisywanie wszystkich ukończonych dokumentów w usłudze OneDrive dla firm
        3. Zapisywanie wszystkich ukończonych dokumentów na Dysku Google
        4. Zapisywanie wszystkich ukończonych dokumentów w usłudze DropBox
        5. Zapisywanie wszystkich ukończonych dokumentów w usłudze Box
      2. Archiwizacja umowy
        1. Zapisywanie ukończonych dokumentów w usłudze SharePoint
        2. Zapisywanie ukończonych dokumentów w usłudze OneDrive dla firm
        3. Zapisywanie ukończonych dokumentów na Dysku Google
        4. Zapisywanie ukończonych dokumentów w usłudze DropBox
        5. Zapisywanie ukończonych dokumentów w Box
      3. Archiwizacja umowy formularza internetowego
        1. Zapisywanie ukończonych dokumentów formularzy internetowych w bibliotece SharePoint
        2. Zapisywanie ukończonych dokumentów formularzy internetowych w usłudze OneDrive dla firm
        3. Zapisywanie ukończonych dokumentów na dysku Google
        4. Zapisywanie ukończonych dokumentów formularzy internetowych w usłudze Box
      4. Wyodrębnianie danych umowy
        1. Wyodrębnianie danych pól formularza z podpisanego dokumentu i aktualizowanie arkusza Excel
      5. Powiadomienia o umowach
        1. Wysyłanie niestandardowych powiadomień mailowych z zawartością umowy i podpisaną umową
        2. Otrzymywanie powiadomień Adobe Acrobat Sign w kanale usługi Teams
        3. Otrzymywanie powiadomień Adobe Acrobat Sign w usłudze Slack
        4. Otrzymywanie powiadomień Adobe Acrobat Sign w usłudze Webex
      6. Generowanie umów
        1. Wygenerowanie dokumentu z formularza Power App i szablonu Word, wysłanie do podpisu
        2. Wygenerowanie umowy z szablonu programu Word w usłudze OneDrive i uzyskanie podpisu
        3. Wygenerowanie umowy dla wybranego wiersza programu Excel, wysłanie do recenzji i podpisu
  5. Niestandardowe obiegi pracy wysyłania
    1. Przegląd niestandardowych obiegów pracy wysyłania
    2. Tworzenie nowego obiegu pracy wysyłania
    3. Edytowanie obiegu pracy wysyłania
    4. Aktywacja lub dezaktywacja obiegu pracy wysyłania
    5. Wysyłanie umowy za pomocą obiegu pracy wysyłania
  6. Udostępnianie użytkowników i umów
    1. Udostępnianie użytkownika
    2. Udostępnianie umów

Integracja z innymi produktami

  1.  Przegląd integracji Acrobat Sign 
  2. Acrobat Sign dla Salesforce
  3. Acrobat Sign dla Microsoft
    1. Acrobat Sign dla Microsoft 365
    2. Acrobat Sign dla Outlook
    3. Acrobat Sign dla programu Word/PowerPoint
    4. Acrobat Sign dla Teams
    5. Acrobat Sign dla Microsoft PowerApps i Power Automate
    6. Łącznik Acrobat Sign dla Microsoft Search
    7. Acrobat Sign dla Microsoft Dynamics
    8. Acrobat Sign dla Microsoft SharePoint
  4. Inne integracje
    1. Acrobat Sign dla ServiceNow
    2. Acrobat Sign dla HR ServiceNow
    3. Acrobat Sign dla SAP SuccessFactors
    4. Acrobat Sign dla oprogramowania Workday
    5. Acrobat Sign dla NetSuite
    6. Acrobat Sign dla VeevaVault
    7. Acrobat Sign dla Coupa BSM Suite
  5. Integracje zarządzane przez partnerów
  6. Jak uzyskać klucz integracji

Programista Acrobat Sign

  1. Interfejsy API REST 
    1. Dokumentacja metody
    2. SDK/podręcznik dla programistów
    3. Często zadawane pytania dotyczące interfejsu API
  2. Elementy webhook 
    1. Omówienie elementu webhook
    2. Konfiguracja nowego elementu webhook
    3. Wyświetlanie lub edytowanie elementu webhook
    4. Dezaktywacja lub ponowna aktywacja elementu webhook
    5. Usuwanie elementu webhook
    6. Certyfikaty dwukierunkowego SSL
    7. Elementy webhook w API

Pomoc techniczna i rozwiązywanie problemów

  1. Zasoby obsługi klienta 
  2. Zasoby dotyczące sukcesów klientów korporacyjnych 

Dostęp do interfejsu API jest zarezerwowany wyłącznie dla kont na licencji dla przedsiębiorstw i deweloperskiej.

Łącza do podstawowej dokumentacji

Uwaga:

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.

  1. Zaloguj się do Adobe Sign jako administrator.

  2. Wybierz kolejno Konto > Interfejs API Adobe Sign > Dziennik żądań API.

    Dzienniki interfejsu API

  1.  Zaloguj się do konta Adobe Sign jako administrator.

  2. Wybierz kolejno Konto > Interfejs API Adobe Sign > Informacje o API.

  3. 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

  1. Dodaj (-Dsoapui.https.protocols=SSLv3,TLSv1.2) do pliku VMOPTIONS w folderze Kosz.

  2. 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)

  3. W pliku VMOPTIONS włącz pełne uprawnienia do odczytu/zapisu pliku.

    VMOPTIONS

  4. 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.

  5. Powtórz tę czynność dla administratorów, systemów i wszystkich pakietów aplikacji.

  6. Otwórz plik za pomocą programu Notatnik.

  7. Dodaj ten protokół na dole „-Dsoapui.https.protocols=SSLv3,TLSv1.2” i zapisz zmiany.

  8. 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:

  1. Zaloguj się do swojego konta Adobe Sign.

  2. Wybierz kolejno Konto > Interfejs API Adobe Sign > Aplikacje API.

    Fnord.

  3. Aby utworzyć aplikację, kliknij ikonę +.

    Fnord.

  4. Wprowadź nazwę i nazwę wyświetlaną.

  5. W obszarze Domena wybierz opcję KLIENT i kliknij przycisk Zapisz.

    Fnord.

  6. Podświetl aplikację jednym kliknięciem.

  7. Kliknij opcję Skonfiguruj OAuth dla aplikacji.

    Fnord.

  8. Wprowadź identyfikator URI przekierowania.

  9. Aby włączyć wymagane zakresy, zaznacz odpowiednie pola wyboru i kliknij przycisk Zapisz.

  1. Zaloguj się do Adobe Sign jako administrator konta.

  2. Wybierz kolejno Konto > Interfejs API Adobe Sign > Informacje o API.

  3. Kliknij łącze Klucz integracji.

    Przejdź do opcji 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.
    Interfejs Utwórz klucz integracji

  4. 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
    Tokeny dostępu — klucz integracji

  1. Zaloguj się do swojego konta Adobe Sign.

  2. Wybierz kolejno Konto > Interfejs API Adobe Sign > Aplikacje API.

  3. Kliknij ikonę +, aby utworzyć aplikację.

    Postman1

  4. Kliknij opcję Skonfiguruj OAuth dla aplikacji.

    Fnord.

  5. 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

  6. Jeśli wywołanie zakończy się pomyślnie, wybierz kod autoryzacji z paska adresu.

    Fnord.

  7. Pobierz i zainstaluj aplikację Postman, korzystając z łącza https://www.getpostman.com/apps.

  8. Po pobraniu i zainstalowaniu kliknij opcję NOWY, aby utworzyć POST.

  9. Otwórz łącze https://secure.na1.echosign.com/oauth/token zgodnie z przynależnością konta Adobe Sign.

  10. W sekcji Nagłówki wpisz Content-Type jako application/x-www-form-urlencoded.

  11. 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.

    Fnord.

  12. Jeśli wszystkie informacje są poprawne, w odpowiedzi zwracany jest token dostępu i odświeżania:

    Fnord.

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:

  1. Zaloguj się za pomocą konta Microsoft https://portal.azure.com/.

  2. Zarejestruj się w celu korzystania z aplikacji funkcyjnych na koncie usługi AzureAD.

    Menu usługi Azure

  3. Przejdź do usługi AzureAD i wybierz kolejno opcje Aplikacje funkcyjne > Kliknij ikonę + dla funkcji.

  4. Wybierz Webhook+API z językiem JavaScript i kliknij opcję Utwórz funkcję.

    Interfejs użytkownika API usługi Azure

  5. 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(); 
    };
  6. Kliknij przycisk Test w prawym rogu i podaj następujący nagłówek:

    X-AdobeSign-ClientId jako *************************

    Test interfejsu API

  7. Kliknij przycisk Zapisz i uruchom.

  8. Po otrzymaniu odpowiedzi 200 OK z następującym nagłówkiem kliknij przycisk Pobierz adres URL funkcji.

    Odpowiedź 200

  9. Skopiuj adres URL i przejdź do interfejsu użytkownika Adobe Sign > Elementy webhook > Kliknij ikonę +, aby utworzyć.

  10. 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.
    Interfejs użytkownika elementu webhook

  11. 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.

  1. Otwórz dokumentację dotyczącą interfejsu API REST w wersji 5.

  2. Przejdź do zdarzenia post/search/agreementAssetEvents i wygeneruj token dostępu z odpowiednimi zakresami.

  3. 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" 
    }
  4. 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

  1. Zaloguj się w usłudze Adobe Sign.
  2. Wybierz kolejno Konto > Interfejs API Adobe Sign > Dokumentacja dotycząca interfejsu API REST.
  3. Wybierz opcję Wersja 5.
  4. 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:

 

Pobieranie identyfikatora grupy:

  1. Przejdź do strony https://secure.na1.echosign.com/public/docs/restapi/v5.

  2. W obszarze Zasoby i operacje kliknij opcję Grupy.

  3. Kliknij opcję GET /groups.

  4. Kliknij przycisk Token dostępu OAuth.

  5. Wygeneruj token dostępu.

  6. 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:

  1. Kliknij opcję DELETE /groups/{groupId}.

  2. Aby wygenerować token dostępu, kliknij przycisk Token dostępu OAuth.

  3. W polu groupId dodaj identyfikator grupy otrzymany w odpowiedzi na poprzednie wywołanie, która ma zostać usunięta.

  4. Kliknij opcję Wypróbuj.

    Po usunięciu grupy otrzymasz odpowiedź: Brak zawartości

Uwaga:

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

  1. Kliknij ciąg transientDocuments i rozwiń metodę POST /transientDocuments.

  2. Kliknij przycisk Token dostępu OAuth.

    Metoda TransientDocument interfejsu API

    • Włącz zakresy dla transakcji.
    • Kliknij przycisk Autoryzuj.
    Zakresy OAuth

  3. Zezwól na dostęp

    W razie potrzeby kliknij opcję Zezwól na dostęp.

  4. 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!
    Wypróbuj!

  5. Odpowiedź została wygenerowana.

    Identyfikator dokumentu przejściowego można znaleźć w treści odpowiedzi:

    Identyfikator dokumentu przejściowego

Generowanie umowy przy użyciu dokumentu przejściowego

  1. 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.
  2. 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!
    Metoda umowy POST

  3. Odpowiedź została wygenerowana.

    Identyfikator umowy można znaleźć w treści odpowiedzi:

    Odpowiedź na metodę umowy POST

Poniżej przedstawiono kroki dotyczące dodawania plików do parametru FileInfo:

  1. 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": "" 
         } 
       ],
  2. 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": "",
  3. 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": "" 
          },
  1. Wybierz opcję Umowy > POST/agreements. 

  2. Wybierz opcję Token dostępu OAuth i podaj wymagane zakresy.

  3. 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"

  }

}

Uwaga:

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:

  1. W obszarze transientDocuments kliknij metodę POST /transientDocuments.

  2. Aby wygenerować token dla autoryzacji, kliknij przycisk OAUTH ACCESS-TOKEN.

  3. 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

  4. 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:

  1. W obszarze Umowy kliknij opcję POST /agreements.

  2. Aby wygenerować token do autoryzacji, kliknij przycisk OAUTH ACCESS-TOKEN.

  3. W polu x-on-behalf-of-user podaj adres e-mail użytkownika, który podano podczas tworzenia dokumentu przejściowego.

  4. 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" 
      
    }
  1. Zaloguj się w usłudze Adobe Sign.

  2. Przejdź do Konto>Interfejs API Adobe Sign>Informacje o API i kliknij opcję Dokumentacja dotycząca metody interfejsu API REST.

    Interfejs użytkownika elementu webhook

  3. POST /transientDocuments i przesłanie pliku oraz utworzenie przejściowego identyfikatora dokumentu.

  4. 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 
            }] 
        } 
    }
  5. Aby wykonać żądanie JSON, kliknij przycisk Wypróbuj.

    Interfejs użytkownika elementu webhook

    Prawidłowe żądanie JSON zwraca odpowiedź z identyfikatorem umowy.

    Interfejs użytkownika elementu webhook

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:

  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. 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.

  1. Zaloguj się w usłudze Adobe Sign.

  2. Przejdź do Konto>Interfejs API Adobe Sign>Informacje o API i kliknij opcję Dokumentacja dotycząca metody interfejsu API REST.

    Interfejs użytkownika elementu webhook

  3. POST /transientDocuments i przesłanie pliku oraz utworzenie przejściowego identyfikatora dokumentu.

  4. 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 
      
                } 
            ] 
        } 
    }
  5. Aby wykonać żądanie JSON, kliknij przycisk Wypróbuj.

    Interfejs użytkownika elementu webhook

    Prawidłowe żądanie JSON zwraca odpowiedź z identyfikatorem umowy.

    Interfejs użytkownika elementu webhook

  1. Zaloguj się w usłudze Adobe Sign.

  2. Przejdź do Konto>Interfejs API Adobe Sign>Informacje o API i kliknij opcję Dokumentacja dotycząca metody interfejsu API REST.

    Fnord.

  3. POST /transientDocuments i przesłanie pliku oraz utworzenie przejściowego identyfikatora dokumentu.

  4. 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" 
            }] 
        } 
    }
  5. Aby wykonać żądanie JSON, kliknij przycisk Wypróbuj.

    Fnord.

    Prawidłowe żądanie JSON zwraca odpowiedź z identyfikatorem umowy.

    Fnord.

  6. Aby otworzyć umowę w trybie tworzenia, skopiuj adres URL i wklej go do paska adresu przeglądarki.

  7. Przeciągnij i upuść pola formularza w odpowiednim miejscu.

  8. 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:

  1. Identyfikator dokumentu przejściowego
  2. 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:

  1. Przejdź do dokumentacji dotyczącej interfejsu API REST w wersji 6 i wybierz metodę  
    put /megaSigns/{megaSignId}/state.
  2. 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"
  3. {
      "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:

  1. 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.
  2. 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.

Ta zawartość jest licencjonowana na podstawie licencji Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  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:

  1. Pobierz identyfikator umowy za pomocą metody POST/Agreement.

  2. Użyj polecenia Get /agreements/{agreementId}, aby pobrać najnowszy element ETag.

  3. 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:

  1. Przejdź do metody get/agreements i pobierz identyfikator umowy.
  2. 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.
Uwaga:

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.

  1. 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!
    Metoda Get Agreement

  2. Odpowiedź została wygenerowana.

    Identyfikator umowy można znaleźć w treści odpowiedzi:

    Odpowiedź Get Agreement

  3. 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.

GET /agreements/{agreementId}/auditTrail

  1. Kliknij opcję GET /agreements/{agreementId}/combinedDocument.

  2. Kliknij przycisk Token dostępu OAuth.

  3. Token dostępu jest generowany automatycznie po zaakceptowaniu autoryzacji.

  4. Podaj identyfikator umowy.

  5. W sekcji attachSupportingDocuments wybierz wartość „prawdziwe” z menu rozwijanego.

  6. W sekcji attachAuditReport wybierz z menu rozwijanego wartość „prawdziwe”.

  7. Kliknij przycisk Wypróbuj! 

    Łączenie dokumentów

    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

  1. 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!
    Metoda Get LibraryDocument

  2. Odpowiedź została wygenerowana.

    Element libraryDocumentId można znaleźć w treści odpowiedzi:

    Odpowiedź Get LibraryDocument

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:

  1. Przejdź do metody get /libraryDocuments i pobierz identyfikator umowy.
  2. 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.
Uwaga:
  • 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

  1. Przejdź do strony https://secure.echosign.com/public/docs/restapi/v5.

  2. Kliknij element libraryDocuments.

  3. Kliknij przycisk Token dostępu OAuth

    Autoryzuj dostęp — token dla konta, grupy lub użytkownika.

  4. Wybierz element libraryTemplateType — Document lub Form_field_layer.

  5. 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

  1. Skopiuj element libraryDocumentID z treści odpowiedzi.

  2. Przejdź do opcji Usuń dokumenty biblioteki.

  3. Kliknij przycisk Token dostępu OAuth. Autoryzacja dostępu — token dla konta, grupy lub użytkownika.

  4. Wklej identyfikator libraryDocumentId w polu Wartość.

  5. Kliknij opcję Wypróbuj. 
    Szablon został usunięty.

    Otrzymany kod odpowiedzi: 204

Uwaga:

Tylko formularze internetowe w stanie Wersja robocza mogą być aktualizowane.

  1. Utwórz widżet, używając opcji post /widgets.

  2. Pobierz identyfikator widżetu z opcji get/widgets.

  3. Po utworzeniu za pomocą metody GET /widgets/{widgetId} pobierz element Etag z nagłówka odpowiedzi.

    Foo

  4. 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.

    Foo

    { 
      "fileInfos": [ 
        { 
          "transientDocumentId": "******" 
        } 
      ], 
      "name": "Widht_Name", 
      "status": "DRAFT", 
      "widgetParticipantSetInfo": { 
        "memberInfos": [ 
          { 
            "email": "" 
          } 
        ], 
        "role": "SIGNER" 
      } 
    }


Przykłady

  1. Wykonaj wywołanie get/agreement z właściwym parametrem x-api-user.

  2. W treści odpowiedzi znajdź umowę wysłaną do podpisania, dla której chcesz znaleźć adres URL podpisywania i zanotuj identyfikator umowy.

  3. 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.

    Metoda Get Agreement

Pomoc dostępna szybciej i łatwiej

Nowy użytkownik?