Příručka uživatele Zrušit

Rozhraní API služby Adobe Acrobat Sign – časté dotazy

 

Příručka služby Adobe Acrobat Sign

Co je nového

  1. Poznámky před vydáním
  2. Poznámky k vydání
  3. Důležitá oznámení

Začínáme

  1. Stručný návod pro správce
  2. Stručný návod pro uživatele
  3. Pro vývojáře
  4. Knihovna výukových videí
  5. Časté dotazy

Správa

  1. Přehled konzole Admin Console
  2. Správa uživatelů
    1. Přidání uživatelů
      1. Přidání uživatele
      2. Hromadné přidání uživatelů
      3. Přidání uživatelů z adresáře
      4. Přidání uživatelů ze služby MS Azure Active Directory
    2. Vytváření uživatelů zaměřených na funkce
      1. Technické účty – řízené rozhraním API
      2. Účty služeb – řízené ručně
    3. Kontrola uživatelů s chybami zřizování
    4. Změna jména/e-mailové adresy
    5. Úprava členství uživatele ve skupině
    6. Úprava členství uživatele ve skupině prostřednictvím rozhraní skupiny
    7. Povýšení uživatele do role správce
    8. Typy identit uživatelů a jednotné přihlašování
    9. Přepnutí identity uživatele
    10. Ověření uživatelů pomocí služby MS Azure
    11. Ověření uživatelů pomocí služby Google Federation
    12. Profily produktů
    13. Prostředí pro přihlášení 
  3. Nastavení účtu/skupiny
    1. Přehled nastavení
    2. Globální nastavení
      1. Úroveň a ID účtu
      2. Nové prostředí příjemce
      3. Pracovní postupy pro podepisování sám sebou
      4. Hromadné odeslání
      5. Webové formuláře
      6. Vlastní pracovní postupy odeslání
      7. Pracovní postupy služby Power Automate
      8. Dokumenty knihovny
      9. Shromažďování údajů o formulářích s dohodami
      10. Omezená viditelnost dokumentu
      11. Připojení kopie podepsané dohody ve formátu PDF 
      12. Přidání odkazu do e-mailu
      13. Přidání obrázku do e-mailu
      14. Soubory připojené k e-mailu budou pojmenovány jako
      15. Připojení sestav auditů k dokumentům
      16. Sloučení více dokumentů do jednoho
      17. Stažení jednotlivých dokumentů
      18. Nahrání podepsaného dokumentu
      19. Delegování pro uživatele v mém účtu
      20. Povolení delegování externích příjemců
      21. Oprávnění k podpisu
      22. Oprávnění k odeslání
      23. Oprávnění přidávat elektronické pečeti
      24. Nastavení časového pásma
      25. Nastavení výchozího formátu data
      26. Uživatelé ve více skupinách (UMG)
        1. Upgrade na použití UMG
      27. Oprávnění správce skupiny
      28. Nahrazení příjemce
      29. Sestava auditu
        1. Přehled
        2. Povolení neověřeného přístupu na stránce ověření transakce
        3. Zahrnutí připomenutí
        4. Zahrnutí událostí zobrazení
        5. Zahrnutí stránky dohody / počtu příloh
      30. Zápatí transakce
      31. Zprávy v produktu a nápověda
      32. Přístupné soubory PDF
      33. Nový způsob podepisování
      34. Zákazník ve zdravotnictví
    3. Nastavení účtu
      1. Přidání loga
      2. Úprava názvu hostitele / adresy URL společnosti    
      3. Přidání názvu společnosti
      4. Přesměrování na adresu URL po dokončení dohody
    4. Preference podpisu
      1. Dobře formátované podpisy
      2. Povolení příjemcům podepisovat podle
      3. Podepisující mohou změnit své jméno
      4. Povolení příjemcům použít jejich uložený podpis
      5. Vlastní podmínky používání a právo požadovat podpis
      6. Procházení příjemců mezi poli formuláře
      7. Restart pracovního postupu dohody
      8. Odmítnutí podepsat
      9. Povolení pracovních postupů s razítkem
      10. Vyžádání od podepisujících uvedení pozice nebo společnosti
      11. Umožnění podepisujícím vytisknout a umístit vlastnoruční podpis
      12. Zobrazení zpráv při e-podepisování
      13. Vyžádání, aby podepisující k vytvoření svého podpisu použili mobilní zařízení
      14. Vyžádání IP adresy od podepisujících
      15. Vyloučení názvu společnosti a pozice na razítkách účastníků
    5. Digitální podpisy
      1. Přehled
      2. Stažení a podepsání v aplikaci Acrobat
      3. Podepisování cloudovými podpisy
      4. Zahrnutí metadat pro poskytovatele identity
      5. Omezení cloudoví poskytovatelé podpisů
    6. Elektronické pečeti
    7. Digitální identita
      1. Brána k ověření digitální identity
      2. Zásady kontroly identity
    8. Nastavení sestav
      1. Nové prostředí pro sestavy
      2. Nastavení klasické sestavy
    9. Nastavení zabezpečení
      1. Nastavení jednotného přihlašování
      2. Nastavení Zapamatovat si mne
      3. Zásady hesla pro přihlášení
      4. Síla hesla pro přihlášení
      5. Doba trvání webové relace
      6. Typ šifrování PDF
      7. API
      8. Přístup k informacím o uživateli a skupině
      9. Povolení rozsahů IP
      10. Sdílení účtů
      11. Oprávnění ke sdílení účtů
      12. Ovládací prvky sdílení dohod
      13. Ověření identity podepisujícího
      14. Heslo pro podepisování dohody
      15. Síla hesla dokumentu
      16. Blokování podepisujících podle geografického umístění
      17. Telefonické ověření
      18. Ověření na základě znalostí (KBA)
      19. Povolení vyjmutí stránek
      20. Vypršení platnosti odkazu na dokument
      21. Nahrání klientského certifikátu pro webhooky/zpětná volání
      22. Časové razítko
    10. Nastavení odeslání
      1. Zobrazení stránky Odeslat po přihlášení
      2. Vyžádání jména příjemce při odesílání
      3. Uzamknutí hodnot jména známých uživatelů
      4. Povolené role příjemce
      5. Povolení elektronických osvědčujících
      6. Skupiny příjemců
      7. Kopie
      8. Přístup příjemce k dohodě
      9. Povinná pole
      10. Připojování dokumentů
      11. Slučování polí
      12. Změny dohod
      13. Název dohody
      14. Jazyky
      15. Soukromé zprávy
      16. Povolené typy podpisů
      17. Připomenutí
      18. Ochrana podepsaného dokumentu heslem
      19. Odeslání oznámení o dohodě
      20. Možnosti identifikace podepisujícího
        1. Přehled
        2. Heslo pro podpis
        3. Jednorázové heslo prostřednictvím e-mailu
        4. Ověřování službou Acrobat Sign
        5. Telefonické ověření
        6. Cloudový digitální podpis
        7. Ověření založené na znalostech
        8. Průkaz totožnosti
        9. Sestavy totožnosti podepisujících
      21. Ochrana obsahu
      22. Povolení notářských transakcí
      23. Ukončení platnosti dokumentu
      24. Zobrazení náhledu, umístění podpisů a přidání polí
      25. Pořadí podepisování
      26. Liquid Mode
      27. Ovládací prvky vlastního pracovního postupu
      28. Možnosti nahrání na stránce elektronického podpisu
      29. Přesměrování adresy URL potvrzení po podepsání
    11. Šablony zpráv
    12. Nastavení pro biofarmacii
      1. Přehled
      2. Vynucení ověření identity
      3. Důvody podepsání
    13. Integrace pracovních postupů
    14. Nastavení služby Notarize
    15. Integrace plateb
    16. Zprávy podepisujícího
    17. Nastavení protokolu SAML
      1. Konfigurace SAML
      2. Instalace služby Microsoft Active Directory Federation Service
      3. Instalace aplikace Okta
      4. Instalace aplikace OneLogin
      5. Instalace služby Oracle Identity Federation
    18. Správa dat
    19. Nastavení časového razítka
    20. Externí archiv
    21. Jazyky účtů
    22. Nastavení e-mailů
      1. Obrázky záhlaví/zápatí e-mailů
      2. Povolení jednotlivých zápatí e-mailů uživatele
      3. Přizpůsobení e-mailu Žádost o podpis
      4. Přizpůsobení polí Komu a Kopie
      5. Povolení oznámení bez odkazů
      6. Přizpůsobení e-mailových šablon
    23. Přechod z domény echosign.com na adobesign.com
    24. Konfigurace možností pro příjemce
  4. Pokyny pro regulační požadavky
    1. Dostupnost
      1. Soulad s předpisy pro usnadnění přístupu
      2. Vytváření formulářů s usnadněním přístupu pomocí aplikace Acrobat pro počítače
      3. Vytváření formulářů AcroForms s usnadněním přístupu
    2. HIPAA
    3. GDPR
      1. Přehled GDPR
      2. Redigování uživatele
      3. Redigování dohod uživatele    
    4. Část 11 pro titul 21 CFR a příloha 11 pravidel EudraLex
      1. Ověřovací balíček části 11 pro titul 21 CFR
      2. Příručka pro titul 21 CFR a přílohu 11 pravidel EudraLex
      3. Analýza sdílených odpovědností
    5. Zákazníci ve zdravotnictví
    6. Podpora IVES
    7. Ukládání dohod do trezoru
    8. Hlediska EU/Spojeného království
      1. Přeshraniční transakce EU/Spojeného království a nařízení eIDAS
      2. Požadavky HMLR na elektronicky podepsané dokumenty
      3. Dopad brexitu na zákony o elektronických podpisech ve Spojeném království
  5. Hromadné stahování dohod
  6. Nárokování domény 
  7. Odkazy na nahlášení zneužití

Odesílání, podepisování a správa dohod

  1. Možnosti příjemce
    1. Zrušení e-mailového připomenutí
    2. Možnosti na stránce elektronického podpisu
      1. Přehled stránky elektronického podpisu
      2. Otevření pro čtení dohody bez polí
      3. Odmítnutí podepsání dohody
      4. Delegování podpisového oprávnění
      5. Opětovné zahájení vyplňování dohody
      6. Stažení PDF dohody
      7. Zobrazení historie dohody
      8. Zobrazení zpráv dohody
      9. Přechod z elektronického na vlastnoruční podpis
      10. Přechod z vlastnoručního na elektronický podpis 
      11. Navigace v polích formuláře
      12. Vymazání dat z polí formuláře
      13. Zvětšení a navigace na stránce elektronického podpisu
      14. Změna jazyka použitého v nástrojích a informacích dohody
      15. Přehled právních upozornění
      16. Úprava předvoleb souborů cookie aplikace Acrobat Sign
  2. Odesílání dohod  
    1. Přehled stránky Odeslat
    2. Odeslání dohody pouze sami sobě
    3. Odeslání dohody ostatním
    4. Vlastnoruční podpisy
    5. Pořadí podepisování příjemců
    6. Hromadné odeslání
      1. Přehled funkce Hromadné odeslání
      2. Hromadné odeslání – konfigurace vzorové šablony
      3. Hromadné odeslání – konfigurace souboru CSV
      4. Zrušení transakce hromadného odeslání
      5. Přidávání připomenutí k hromadnému odeslání
      6. Sestavy pro hromadné odeslání
  3. Vytváření polí v dokumentech
    1. Prostředí pro vytváření v aplikaci
      1. Automatická detekce pole
      2. Přetahování polí pomocí prostředí pro vytváření
      3. Přiřazení polí formuláře příjemcům
      4. Role Předvyplnění
      5. Použití polí s opakovaně použitelnou šablonou pole
      6. Převedení polí do nové šablony knihovny
      7. Aktualizované tvůrčí prostředí při odesílání dohod
    2. Vytváření formulářů pomocí textových značek
    3. Tvorba formulářů pomocí aplikace Acrobat (AcroForms)
      1. Vytvoření formuláře AcroForm
      2. Vytváření přístupných souborů PDF
    4. Pole
      1. Typy polí
        1. Běžné typy polí
        2. Vložené obrázky
        3. Obrázky razítek
      2. Vzhled obsahu pole
      3. Ověření pole
      4. Hodnoty maskovaných polí
      5. Nastavení podmínek zobrazení/skrytí
      6. Počítaná pole 
    5. Časté dotazy k vytváření
  4. Podepisování dohod
    1. Podepisování dohod, které vám byly odeslány
    2. Vyplnění a podepsání
    3. Podepsání sám sebou
  5. Správa dohod
    1. Přehled stránky Správa
    2. Delegování dohod
    3. Nahrazení příjemců
    4. Omezení viditelnosti dokumentu 
    5. Zrušení dohody 
    6. Vytváření nových připomenutí
    7. Kontrola připomenutí
    8. Zrušení připomenutí
    9. Přístup k postupům modulu Power Automate
    10. Další akce...
      1. Jak vyhledávání funguje
      2. Zobrazení dohody
      3. Vytvoření šablony z dohody
      4. Skrytí/zobrazení dohod v zobrazení
      5. Nahrání podepsané dohody
      6. Úpravy souborů a polí odeslané dohody
      7. Úprava způsobu ověření příjemce
      8. Přidání nebo změna data vypršení platnosti
      9. Přidání poznámky do dohody
      10. Sdílení jednotlivé dohody
      11. Zrušení sdílení dohody
      12. Stažení jednotlivé dohody
      13. Stažení jednotlivých souborů dohody
      14. Stažení sestavy auditu dohody
      15. Stažení obsahu pole dohody
  6. Sestava auditu
  7. Tvorba sestav a export dat
    1. Přehled
    2. Udělení přístupu uživatelům k vytváření sestav
    3. Grafy sestav
      1. Vytvoření nové sestavy
      2. Sestavy dohod
      3. Sestavy transakcí
      4. Sestavy aktivity nastavení
      5. Úprava sestavy
    4. Exporty dat 
      1. Vytvoření nového exportu dat
      2. Export dat z webového formuláře
      3. Úprava exportu dat
      4. Aktualizace obsahu exportu dat
      5. Stažení exportu dat
    5. Přejmenování sestavy/exportu
    6. Duplikování sestavy/exportu
    7. Plánování sestavy/exportu
    8. Odstranění sestavy/exportu
    9. Kontrola použití transakce

Rozšířené možnosti a pracovní postupy dohod

  1. Webové formuláře 
    1. Tvorba webového formuláře
    2. Úprava webového formuláře
    3. Zakázání/povolení webového formuláře
    4. Skrytí/zobrazení webového formuláře
    5. Vyhledání adresy URL nebo kódu skriptu 
    6. Předvyplnění polí webového formuláře pomocí parametrů URL
    7. Uložení webového formuláře pro pozdější dokončení
    8. Změna velikosti webového formuláře
  2. Opakovaně použitelné šablony (Šablony knihovny) 
    1. Americké vládní formuláře v knihovně Acrobat Sign
    2. Vytvoření šablony knihovny
    3. Změna názvu šablony knihovny
    4. Změna typu šablony knihovny
    5. Změna úrovně oprávnění šablony knihovny
    6. Kopírování, úpravy a uložení sdílené šablony
    7. Stažení agregovaných dat polí pro šablonu knihovny
  3. Převod vlastnictví webových formulářů a šablon knihovny
  4. Pracovní postupy služby Power Automate 
    1. Přehled integrace modulu Power Automate a zahrnutých oprávnění
    2. Povolení integrace modulu Power Automate
    3. Kontextové akce na stránce Správa
    4. Sledování využívání modulu Power Automate
    5. Vytvoření nového postupu (příklady)
    6. Aktivační události používané pro postupy
    7. Import postupů z prostředí mimo službu Acrobat Sign
    8. Správa postupů
    9. Úpravy postupů
    10. Sdílení postupů
    11. Zakázání nebo povolení postupů
    12. Odstranění postupů
    13. Užitečné šablony
      1. Pouze správce
        1. Uložení všech dokončených dokumentů do služby SharePoint
        2. Uložení všech dokončených dokumentů do služby OneDrive for Business
        3. Uložení všech dokončených dokumentů do služby Google Drive
        4. Uložení všech dokončených dokumentů do služby DropBox
        5. Uložení všech dokončených dokumentů do služby Box
      2. Archivace dohody
        1. Uložení dokončených dokumentů do služby SharePoint
        2. Uložení dokončených dokumentů do služby One Drive for Business
        3. Uložení dokončených dokumentů do služby Google Drive
        4. Uložení dokončených dokumentů do služby DropBox
        5. Uložení dokončených dokumentů do služby Box
      3. Archivace dohod webových formulářů
        1. Uložení vyplněných dokumentů webových formulářů do knihovny služby SharePoint
        2. Uložení vyplněných dokumentů webových formulářů do služby OneDrive for Business
        3. Uložení vyplněných dokumentů do služby Google Drive
        4. Uložení vyplněných dokumentů webových formulářů do služby Box
      4. Extrahování dat dohody
        1. Extrahování dat polí formuláře z podepsaného dokumentu a aktualizace listu aplikace Excel
      5. Oznámení o dohodě
        1. Odesílání vlastních e-mailových upozornění s obsahem dohody a podepsanou dohodou
        2. Zobrazení oznámení služby Adobe Acrobat Sign v kanálu služby Teams
        3. Zobrazení oznámení služby Adobe Acrobat Sign ve službě Slack
        4. Zobrazení oznámení služby Adobe Acrobat Sign ve službě Webex
      6. Vygenerování dohody
        1. Vygenerování dokumentu z formuláře služby Power App a šablony aplikace Word, odeslání k podpisu
        2. Vygenerování dohody ze šablony aplikace Word ve službě OneDrive a získání podpisu
        3. Vygenerování dohody pro vybraný řádek aplikace Excel, odeslání ke kontrole a podpisu
  5. Vlastní pracovní postupy odeslání
    1. Přehled vlastního pracovního postupu odeslání
    2. Vytvoření nového pracovního postupu odeslání
    3. Úpravy pracovního postupu odeslání
    4. Aktivace nebo deaktivace pracovního postupu odeslání
    5. Odeslání dohody pomocí pracovního postupu odeslání
  6. Sdílení uživatelů a dohod
    1. Sdílení uživatele
    2. Sdílení dohod

Integrace s jinými produkty

  1.  Přehled integrací služby Acrobat Sign 
  2. Služba Adobe Sign pro Salesforce
  3. Služba Acrobat Sign pro Microsoft
    1. Služba Acrobat Sign pro Microsoft 365
    2. Služba Acrobat Sign pro Outlook
    3. Služba Acrobat Sign pro Word/PowerPoint
    4. Služba Acrobat Sign pro Teams
    5. Služba Acrobat Sign pro Microsoft PowerApps a Power Automate
    6. Konektor Acrobat Sign pro Microsoft Search
    7. Služba Acrobat Sign pro Microsoft Dynamics 
    8. Služba Adobe Sign pro Microsoft SharePoint 
  4. Další integrace
    1. Služba Acrobat Sign pro ServiceNow
    2. Služba Acrobat Sign pro HR ServiceNow
    3. Služba Acrobat Sign pro SAP SuccessFactors
    4. Služba Acrobat Sign pro Workday
    5. Služba Acrobat Sign pro NetSuite
    6. Služba Acrobat Sign pro VeevaVault
    7. Služba Acrobat Sign pro Coupa BSM Suite
  5. Integrace spravované partnery
  6. Jak získat integrační klíč

Vývojář služby Acrobat Sign

  1. Rozhraní API REST 
    1. Dokumentace metod
    2. Příručka pro SDK/vývojáře
    3. Časté dotazy k rozhraní API    
  2. Webhooky 
    1. Přehled webhooků
    2. Konfigurace nového webhooku
    3. Zobrazení nebo úpravy webhooku
    4. Aktivace nebo deaktivace webhooku
    5. Odstranění webhooku
    6. Certifikáty obousměrného protokolu SSL
    7. Webhooky v rozhraní API

Podpora a řešení problémů

  1. Zdroje zákaznické podpory 
  2. Materiály pro úspěch podnikových zákazníků

Přístup k rozhraní API mají výhradně podnikové účty a účty pro vývojáře.

Odkazy na základní dokumentaci

Poznámka:

Podpora starších rozhraní SOAP API skončila v květnu 2021.

Všichni zákazníci, kteří používají rozhraní API typu SOAP, by měli co nejdříve začít používat rozhraní API typu REST.

Po přihlášení přejděte na Účet > Rozhraní API služby Adobe Sign > Informace o rozhraní API > Rozhraní API a Dokumentace.


Základní pojmy

Dokument nelze vytvářet prohlížením stránky přes webové uživatelské rozhraní, pomocí přetažení ani přiřazení podpisových rolí prvkem transientDocumentId přes rozhraní API.

Volání transientDocuments vrací prvek transientDocumentID, který je platný 7 dní.  Můžete jej použít pouze pro další volání API. Je uložen na serveru API a přiřazený k tomuto ID. Nahrajte soubor a poté na něj můžete odkazovat v dalších voláních API pomocí jeho ID.

Nahrávání dokumentů přímo do dohody není přes rozhraní API typu REST podporováno.

Podle požadavku rozhraní typu REST nejprve vytvořte přechodný dokument a pak v dohodách, widgetech nebo knihovnách jako zdroj souboru používejte toto ID.

Přechodný dokument je původní zdrojový soubor například ve formátu PDF, doc nebo docx, který je nahrán na servery společnosti Adobe. Jedná se tedy o pohodlný způsob, jak odeslat svůj základní dokument na servery API a svůj přechodný dokument na web.

Je pravda, že dohody můžete odesílat přes pracovní postupy v rozhraní API v6 voláním POST /agreements. Předejte parametr worflowId do volání API.

Prvek workflowId pracovního postupu můžete získat voláním GET /workflows.

  1. Přihlaste se do služby Adobe Sign jako správce

  2. Přejděte do části Účet > Rozhraní API služby Adobe Sign > Protokol požadavků rozhraní API

    Protokoly rozhraní API

  1.  Přihlaste se do účtu Adobe Sign jako správce

  2. Přejděte do části Účet > Rozhraní API služby Adobe Sign > informace o rozhraní API

  3. Klikněte na odkaz Vzory prvků rozhraní API typu REST.

    Poznámka:

    Sadu SDK k JavaScriptu můžete stáhnout na stránce https://github.com/adobe-sign/AdobeSignJsSdk.

Od verze 6 již není k dispozici možnost „sendTroughWeb“. Nahrazuje jej prvek stav. Jde o konečný stav dohody. Pole stavu lze zadat pouze ve voláních POST. Nikdy se nevrátí ve voláních GET /agreements/{ID} a nebude bráno v úvahu ve voláních PUT /agreements/{ID}. Případný stav dohody lze získat voláním GET /agreements/ID.

stav(řetězec) = ['AUTHORING' or 'DRAFT' or 'IN_PROCESS'].

VYTVÁŘENÍ (AUTHORING) umožňuje uživateli před odesláním dokumenty dohody vytvořit. Vytvářením je zde myšleno vytvoření, úprava nebo umístění polí formuláře a související nastavení (pověřená osoba, podmínky, typy dat atd.) v dokumentech dohody. Po zveřejnění dokumentu ve stavu Vytváření se dokument zobrazí ve službě Adobe Sign v kartě Správa v části Koncept.

KONCEPT (DRAFT) odpovídá dočasné nebo základní verzi zamýšleného výsledného zdroje, kterou lze za účelem vytvoření výsledného zdroje postupně aktualizovat. Nezobrazuje se ve službě Adobe Sign v kartě Správa v části Koncept. Ve stavu Koncept není potřeba zadat soustavu údajů účastníků, koncept lze později dokončit přiřazením údajů pomocí volání PUT /agreements/agreementId. Tento krok lze učinit opakovaně, dokud nezískáte všechna data potřebná k vytvoření dohody.

ZPRACOVÁVÁ SE (IN_PROGRESS) změní stav dohody na Odesláno k podpisu, dohoda se poté zobrazuje ve službě Adobe Sign v kartě Správa v části Odesláno k podpisu.

Prvek sendThroughWeb umožňuje dohodu odeslat interaktivně. Různé parametry pole „možnosti“ požadavku v5 POST /agreements umožňují uživateli toto interaktivní zobrazení nastavit (stránka Odeslat). Všechny tyto parametry nastavení stránky, jako je například prvek fileUploadOptions, nyní najdete v rozhraní API POST agreements/ID/views.

V důsledku toho můžete dosáhnout výsledku prvku sendThroughWeb vytvořením dohody ve stavu VYTVÁŘENÍ (AUTHORING) pomocí volání API POST /agreements. Chcete-li poté získat adresu URL následující stránky se zvoleným nastavením, použijte volání rozhraní API POST agreements/ID/views.

Postupujte podle následujících kroků:

1. Přejděte do dokumentace rozhraní API typu REST v6 a vyberte metodu POST/agreements.
2. Použijte následující kód požadavku:

{

  "fileInfos": [

    {

      "transientDocumentId": "***************************"

    }

  ],

  "name": "test",

  "participantSetsInfo": [

    {

      "memberInfos": [

        {

          "email": "abc@gmail.com"

        }

      ],

      "order": 1,

      "role": "SIGNER"

    }

  ],

  "signatureType": "ESIGN",

  "state": "AUTHORING"

}

 

3. Nyní použijte metodu POST /agreements/{agreementId}/views s tímto kódem požadavku:

 

{

  "name": "AUTHORING"

}

Z kódu odezvy lze získat adresu URL vytvářených polí.

Adresu URL zpětného volání lze definovat níže uvedenými způsoby:

  • Pomocí následujícího parametru můžete podle potřeby určit adresu URL zpětného volání:

    "callbackInfo": "",
  • Obraťte se na podporu služby Adobe Sign a nastavte výchozí adresu URL zpětného volání pro celý účet.

Uživatelské rozhraní typu SOAP (software SmartBear) způsobuje při volání API chybu připojení SSL, která se podobá následující chybě. K této chybě obvykle dochází, pokud používáte zastaralé připojení SSL nebo protokol TLS nižší verze než TLS 1.2

CHYBA: Výjimka požadavku: javax.net.ssl.SSLException: Přijaté fatální upozornění: protocol_version
CHYBA: Vyskytla se chyba [přijaté fatální upozornění: protocol_version], podrobnosti naleznete v záznamu chyb

  1. Přidejte do souboru VMOPTIONS ve složce Bin prvek (-Dsoapui.https.protocols=SSLv3,TLSv1.2).

  2. Přejděte do umístění C:\Program Files\SmartBear\SoapUI-5.2.1\bin (záleží na tom, kam jste nainstalovali uživatelské rozhraní typu SOAP. Může se nacházet v adresáři C:\Program Files (x86))

  3. V souboru VMOPTIONS povolte úplná práva ke čtení nebo zápisu souborů.

    VMOPTIONS

  4. Klikněte pravým tlačítkem na soubor VMOPTIONS >Vlastnosti > Zabezpečení > Vybrat uživatele > Klikněte na možnost Upravit. (Na tlačítku Upravit se zobrazí ikona Ovládací prvky uživatele) > Zaškrtněte všechna políčka a klikněte na tlačítko OK.

  5. Totéž opakujte u správců, systémů a všech balíčků aplikací.

  6. Otevřete soubor v programu Poznámkový blok.

  7. Do spodní části přidejte tento protokol “-Dsoapui.https.protocols=SSLv3,TLSv1.2” a změny uložte.

  8. Zavřete uživatelské rozhraní typu SOAP a restartujte aplikaci. Pokud vše funguje správně, při volání API nedojde k chybě SSL. (Fungování ověřte voláním ke zkoušce odezvy).

Níže najdete postup pro vytvoření ID klienta a tajemství klienta v aplikaci Adobe Sign:

  1. Přihlaste se k účtu Adobe Sign.

  2. Přejděte do části Účet > Rozhraní API služby Adobe Sign > Aplikace rozhraní API.

    Fnord.

  3. Aplikaci vytvoříte kliknutím na ikonu se znaménkem plus.

    Fnord.

  4. Zadejte název a zobrazovaný název.

  5. V části Doména vyberte ZÁKAZNÍK a klikněte na odkaz Uložit.

    Fnord.

  6. Kliknutím zvýrazněte zvolenou aplikaci.

  7. Klikněte na odkaz Nastavit ověřování OAuth pro aplikaci.

    Fnord.

  8. Zadejte adresu URL k přesměrování.

  9. Chcete-li požadované rozsahy povolit, zaškrtněte příslušná políčka a klikněte na odkaz Uložit.

  1. Přejděte do části Účet > Rozhraní API služby Adobe Sign > Informace o rozhraní API

  2. Klikněte na odkaz Integrační klíč

    Přejděte do části integrační klíč

    Poznámka:

    Pokud odkaz integrační klíč nevidíte, obraťte se na svého manažera pro úspěch zákazníků a požádejte jej, zda by ho ve vašem účtu povolil.

    • Pojmenujte klíč intuitivně
    • Vyberte různé rozsahy podle toho, jaké požaduje vaše aplikace
    • Po úplném dokončení konfigurace klíče klikněte na Uložit
    Rozhraní Vytvořit integrační klíč

  3. Po uložení klíč najdete v části: Účet > Osobní preference > Přístupové tokeny

    Zobrazí se název klíče a všechny povolené rozsahy.  

    Jedním kliknutím na popis tlačítka zobrazíte odkazy na úkony:

    • Integrační klíč – Tímto odkazem získáte doslovné znění klíče 
    • Zrušit – Tímto dojde ke zrušení a trvalému odstranění přístupového tokenu
    Přístupové tokeny – Integrační klíč

  1. Přihlaste se k účtu Adobe Sign.

  2. Přejděte do části Účet > Rozhraní API služby Adobe Sign > Aplikace rozhraní API.

  3. Aplikaci vytvoříte kliknutím na ikonu se znaménkem plus.

    Postman1

  4. Klikněte na odkaz Nastavit ověřování OAuth pro aplikaci.

    Fnord.

  5. Pomocí následujícího odkazu vygenerujte autorizační kód. ID klienta, adresa URI k přesměrování a rozsahy musí odpovídat následující adrese URL vybrané v aplikaci (do adresy URL nepřidávejte mezery ani kód oddílu jako například „NA1“, k němuž účet Adobe Sign patří):

    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. Pokud je volání úspěšné, zkopírujte z adresního řádku ověřovací kód.

    Fnord.

  7. Stáhněte a nainstalujte aplikaci Postman z odkazu https://www.getpostman.com/apps.

  8. Po stažení a instalaci vytvořte prvek POST kliknutím na odkaz NOVÝ.

  9. Zadejte odkaz https://secure.na1.echosign.com/oauth/token podle toho, k čemu váš účet Adobe Sign patří.

  10. V části Headers zadejte Typ obsahu (content-type) application/x-www-form-urlencoded.

  11. Ujistěte se, že pro body je vybrán typ x -www-form-urlencoded, zadejte níže uvedené parametry, odpovídající hodnoty z aplikace vytvořené v účtu Adobe Sign a klikněte na tlačítko ODESLAT.

    Fnord.

  12. Pokud jsou všechny údaje správné, vrátí se přístupový token a také obnovovací token:

    Fnord.

Při spuštění procesu OAuth se ujistěte, že splňujete následující body:

1. Je zadáno správné ID klienta a adresa URI k přesměrovaní.
2. Rozsahy uvedené v ověřovací adrese URL by se měly přesně shodovat s rozsahy v aplikaci Adobe Sign.
3. Zadejte správný oddíl (na1, na2, au1, eu1, jp1) podle účtu, který nastavujete.
4. Odstraňte veškeré případné mezery v ověřovací adrese URL.
5. Zkontrolujte syntax ověřovací adresy URL:

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

Přístupové tokeny platí pouze 3 600 sekund (jednu hodinu), po uplynutí doby jejich platnost vyprší.

Autor požadavku v rozhraní API může podle potřeby používat obnovovací tokeny k vytvoření nových přístupových tokenů.

Webhooky podporuje rozhraní REST API v6 a novější.

Pokud příjemce webhooků nezareaguje za 72 hodin, webhook se deaktivuje a nedojde k odeslání upozornění.

Pokud je cílová adresa URL webhooku z jakéhokoli důvodu mimo provoz, služba Adobe Sign zařadí objekt JSON do fronty a opakuje pokus o odeslání v postupném 72hodinovém cyklu.

Nedoručené události zůstanou ve frontě opětovných pokusů a v následujících 72 hodinách bude vynaloženo maximální úsilí na doručení upozornění v tom pořadí, v jakém k nim došlo.

Strategie opakování doručení upozornění spočívá ve zdvojnásobování prodlevy mezi jednotlivými pokusy. Začíná se minutovým intervalem, který se postupně zvyšuje na 12 hodin, ve výsledku tedy 15 opakování za 72 hodin.

 

Chcete-li vytvořit webhook přímo v uživatelském rozhraní služby Adobe Sign, musíte nejprve vytvořit adresu URL webhooku ve funkčních aplikacích služby Azure AD, a to následujícím postupem:

  1. Na https://portal.azure.com/ se přihlaste přes účet Microsoft.

  2. Zaregistrujte se k funkčním aplikacím účtem ke službě AzureAD.

    Nabídka služby Azure

  3. Ve službě AzureAD přejděte do části Funkční aplikace > Kliknutím na ikonu se znaménkem plus zobrazíte Funkce.

  4. Vyberte možnost Webhook a rozhraní API s jazykem JavaScript a potom klikněte na odkaz Vytvořit funkci.

    Uživatelské rozhraní API ve službě Azure

  5. Nahraďte soubor Index.js následujícím fragmentem kódu:

    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. Klikněte na tlačítko Test v pravém rohu a zadejte následující hlavičku:

    X-AdobeSign-ClientId as ***********************

    Test API

  7. Klikněte na Uložit a Spustit.

  8. Jakmile obdržíte odpověď 200 OK s následující hlavičkou, klikněte na funkci Získat adresu URL funkce

    Odpověď 200

  9. Zkopírujte adresu URL a přejděte do uživatelského rozhraní služby Adobe Sign > Webhooky > a kliknutím na ikonu se znaménkem plus vytvořte novou položku.

  10. Zadejte následující údaje: 

    • Název: Dojde k návrhu intuitivního názvu, který ostatní správci ihned pochopí.
    • Rozsah: V jak široké síti webhook loví. V rozhraní je k dispozici Účet a Skupina.
      Rozhraní API podporuje rozsahy Účet, Skupina, Uživatel a Zdroje.
    • K jednomu webhooku lze nastavit pouze jeden rozsah
    • Adresa URL: Cílová adresa URL, na kterou služba Adobe Sign přesunula datovou část JSON.
    • Události: Co vyvolá proces vytvoření objektu JSON ve službě Adobe Sign a zaslání na adresu URL.
      Každá událost vytváří jinou datovou část, která souvisí s událostí, která proces vyvolala
      Jeden webhook pojme několik událostí.
    • Parametry upozornění: Parametry upozornění určují úseky datové části události u objektu JSON. Díky tomu můžete vybrat pouze ty části události, které jsou důležité.
    Uživatelské rozhraní webhook

  11. Až bude webhook úplně nastaven, klikněte na tlačítko Uložit a nový webhook začne okamžitě reagovat na spouštěče.

Datový zdroj dohody se odkazuje na položku, pomocí níž můžete vytvořit dohodu, například na dokument knihovny, widget nebo samotnou dohodu.

Chcete-li vyhledat události položek dohod, nejprve odešlete požadavek na rozhraní API, které vytváří prvky agreementAssetEvents s příslušnými parametry vyhledávání.

Na první stránce výsledků kromě odpovědí najdete parametr ID vyhledávání a odkaz na další stránku. Nástroje můžete použít k získání dalších stránek s výsledky, pokud jsou dostupné přes rozhraní API, které vrací prvky agreementAssetEvents na základě ID hledání.

  1. Otevřete dokumentaci k rozhraní API typu REST verze 5.

  2. Přejděte na volání post/search/agreementAssetEvents a vygenerujte přístupový token s příslušnými rozsahy.

  3. V kódu požadavku nastavte podle potřeby počáteční a koncové datum:

    { 
      "endDate": "2018-05-22T22:33:33", 
      "startDate": "2017-12-22T22:33:33" 
    }
  4. Klikněte na Vyzkoušet (Try it out). Načtou se ID položek dohod, která lze použít i jako ID dohody.


Správa uživatelů a účtů

  1. Přihlaste se do služby Adobe Sign.
  2. Přejděte do části Účet > Rozhraní API služby Adobe Sign > Dokumentace k rozhraní API typu REST.
  3. Vyberte verzi 5.
  4. V rámci metody post/users použijte kód požadavku uvedený v části
    UserCreationInfo method
    {
    "email": "email@email.com",
    "firstName": "AA",
    "lastName": "AB",
    "password":"12******rte"
    }

Majitelé účtů Adobe Sign, které používají konzoli Admin Console (Adobe One) ke správě oprávnění uživatelů, nemohou využívat k vytváření uživatelů nebo správě stávajících uživatelů rozhraní API služby Adobe Sign.

U konzole Adobe One Admin Console se používá jiné rozhraní API než u služby Adobe Sign. Další informace najdete v těchto článcích:

 

Získání ID skupiny:

  1. Přejděte na stránku https://secure.na1.echosign.com/public/docs/restapi/v5.

  2. V části Zdroje a operace klikněte na Skupiny.

  3. Klikněte na prvek GET /groups.

  4. Klikněte na tlačítko přístupový token OAuth.

  5. Vygenerujte přístupový token.

  6. Klikněte na odkaz Vyzkoušet (Try it out).

    Obdržíte odpověď v tomto formátu, v níž najdete název skupiny a ID skupiny:

    { 
      "groupInfoList": [ 
        { 
          "groupId": "3AAABLblqZhB4o9EnlvmGB_m8CrG5O6XClTBO7vmojOOexu5r3G95LtEV2Sp7BuhNvQYSvWB7PmmwVPXnhPIiYSuHV98Cerkp", 
          "groupName": "Default Group" 
        }, 
        { 
          "groupId": "3AAABLblqZhC3dPT6za5h7r1-BOEWivCe_OcAVONhcsKa57SL9_iCwGr5v_JED1No5jE20Pcjv0mYH2J-LoY1AcmqS69vRkO7", 
          "groupName": "test" 
        }, 
      ] 
    }

Odstranění skupiny:

  1. Klikněte na prvek DELETE /groups/{groupId}.

  2. Chcete-li vygenerovat přístupový token, klikněte na tlačítko přístupový token OAuth.

  3. Do pole groupId vložte prvek groupId odstraňované skupiny, který najdete v odpovědi předchozího volání.

  4. Klikněte na odkaz Vyzkoušet (Try it out).

    Po odstranění skupiny obdržíte odpověď: Žádný obsah

Poznámka:

Nelze odstranit skupinu, která má přiřazeného uživatele. V podstatě můžete odstranit pouze prázdnou skupinu. Pokud se ve skupině nachází uživatel, obdržíte odpověď podobnou následující.


{

  "code": "GROUP_NOT_EMPTY",

  "message": "Skupinu nelze odstranit, protože není prázdná."

}


Zahájení a odeslání dohod

Vytvoření přechodného dokumentu

  1. Klikněte na prvek transientDocuments a rozbalte metodu POST /transientDocuments

  2. Klikněte na tlačítko přístupový token OAuth

    Metoda přechodného dokumentu přes rozhraní API

    • Povolte rozsahy u transakce
    • Klikněte na možnost Ověřit
    Rozsahy ověřování OAuth

  3. Povolit přístup

    Pokud se zobrazí výzva, klikněte na odkaz Povolit přístup

  4. Vrátíte se na stránku metody rozhraní API. Hodnota ověření se vyplní.

    • Do pole Název pole zadejte název pole
    • Klikněte na tlačítko Vybrat soubor a nahrajte dokument k dohodě
    • Klikněte na tlačítko Vyzkoušet .
    Vyzkoušet!

  5. Odpověď byla vygenerována.

    Prvek transientDocumentID lze nalézt v těle odpovědi:

    Přechodné ID dokumentu

Vytvoření dohody pomocí přechodného dokumentu

  1. Klikněte na prvek agreements a rozbalte metodu POST /agreements

    • Klikněte na tlačítko přístupový token OAuth
    • Povolte rozsah OAuth
    • Klikněte na možnost Ověřit
      • Pokud se zobrazí výzva, klikněte na odkaz Povolit přístup
  2. Vrátíte se na stránku metody rozhraní API. Hodnota ověření se vyplní.

    • Zkopírujte si níže uvedený skript do textového editoru (jedná se o co nejméně konkrétní příklad, váš kód produkce bude mít jinou podobu)
    •  Vložte hodnotu prvku transientDocumentId do kódu na místo určení
    { 
      "fileInfos": [ 
       {"transientDocumentId":"PASTE YOUR TRANSIENTDOCUMENTID HERE"} 
      ], 
      "name": "test doc", 
      "participantSetsInfo": [ 
        { 
          "memberInfos": [ 
            { 
              "email": "noreply@echosign.com" 
            } 
          ], 
          "order": 1, 
          "role": "SIGNER" 
        } 
      ], 
      "signatureType": "ESIGN", 
      "state": "DRAFT" 
    }

     

    • Zkopírujte si vlastní skript a vložte jej do pole AgreementInfo
    • Klikněte na tlačítko Vyzkoušet .
    Metoda dohody typu POST

  3. Odpověď byla vygenerována.

    Prvek agreementID lze nalézt v těle odpovědi:

    Odpověď v metodě dohody typu POST

Níže najdete postup přidání souborů do parametru FileInfo:

  1. Použít přechodné ID:

    Přejděte do části POST/transientDocuments a nahrajte z místního disku příslušný dokument.
    Použijte přechodné ID vygenerované v části informace o souboru ve voláních POST/Agreements:

    "fileInfos": [ 
         { 
           "transientDocumentId": "" 
         } 
       ],
  2. Použijte ID dokumentu knihovny:

    Přejděte na Hlavní obrazovku. Klikněte na odkaz Přidat dokument do knihovny a uložte šablonu.
    V dokumentaci k rozhraní API typu REST klikněte na prvek GET /libraryDocuments a získáte ID knihovny šablony, kterou vytváříte.
    V části POST/Agreements zadejte ID dokumentu knihovny:

    "libraryDocumentId": "", 
      "libraryDocumentName": "",
  3. Použít veřejně dostupnou adresu URL:

    Zadejte veřejně přístupnou adresu URL, která bude použita v parametru FileInfo:

    { 
          "documentURL": { 
            "mimeType": "", 
            "name": "", 
            "url": "" 
          },
  1. Vyberte možnost Dohody > POST/agreements. 

  2. Vyberte možnost přístupový token OAuth a zadejte potřebné rozsahy.

  3. Až se přístupový token přidá, můžete použít následující kód požadavku:

    { 
    "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*"} 
    ] 
    } 
    }

Ve volání POST /agreements, můžete u parametru signatureflow předat hodnotu SENDER_SIGNS_FIRST nebo SENDER_SIGNS_LAST, kterými se přidává v tomto pořadí první a poslední podepisující.

Zde najdete příklad volání ve formátu JSON:

{

  "documentCreationInfo": {

    "fileInfos": [

      {        "transientDocumentId":"3AAABLblqZ-yourIDGoesHere"

      }

    ],

    "name": "Test",

    "recipientSetInfos": [

      {

        "recipientSetMemberInfos": [

          {

            "email": "test@email.com"

          }

        ],

        "recipientSetRole": "SIGNER"

      }

    ],

    "signatureType": "ESIGN",

    "signatureFlow": "SENDER_SIGNS_FIRST"

  }

}

Poznámka:

Možnost Odeslat jménem další osoby je dostupná pouze v rozhraní API typu REST V6, pokud je zapnutá funkce Rozšířené sdílení.

Pokud práva k odesílání nejsou udělena sdílením nebo pokud funkce Rozšířené sdílení není zapnutá, dostanete odpověď v takovémto znění:

 

{"code":"PERMISSION_DENIED","message":"User provided in x-on-behalf-of-user header does not have required permission to perform this operation."}

 

Pro funkci Odeslat jménem povolte v účtu možnost Pokročilé sdílení účtů, aby uživatelé mohli při sdílení svého účtu udělovat ostatním uživatelům oprávnění odesílat. Další informace o pokročilém sdílení najdete v části Povolení pokročilého sdílení účtů.

Po povolení sdílení uživatelů můžete podle následujících pokynů použít funkci Odeslat jménem:

Vytvoření přechodného dokumentu:

  1. V části transientDocuments klikněte prvek POST /transientDocuments.

  2. Ověřovací token vygenerujete kliknutím na tlačítko PŘÍSTUPOVÝ TOKEN OAUTH.

  3. V prvku x-on-behalf-of-user zadejte e-mail uživatele, jehož jménem chcete dohodu odeslat, a to v následujícím formátu: email:test@email.com

  4. Chcete-li vybrat soubor, klikněte na odkaz Vybrat soubor a poté na odkaz Vyzkoušet.

    Obdržíte odpověď podobnou této s prvkem transientDocumentId:

    {"transientDocumentId":"3AAABLblqZhB9Mjo0mrIu_pSgrf5VsMaKM68_Vmn80cimaqiUAD2OxrPp2e5H8GvjfiOxj4d5B8bCPkUfvaozW3KLisp_wseGVOL8A7oNZni1DWyFi4uNoxLQu4nUO44Wh63GQv9_HEJMePust0Pk94vJ_rbS96R7ic-vl7jbOkN0b4EB5-JMqlC-Fl_Vpyz8I1EQUrM5I4nB9ztMov4ad00yiOtDw0tB-Y2t5JdzM07P-mpJmwYEl8Fq2IeDuWjcR2tV7qY7TNGX2CNyh9jt0aMyduHeYa0GABr69z8Hm76eKdtaM_1E1ggWj205fSrNcwJsnpSO278*"}

Vytvoření dohody pomocí přechodného dokumentu:

  1. V části dohody klikněte na prvek POST /agreements.

  2. Ověřovací token vygenerujete kliknutím na tlačítko PŘÍSTUPOVÝ TOKEN OAUTH.

  3. V prvku x-on-behalf-of-user zadejte e-mailovou zprávu uživatele podobně jako při vytváření přechodného dokumentu.

  4. Do prvku AgreementInfo přidejte následující kód a klikněte na odkaz Vyzkoušet.

    { 
      "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" 
    }

     

    Obdržíte odpověď podobnou této s prvkem agreementId:

    { 
      
      "id": "CBJCHBCAABAAUlen3l_fzlj1Kbn_wGZAhYcIgN0J7Qtq" 
      
    }
  1. Přihlaste se do služby Adobe Sign.

  2. Přejděte do části Účet > Rozhraní API služby Adobe Sign > Údaje rozhraní API a klikněte na odkaz Dokumentace k metodám rozhraní API typu REST.

    Uživatelské rozhraní webhook

  3. Použijte operaci POST /transientDocuments, nahrajte soubor a vytvořte přechodné ID dokumentu.

  4. Zkopírujte si přechodné ID dokumentu a použijte jej v metodě POST /agreements. V poli uveďte následující požadavek 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. Chcete-li provést požadavek na objekt JSON, klikněte na tlačítko Vyzkoušet.

    Uživatelské rozhraní webhook

    Správný objekt JSON vrátí odpověď s ID dohody.

    Uživatelské rozhraní webhook

Níže najdete parametry, které můžete předat v kódu za účelem nastavení hesla pro otevření:

 

{

    "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   

        }

    }]

}

 

Dohodu se stavem „VYTVÁŘENÍ“ lze přes rozhraní API vytvořit tímto postupem:

Přejděte k prvku Post /agreements a vytvořte přístupový token s požadovanými rozsahy.

Použijte následující kód žádosti:

 

{

  "fileInfos": [

    {

      "transientDocumentId": "*********************"

    }

  ],

  "name": "A1",

  "participantSetsInfo": [

    {

      "memberInfos": [

        {

          "email": "abc@xyz.com"

        }

      ],

      "order": 1,

      "role": "SIGNER"

    }

  ],

  "signatureType": "ESIGN",

  "state": "AUTHORING"

}

 

Ve verzi 6 najdete v rozhraní API sadu nástrojů k vytváření dohod. Ve verzi 5, se prvek formFields automaticky převádí do volání POST /agreements. Ve verzi 6 však můžete prvkem POST /agreements v6 vytvořit dohodu ve stavu VYTVÁŘENÍ (state = AUTHORING) a použít kdykoli posléze volání PUT /agreements/ID/formFields k přidání polí do dokumentů této dohody.

Zde najdete postup:

  1. Přejděte do dokumentace rozhraní API typu REST v6 a vyberte metodu POST/agreements.

  2. Použijte následující kód požadavku:

    { 
      "fileInfos": [ 
        { 
          "transientDocumentId": "***************************" 
        } 
      ], 
      "name": "test", 
      "participantSetsInfo": [ 
        { 
          "memberInfos": [ 
            { 
              "email": "abc@gmail.com" 
            } 
          ], 
          "order": 1, 
          "role": "SIGNER" 
        } 
      ], 
      "signatureType": "ESIGN", 
      "state": "AUTHORING" 
    }
  3. Použijte metodu put /agreements/{agreementId}/formFields s následujícím vzorovým požadavkem:

    { 
      "fields": [ 
        { 
         "locations": [ 
              { 
                "height": 36, 
                "left": 75, 
                "pageNumber": "1", 
                "top": 200, 
                "width": 150 
              } 
            ], 
            "contentType": "SIGNATURE_BLOCK", 
            "name": "sigBlock1", 
            "inputType": "SIGNATURE", 
            "recipientIndex":1 
           } 
    ]}

     

    Po dokončení požadavku se dohoda odešle zmíněným příjemcům.

  1. Přihlaste se do služby Adobe Sign.

  2. Přejděte do části Účet > Rozhraní API služby Adobe Sign > Údaje rozhraní API a klikněte na odkaz Dokumentace k metodám rozhraní API typu REST.

    Uživatelské rozhraní webhook

  3. Použijte operaci POST /transientDocuments, nahrajte soubor a vytvořte přechodné ID dokumentu.

  4. Zkopírujte si přechodné ID dokumentu a použijte jej v metodě POST /agreements. V poli uveďte následující požadavek 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. Chcete-li provést požadavek na objekt JSON, klikněte na tlačítko Vyzkoušet.

    Uživatelské rozhraní webhook

    Správný objekt JSON vrátí odpověď s ID dohody.

    Uživatelské rozhraní webhook

  1. Přihlaste se do služby Adobe Sign.

  2. Přejděte do části Účet > Rozhraní API služby Adobe Sign > Údaje rozhraní API a klikněte na odkaz Dokumentace k metodám rozhraní API typu REST.

    Fnord.

  3. Použijte operaci POST /transientDocuments, nahrajte soubor a vytvořte přechodné ID dokumentu.

  4. Zkopírujte si přechodné ID dokumentu a použijte jej v metodě POST /agreements. V poli uveďte následující požadavek 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. Chcete-li provést požadavek na objekt JSON, klikněte na tlačítko Vyzkoušet.

    Fnord.

    Správný objekt JSON vrátí odpověď s ID dohody.

    Fnord.

  6. Chcete-li dohodu otevřít v režimu tvorby, zkopírujte adresu URL a vložte ji do adresního řádku prohlížeče.

  7. Webové formuláře přetáhněte do požadovaného umístění.

  8. Chcete-li dohodu odeslat k podpisu, klikněte na odkaz Odeslat. 

K vytvoření dohody použijte volání POST /agreements. Odešle ji k podpisu a vrátí klientovi odpověď v podobě prvku agreementID. Níže najdete formát objektu JSON pro odeslání dohody s ověřením pomocí telefonu.

 

{

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

}

}

 

Data můžete sloučit přímo do polí formuláře následujícími způsoby:

  • Používání šablon knihovny:

    Pokud používáte ID šablony knihovny s parametrem FileInfo, zadejte přesný název pole a související údaje podle níže uvedené části:

 

"mergeFieldInfo": [

     {

       "defaultValue": "",

       "fieldName": ""

     }

   ],

 

  • Použití textových značek v dokumentech nahraných v podobě přechodných dokumentů:

    Pokud nahrajete dokument, v němž jsou přidané textové značky, jako by se jednalo o dokument přechodný, ujistěte se, že jste v částech uvedených níže zadali přesné názvy polí a příslušné údaje: 

 

"mergeFieldInfo": [

     {

       "defaultValue": "",

       "fieldName": ""

     }

   ],

 

Jak přes rozhraní API odeslat dohodu, která má předvyplněné hodnoty konkrétních polí formuláře (sjednotit pole)?

K tomuto volání je nejdříve potřeba dokončit „Nahrání dočasného dokumentu“ a získat prvek „transientDocumentId“ (pomocí adresy: secure.na1.echosign.com/public/docs/restapi/v5#!/transientDocuments/createTransientDocument) za tímto účelem.

  • V tomto volání najdete část „mergeFieldInfo“, v níž jsou uvedeny výchozí hodnoty pro určitá pole formuláře.
  • Takto se předvyplní údaje do volání rozhraní API z odlišného systému.
  • Tato pole dohody buďto lze upravovat nebo jsou pouze ke čtení.

 

Předpoklady:

  1. Přechodné ID dokumentu
  2. Názvy polí a jejich hodnoty

 

Vzory volání s požadavkem:

 

Požadavek:

POST /api/rest/v5/agreements HTTP/1.1

Hostitel: api.na1.echosign.com (nebo můžete zadat oddíl, který lze najít pomocí volání getbaseURis na: https://secure.na1.echosign.com/public/docs/restapi/v5#!/base_uris/getBaseUris

Přístupový token: 2AAABLblqZhA_D1mluNKQP7py5vXtt-1UHl9NR25e_C3LnKTUH14IblbrXODbXGRozyr7ChBkJNM*

x-user-email: odesilatel@vasedomena.cz

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": "Upravená dohoda MSA”,

        "mergeFieldInfo": [

            {

                "fieldName": "Název účtu",

                "defaultValue": "Sašova garáž"

            },

            {

                "fieldName": "Číslo účtu",

                "defaultValue": "8756999"

            },

            {

                "fieldName": "PSČ",

                "defaultValue": "94501"

            },

            {

                "fieldName": "město",

                "defaultValue": "Lhota"

            },

            {

                "fieldName": "Země",

                „defaultValue“: „ČR“

            },

            {

                "fieldName": "Ulice",

                "defaultValue": "Dlouhá 123"

            },

            {

                "fieldName": "Titul1",

                "defaultValue": "Ředitel"

            },

            {

                "fieldName": "Popis",

                "defaultValue": "Vložte nový popis"

            }

        ]

   }

 

}

 

Odpověď na toto volání je prvek „agreementId“, který si musíte uchovat v systému pro pozdější volání (prvky signingUrl, status, formData apod.)

 

Odpověď:

{

  "agreementId": "3AAABLblqZhCf_7xDcrOgKFwAabp1S-OFfvUdHf2wJsSMwlB95_x_WdUeab67jOkJi1IJzWuSJ0zdNNKugS1blZB4LT5vNVyJ"

}

 

V průběhu metody „post /megaSigns/{megaSignId}/views“ se zobrazí chyba s názvem „Požadované zobrazení není pro zdroj v aktuálním stavu dostupné.“

Chyba se zobrazí, pokud je zadaná neplatná hodnota parametru název v níže uvedeném kódu požadavku:

{
  "name": " "
}

Například, pokud dohoda ve službě MegaSign již je ve stavu „ZPRACOVÁVÁ SE“, po zadání hodnotu „VYTVÁŘENÍ“ dojde k uvedené chybě. Ujistěte se, že zadaná hodnota odpovídá aktuálnímu stavu dohody.

V průběhu metody „put /megaSigns/{megaSignId}/state“, se zobrazí chyba „Nebyla zadána hodnota údajů zrušení služby MegaSign.“

Chyba je způsobena chybějícím kódem požadavku parametr: 

 "megaSignCancellationInfo": {
    "comment": "",
    "notifyOthers": false
  }

místo použití „Minimal Schema“ klikněte na „Complete model Schema“ a zadejte úplný kód požadavku pro spuštění volání API. 

Chcete-li změnit stav dohody ve službě MegaSign, použijte volání put /megaSigns/{megaSignId}/state a držte se těchto pokynů:

  1. Přejděte do dokumentace rozhraní API typu REST V6 a vyberte metodu  
    put /megaSigns/{megaSignId}/state.
  2. Uveďte ověřovací hodnotu a také prvek If-Match a megasignID.
    • Chcete-li získat prvek megasignID, použijte operaci get /megaSigns
    • Chcete-li získat prvek If-Match, použijte volání get /megaSigns/{megaSignId} a vyhledejte „značka entity“
  3. {
      "state": "CANCELED",
      "megaSignCancellationInfo": {
       "comment": "cancel",
       "notifyOthers": false
      }

Aby byl webhook zaregistrován správně, adresa URL webhooku musí na tento požadavek o ověření odpovědět kódem odezvy 2XX a navíc může i těmato dvěma způsoby vrátit stejnou hodnotu ID klienta:

  1. V hlavičce odpovědiX-AdobeSign-ClientId. Tato hlavička je předána v požadavku a zároveň i vrácena v odpovědi.
  2. V těle odpovědi objektu JSON s klíčemX-AdobeSign-ClientId a jeho hodnota odpovídá ID klienta, které je odesláno v požadavku.

Služba Adobe Sign přijímá odezvu 2xx pomocí prvku X-AdobeSign-ClientId.Uživatel může zkontrolovat, zda je ve webhooku nastaven správně, nebo ne.

Adresa URL webhooku neodpovídá očekávanému chování. Pro každé upozornění Post odeslané službou Adobe Sign, adresa URL odpoví kódem stavu 2XX a vrátí ID klienta odeslané v hlavičce požadavku (prvku X-AdobeSign-ClientId) v hlavičce odpovědi.

Úplné informace najdete na následujícím odkazu:
https://www.adobe.io/apis/documentcloud/sign/docs.html#!adobedocs/adobe-sign/master/webhooks/webhook_events.md

Pokud adresa URL nesplňuje tento protokol, služba Adobe Sign dojde k závěru, že požadavek nebyl přijat a podle nastavení se pokusí o opětovné odeslání později.

Pokud webhook nezašle odpověď a dojde buďto k přesáhnutí doby na opětovné pokusy nebo intervalu opakování, webhook se vypne.

  Na příspěvky ze služeb Twitter™ a Facebook se nevztahují podmínky licence Creative Commons


Správa/získání informací o dohodách

Ke změně dokumentu, který již byl odeslán k podpisu, použijte metodu PUT /agreements/{agreementId}, která slouží k aktualizaci stávající dohody. Zadejte přechodné ID spolu s ID dohody do následujícího kódu požadavku:

 

{

  "documentUpdateInfo": {

    "fileInfos": [

      {

        "agreementDocumentId": "",

        "transientDocumentId": ""

      }

    ]

  }

}

 

Níže najdete pokyny k tomu, jak aktualizovat stav z „VYTVÁŘENÍ“ na „ZPRACOVÁVÁ SE“ pomocí operace Put /agreements/{agreementId}/state:

  1. Získejte ID dohody přes volání metodou POST/Agreement.

  2. Pomocí volání Get /agreements/{agreementId} se načte nejnovější značka entity.

  3. Přejděte do části Put /agreements/{agreementId}/state a zadejte následující údaje: "state": "IN_PROCESS"

Ne.

V aktuálním rozhraní API typu REST neexistuje způsob, jak nahrát podepsanou kopii.

Odesílatel musí podepsanou kopii odeslat ze stránky Správa.

Prvek DELETE /agreements/ID se používá ke skrytí dohody na stránce Správa.

Společnost Adobe má nový prvek rozhraní API PUT /agreements/ID/me/visibility, který řídí viditelnost dohody (v rámci prvku GET /agreements). Kromě funkcí poskytovaných prvkem DELETE /agreements/ID nový koncový bod viditelnosti umožňuje uživateli vrátit operaci „skrýt“, tedy znovu dohodu zviditelnit. 

Můžete také postupovat podle níže uvedených podrobně popsaných kroků:

  1. Přejděte na metodu get /agreements a získejte ID dohody.
  2. Klikněte na prvek put /agreements/{agreementId}/me/visibility a zadejte níže uvedenou žádost jako vzor:
    {
      "visibility": "HIDE"
    }
    ID dohody je skryto pouze před prvkem get /libraryDocuments, ale stále jej lze zobrazit v kartě Správa v uživatelském rozhraní.
Poznámka:

Funkce uchovávání API není ve výchozím nastavení zapnuta.

Chcete-li povolit operaci DELETE/agreements, obraťte se na svého manažera pro úspěch zákazníků a požádejte ho, aby tuto funkci pro váš účet povolil.

Další informace o tom, jak povolit funkci uchovávání v účtu najdete v části Služba Adobe Sign – Uchovávání dokumentů.

  1. Přihlaste se jako správce služby Adobe Sign a přejděte na:https://secure.adobesign.com/public/docs/restapi/v6

    • Klikněte na prvek agreements a rozbalte metodu GET /agreements
    • Klikněte na tlačítko PŘÍSTUPOVÝ TOKEN OAUTH
    • Povolte rozsah agreement_read:self
    • Klikněte na tlačítko Ověřit
      • Pokud se zobrazí výzva, klikněte na odkaz Povolit přístup
    • Klikněte na tlačítko Vyzkoušet.
    Metoda dohody typu GET

  2. Odpověď byla vygenerována.

    Prvek agreementId lze nalézt v těle odpovědi:

    Odpověď na metody dohody typu GET

  3. Volání DELETE /agreements/{agreementId}/documents: Odstraní všechny dokumenty propojené s dohodou. Samotnou dohodu si nadále můžete zobrazit na stránce Správa.

    • Vyberte operaci DELETE/agreements, kterou chcete spustit.
    • Klikněte na tlačítko PŘÍSTUPOVÝ TOKEN OAUTH a vygenerujte přístupový token s rozsahem areement_retention.
    • Zadejte prvek agreementId dohody, kterou chcete odstranit.
    • Po odstranění dohody tělo odpovědi bude zahrnovat část „žádný obsah“.

Pokud není operace DELETE/agreements povolena, odpověď bude mít následující podobu:

 "kód": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED",

  "zpráva": "K dokončení operace je potřeba povolit určitá nastavení účtu. Ve věci povolení nastavení se obraťte na tým Adobe Sign.“

Jak stáhnout podepsaný dokument spolu se zprávou o auditu a podpůrnými dokumenty přes rozhraní API typu REST služby Adobe Sign místo odděleného volání za účelem stažení zprávy o auditu způsobem uvedeným níže.

GET /agreements/{agreementId}/auditTrail

  1. Klikněte na prvek GET /agreements/{agreementId}/combinedDocument.

  2. Klikněte na tlačítko přístupový token OAuth.

  3. Přístupový token se vygeneruje automaticky po přijetí ověření.

  4. Zadejte prvek agreementId.

  5. V části attachSupportingDocuments vyberte z rozbalovací nabídky hodnotu true.

  6. V části attachAuditReport vyberte z rozbalovací nabídky hodnotu true.

  7. Klikněte na tlačítko Vyzkoušet .

    Získat sloučené dokumenty

    Stáhne se sloučený soubor PDF podepsaného, podpůrný dokument a zpráva o auditu.

K hromadnému stahování dokumentů je k dispozici pouze nástroj na export, přes rozhraní API musíte dokumenty stahovat jeden po druhém. Níže naleznete metody využití rozhraní API se stejným výsledkem:

https://secure.na1.adobesign.com/public/docs/restapi/v5#!/agreements/getCombinedDocument


Šablony knihovny a webové formuláře

  1. Přihlaste se do služby Adobe Sign jako správce a přejděte na adresu: https://secure.na1.adobesign.com/public/docs/restapi/v6

    • Klikněte na prvek libraryDocuments a rozbalte metodu GET /libraryDocuments
    • Klikněte na tlačítko PŘÍSTUPOVÝ TOKEN OAUTH
    • Povolte rozsah library_read:self
    • Klikněte na tlačítko Ověřit
      • Pokud se zobrazí výzva, klikněte na odkaz Povolit přístup
    • Klikněte na tlačítko Vyzkoušet.
    Metoda dokumentů knihovny typu GET

  2. Odpověď byla vygenerována.

    Prvek libraryDocumentId lze nalézt v těle odpovědi:

    Odpověď dokumentů knihovny typu GET

Společnost Adobe má nový prvek rozhraní API PUT/libraryDocuments/ID/me/visibility, který řídí viditelnost dohody (v rámci prvku GET /agreements). Kromě funkcí poskytovaných prvkem DELETE /agreements/ID nový koncový bod viditelnosti umožňuje uživateli vrátit operaci „skrýt“, tedy znovu dohodu zviditelnit.

Můžete postupovat podle níže uvedených podrobně popsaných kroků:

  1. Přejděte na metodu get /libraryDocuments a získejte ID dohody.
  2. Klikněte na prvek put /libraryDocuments/{libraryDocumentId}/me/visibility a zadejte níže uvedenou žádost jako vzor:
    {
      "visibility": "HIDE"
    }
    ID knihovny je skryto pouze před prvkem get /libraryDocuments, ale stále jej lze zobrazit v kartě Správa v uživatelském rozhraní.
Poznámka:
  • Odešlete požadavek týmu podpory, aby upravili váš rozsah tak, aby umožňoval odstraňování knihoven.
  • Rozhraní API odstraní dokument knihovny. Dohody vytvořené pomocí tohoto dokumentu knihovny nebudou nijak dotčeny.


Generování prvku libraryDocumentID

  1. Přejděte na stránku https://secure.echosign.com/public/docs/restapi/v5.

  2. Klikněte na prvek libraryDocuments.

  3. Klikněte na tlačítko přístupový token OAuth.

    Ověřit přístup – Token pro sebe, skupinu nebo účet.

  4. Vyberte prvek libraryTemplateType – prvky Document nebo Form_field_layer.

  5. Klikněte na odkaz Vyzkoušet.

    Ke všem šablonám můžete obdržet odpověď v následujícím znění. (Zkopírujte prvek libraryDocumentId šablony knihovny, kterou chcete odstranit).

    { 
      "libraryDocumentList": [ 
        { 
          "name": "testing fields", 
          "modifiedDate": "2017-08-04T01:06:05-07:00", 
          "scope": "PERSONAL", 
          "libraryDocumentId": "3AAABLblqZhAK53Dvzq88Q1Ov0TEvMAySDPpIVjF1PWgUpy0H1uYggt4iwGiRSZYlWfl9ms_AcmgZ_uZMPPN2hNT9izwaspHc", 
          "libraryTemplateTypes": [ 
            "DOCUMENT" 
          ] 
        },


Odstraňování šablon knihovny

  1. Zkopírujte prvek libraryDocumentID z tělaodpovědi.

  2. Přejděte do části Odstranit dokumenty knihovny.

  3. Klikněte na tlačítko přístupový token OAuth. Ověřit přístup – Token pro sebe, skupinu nebo účet.

  4. Do pole Hodnota vložte prvek libraryDocumentId.

  5. Klikněte na odkaz Vyzkoušet. 
    Šablona byla odstraněna.

    Obdržíte následující kód odezvy: 204

Poznámka:

Aktualizace stavu webových formulářů je možná pouze ve stavu Koncept.

  1. Vytvořte widget pomocí prvku post /widgets.

  2. Získejte ID widgetu z prvku get/widgets.

  3. Po vytvoření metodou GET /widgets/{widgetId} z hlavičky odpovědi získejte značku entity.

    Foo

  4. V prvku put /widgets/{widgetId} použijte značku entity z prvku GET /widgets/{widgetId}. V parametru If-Match zadejte prvek widgetId a widgetInfo.

    Foo

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


Příklady případu užití

  1. Uskutečněte volání get/agreements se správným prvkem x-api-user.

  2. V těle odpovědi vyhledejte dohodu ve stavu odesláno k podpisu, vyhledejte adresu URL použitou k přihlášení a zaznamenejte si ID dohody

  3. Uskutečněte volání get/agreements/{agreementId}/signingUrls pomocí ID dohody, které jste získali z volání get/agreements.

     

    Výsledek

    Vrácenou hodnotou bude e-mailová adresa podepisujícího nebo podepisujících a adresa URL elektronického podpisu.

    Metoda dohody typu GET

Získejte pomoc rychleji a snáze

Nový uživatel?