Användarhandbok Avbryt

API för Adobe Acrobat Sign – vanliga frågor och svar

 

Användarhandbok för Adobe Acrobat Sign

Nyheter

  1. Förhandsversionsinformation
  2. Versionsinformation
  3. Viktiga meddelanden

Kom igång

  1. Snabbstartsguide för administratörer
  2. Snabbstartsguide för användare
  3. För utvecklare
  4. Videosjälvstudiebibliotek
  5. Vanliga frågor och svar

Administrera

  1. Översikt av Admin Console
  2. Användarhantering
    1. Lägga till användare
      1. Lägg till en användare
      2. Skapa användare i bulk
      3. Lägg till användare från din katalog
      4. Lägg till användare från MS Azure Active Directory
    2. Skapa funktionsfokuserade användare
      1. Tekniska konton - API-drivna
      2. Tjänstkonton - manuellt drivna
    3. Sök efter användare med etableringsfel
    4. Ändra namn/e-postadress
    5. Redigera en användares gruppmedlemskap
    6. Redigera en användares gruppmedlemskap via gruppgränssnittet
    7. Uppgradera en användare till en administratörsroll
    8. Användaridentitetstyper och SSO
    9. Byt användaridentitet
    10. Autentisera användare med MS Azure
    11. Autentisera användare med Google-federation
    12. Produktprofiler
    13. Inloggningsupplevelse
  3. Konto-/gruppinställningar
    1. Inställningsöversikt
    2. Globala inställningar
      1. Kontonivå och ID
      2. Ny mottagarupplevelse
      3. Arbetsflöden för självsignering
      4. Massutskick
      5. Webbformulär
      6. Anpassat arbetsflöde för utskick
      7. Power Automate-arbetsflöden
      8. Biblioteksdokument
      9. Samla formulärdata med avtal
      10. Begränsad dokumentsynlighet
      11. Bifoga en PDF-kopia av det signerade avtalet
      12. Inkludera en länk i e-postmeddelandet
      13. Inkludera en bild i e-postmeddelandet
      14. Filer som bifogas i e-post namnges som
      15. Bifoga granskningsrapporter till dokument
      16. Sammanfoga flera dokument till ett
      17. Hämta enskilda dokument
      18. Ladda upp ett signerat dokument
      19. Delegering för användare i mitt konto
      20. Tillåt att externa mottagare delegerar
      21. Behörighet att signera
      22. Behörighet att skicka
      23. Behörighet att lägga till elektroniska stämplar
      24. Ange standardtidszon
      25. Ange standarddatumformat
      26. Användare i flera grupper (UMG)
        1. Uppgradera för att använda UMG
      27. Behörigheter för gruppadministratörer
      28. Ersätt mottagare
      29. Granskningsrapport
        1. Översikt
        2. Tillåt icke-autentiserad åtkomst på sidan för transaktionsverifiering
        3. Inkludera påminnelser
        4. Inkludera visningshändelser
        5. Inkludera antal avtalssidor/bilagor
      30. Transaktions-sidfot
      31. I produktmeddelanden och -vägledning
      32. Åtkomliga PDF-filer
      33. Ny författarupplevelse
      34. Hälsovårdskund
    3. Kontoinställning
      1. Lägg till logotyp
      2. Anpassa företagets värdnamn/URL    
      3. Lägg till företagsnamn
      4. URL för omdirigering efter avtal
    4. Signaturinställningar
      1. Väl formaterade signaturer
      2. Tillåt mottagare att signera efter
      3. Signerare får inte ändra sitt namn
      4. Tillåt att mottagare kan använda sin sparade signatur
      5. Anpassade användningsvillkor och konsumentsekretess
      6. Navigera mottagare genom formulärfält
      7. Starta om arbetsflöde för avtal
      8. Avböj att signera
      9. Tillåt stämpelarbetsflöden
      10. Kräv att signerare tillhandahåller sin titel eller sitt företag
      11. Tillåt att signerare skriver ut och gör en skriftlig signatur
      12. Visa meddelanden vid e-signering
      13. Kräv att signerare gör signaturer och initialer med en mobil enhet
      14. Begär IP-adress av undertecknare
      15. Exkludera företagsnamn och titel från deltagandestämplar
    5. Digitala signaturer
      1. Översikt
      2. Hämta och signera med Acrobat
      3. Signera med molnsignaturer
      4. Inkludera metadata för identitetsleverantörer
      5. Begränsade leverantörer av molnsignaturer
    6. Elektroniska sigill
    7. Digital identitet
      1. Digital Identity Gateway
      2. Princip för identitetskontroll
    8. Rapportinställningar
      1. Ny rapporteringsupplevelse
      2. Klassiska rapporteringsinställningar
    9. Säkerhetsinställningar
      1. Inställningar för enkel inloggning
      2. Inställningar för Kom ihåg mig
      3. Policy för inloggningslösenord
      4. Styrka för inloggningslösenord
      5. Webbsessionens varaktighet
      6. Typ av PDF-kryptering
      7. API
      8. Informationsåtkomst för användare och grupper
      9. Tillåtna IP-intervall
      10. Kontodelning
      11. Behörigheter för kontodelning
      12. Delningskontroller för avtal
      13. Verifiering av signeraridentitet
      14. Signeringslösenord för avtal
      15. Dokumentlösenordets styrka
      16. Blockera signerare efter geolokalisering
      17. Telefonautentisering
      18. Kunskapsbaserad autentisering (KBA)
      19. Tillåt sidextrahering
      20. Dokumentlänkens förfallotid
      21. Överför ett klientcertifikat för webhookar/återanrop
      22. Tidsstämpel
    10. Skicka-inställningar
      1. Visa sidan Skicka efter inloggning
      2. Kräv mottagarnamn för att skicka
      3. Lås namnvärden för kända användare
      4. Tillåtna mottagarroller
      5. Tillåt e-vittnen
      6. Mottagargrupper
      7. CC-mottagare
      8. Mottagarens avtalsåtkomst
      9. Obligatoriska fält
      10. Bifoga dokument
      11. Förenkla fält
      12. Ändra avtal
      13. Avtalsnamn
      14. Språk
      15. Privata meddelanden
      16. Tillåtna signaturtyper
      17. Påminnelser
      18. Lösenordsskydd för signerade dokument
      19. Skicka avtalsmeddelande via
      20. Alternativ för identifiering av signerare
        1. Översikt
        2. Signeringslösenord
        3. Engångslösenord via e-post
        4. Acrobat Sign-autentisering
        5. Telefonautentisering
        6. Molnbaserad digital signatur
        7. Kunskapsbaserad autentisering
        8. Myndighets-ID
        9. Rapporter över signeraridentitet
      21. Innehållsskydd
      22. Aktivera Notarize-transaktioner
      23. Förfallotid för dokument
      24. Förhandsgranska, placera signaturer och lägg till fält
      25. Signeringsordning
      26. Liquid Mode
      27. Anpassade arbetsflödeskontroller
      28. Uppladdningsalternativ för e-signeringssidan
      29. Bekräftelseadress för omdirigering efter signering
    11. Meddelandemallar
    12. Bioläkemedelsinställningar
      1. Översikt
      2. Kräv identitetsautentisering
      3. Anledningar till signering
    13. Arbetsflödesintegrering
    14. Attesteringsinställningar
    15. Betalningsintegrering
    16. Signerarmeddelanden
    17. SAML-inställningar
      1. SAML-konfiguration
      2. Installera Microsoft Active Directory Federation Service
      3. Installera Okta
      4. Installera OneLogin
      5. Installera Oracle Identity Federation
    18. Datastyrning
    19. Inställningar för tidsstämpling
    20. Externt arkiv
    21. Kontospråk
    22. E-postinställningar
      1. Sidhuvuds- och sidfotsbilder för e-post
      2. Tillåt sidfötter för enskilda användares e-postmeddelanden
      3. Anpassa e-postmeddelandet med begäran om signatur
      4. Anpassa fälten Till och Kopia
      5. Aktivera meddelanden utan länkar
      6. Anpassa e-postmallar
    23. Migrera från echosign.com till adobesign.com
    24. Konfigurera alternativ för mottagare
  4. Riktlinjer för lagstadgade krav
    1. Tillgänglighet
      1. Tillgänglighetsefterlevnad
      2. Skapa tillgängliga formulär med Acrobat Desktop
      3. Skapa tillgängliga AcroForms
    2. HIPAA
    3. GDPR
      1. GDPR-översikt
      2. Redigera bort en användare
      3. Redigera bort ett användaravtal    
    4. 21 CFR del 11 och EudraLex bilaga 11
      1. 21 CRF del 11 valideringspaket
      2. 21 CFR och EudraLex bilaga 11 handbok
      3. Analys av delade ansvar
    5. Hälsovårdskunder
    6. Stöd för IVES
    7. Säkrade avtal
    8. Överväganden mellan EU och Storbritannien
      1. Gränsöverskridande transaktioner och eIDAS mellan EU och Storbritannien
      2. HMLR-krav för elektroniskt signerade handlingar
      3. Brexits inverkan på lagstiftningen om e-signaturer i Storbritannien
  5. Hämta flera avtal samtidigt
  6. Gör anspråk på din domän 
  7. Länkar för att rapportera missbruk

Skicka, signera och hantera avtal

  1. Mottagaralternativ
    1. Avbryta en e-postpåminnelse
    2. Alternativ på e-signeringssidan
      1. Översikt över e-signeringssidan
      2. Öppna för att läsa avtalet utan fält
      3. Avböj att signera ett avtal
      4. Delegera signeringsbehörighet
      5. Starta om avtalet
      6. Hämta en PDF-fil av avtalet
      7. Visa avtalshistoriken
      8. Visa avtalsmeddeladen
      9. Konvertera från en elektronisk till en skriftlig signatur
      10. Konvertera från en skriftlig till en elektronisk signatur 
      11. Navigera formulärfälten
      12. Rensa data från formulärfälten
      13. Förstoring och navigering av e-signeringssidan
      14. Ändra språket som används i avtalsverktygen och informationen
      15. Granska juridiska meddelanden
      16. Justera cookiepreferenser för Acrobat Sign
  2. Skicka avtal  
    1. Översikt över sidan Skicka
    2. Skicka ett avtal bara till dig själv
    3. Skicka ett avtal till andra
    4. Skriftliga signaturer
    5. Mottagarnas signeringsordning
    6. Massutskick
      1. Översikt över funktionen Massutskick
      2. Skicka massutskick - konfigurera en överordnad mall
      3. Skicka massutskick - konfigurera CSV-filen
      4. Avbryt en Massutskickstransaktion
      5. Lägg till påminnelser till Massutskick
      6. Rapportering för Massutskick
  3. Redigera in fält i dokument
    1. Redigeringsmiljö i appen
      1. Identifiera fält automatiskt
      2. Dra och släpp fält med redigeringsmiljön
      3. Tilldela formulärfält till mottagare
      4. Förifyllningsrollen
      5. Tillämpa fält med en återanvändbar fältmall
      6. Överföra fält till en ny biblioteksmall
      7. Uppdaterad redigeringsmiljö när avtal skickas
    2. Skapa formulär och texttaggar
    3. Skapa formulär med Acrobat (AcroForms)
      1. Skapa AcroForm
      2. Skapa tillgängliga PDF-filer
    4. Fält
      1. Fälttyper
        1. Vanliga fälttyper
        2. Textbundna bilder
        3. Stämpelbilder
      2. Utseende på fältinnehåll
      3. Fältvalideringar
      4. Maskerade fältvärden
      5. Välj visa/dölj villkor
      6. Beräkningsfält 
    5. Vanliga frågor om redigering
  4. Signera avtal
    1. Signera avtal som har skickats till dig
    2. Fyll i och signera
    3. Självsignering
  5. Hantera avtal
    1. Översikt över sidan Hantera
    2. Delegera avtal
    3. Ersätt mottagare
    4. Begränsa dokumentsynlighet 
    5. Avbryta ett avtal 
    6. Skapa nya påminnelser
    7. Granska påminnelser
    8. Avbryta en påminnelse
    9. Åtkomst till Power Automate-flöden
    10. Fler åtgärder...
      1. Så här fungerar sökning
      2. Visa ett avtal
      3. Skapa en mall från ett avtal
      4. Dölja/visa avtal från vyn
      5. Överför signerat avtal
      6. Ändra filer och fält i ett skickat avtal
      7. Redigera en mottagares autentiseringsmetod
      8. Lägg till eller ändra ett förfallodatum
      9. Lägga till en anteckning i avtalet
      10. Dela ett enskilt avtal
      11. Sluta dela ett avtal
      12. Ladda ner ett enskilt avtal
      13. Hämta de enskilda filerna i ett avtal
      14. Hämta granskningsrapporten för ett avtal
      15. Hämta fältinnehållet i ett avtal
  6. Granskningsrapport
  7. Rapportering och dataexporter
    1. Översikt
    2. Bevilja användare åtkomst till rapportering
    3. Rapportdiagram
      1. Skapa en ny rapport
      2. Avtalsrapporter
      3. Transaktionsrapporter
      4. Aktivitetsrapport för inställningar
      5. Redigera en rapport
    4. Dataexport 
      1. Skapa en ny dataexport
      2. Dataexport av webbformulär
      3. Redigera en dataexport
      4. Uppdatera innehållet för dataexport
      5. Hämta dataexporten
    5. Byt namn på en rapport/export
    6. Duplicera en rapport/export
    7. Schemalägg en rapport/export
    8. Ta bort en rapport/export
    9. Kontrollera transaktionsanvändning

Avancerade avtalsfunktioner och arbetsflöden

  1. Webbformulär 
    1. Skapa ett webbformulär
    2. Redigera ett webbformulär
    3. Inaktivera/aktivera ett webbformulär
    4. Dölja/Visa ett webbformulär
    5. Hitta URL eller inbäddningskod 
    6. Förifyll webbformulärfält med URL-parametrar
    7. Spara ett webbformulär för att slutföra senare
    8. Ändra storlek på webbformulär
  2. Återanvändbara mallar (Biblioteksmallar) 
    1. Amerikanska myndighetsformulär i Acrobat Sign-biblioteket
    2. Skapa en biblioteksmall
    3. Ändra namn på en biblioteksmall
    4. Ändra typ på en biblioteksmall
    5. Ändra behörighetsnivån för en biblioteksmall
    6. Kopiera, redigera och spara en delad mall
    7. Hämta sammanställda fältdata för en biblioteksmall
  3. Överför ägarskap av webbformulär och biblioteksmallar
  4. Power Automate-arbetsflöden 
    1. Översikt över Power Automate-integreringen och inkluderade rättigheter
    2. Aktivera Power Automate-integreringen
    3. Åtgärder i kontexten på sidan Hantera
    4. Spåra Power Automate-användningen
    5. Skapa ett nytt flöde (Exempel)
    6. Utlösare som används för flöden
    7. Importera flöden från utanför Acrobat Sign
    8. Hantera flöden
    9. Redigera flöden
    10. Dela flöden
    11. Inaktivera eller aktivera flöden
    12. Ta bort flöden
    13. Användbara mallar
      1. Endast administratör
        1. Spara alla slutförda dokument i SharePoint
        2. Spara alla slutförda dokument på OneDrive för företag
        3. Spara alla slutförda dokument på Google Drive
        4. Spara alla slutförda dokument i DropBox
        5. Spara alla slutförda dokument i Box
      2. Avtalsarkivering
        1. Spara dina slutförda dokument i SharePoint
        2. Spara dina färdiga dokument på OneDrive för företag
        3. Spara alla slutförda dokument på Google Drive
        4. Spara alla slutförda dokument i DropBox
        5. Spara slutförda dokument i Box
      3. Arkivering av webbformuläravtal
        1. Spara slutförda webbformulärdokument i SharePoint-biblioteket
        2. Spara slutförda webbformulärdokument i OneDrive för företag
        3. Spara dina slutförda dokument i Google Drive
        4. Spara slutförda webbformulärdokument i Box
      4. Dataextrahering av avtal
        1. Extrahera formulärfältdata från ditt signerade dokument och uppdatera Excel-blad
      5. Avtalsmeddelanden
        1. Skicka anpassade e-postmeddelanden med avtalsinnehållet och det signerade avtalet
        2. Få dina Adobe Acrobat Sign-aviseringar i en Teams-kanal
        3. Få dina Adobe Acrobat Sign-aviseringar i Slack
        4. Få Adobe Acrobat Sign-aviseringar i Webex
      6. Avtalsgenerering
        1. Generera dokument från Power App-formulär och Word-mall, skicka för signering
        2. Generera avtal från en Word-mall i OneDrive och hämta signaturen
        3. Generera avtal för vald Excel-rad, skicka för granskning och signering
  5. Anpassat arbetsflöde för sändning
    1. Översikt av anpassat arbetsflöde för sändning
    2. Skapa ett nytt arbetsflöde för sändning
    3. Redigera ett arbetsflöde för sändning
    4. Aktivera eller inaktivera ett arbetsflöde för sändning
    5. Skicka ett avtal med ett arbetsflöde för sändning
  6. Dela användare och avtal
    1. Dela en användare
    2. Dela avtal

Integrera med andra produkter

  1.  Översikt över Acrobat Sign-integreringar 
  2. Acrobat Sign för Salesforce
  3. Acrobat Sign för Microsoft
    1. Acrobat Sign för Microsoft 365
    2. Acrobat Sign för Outlook
    3. Acrobat Sign för Word/PowerPoint
    4. Acrobat Sign för Teams
    5. Acrobat Sign för Microsoft PowerApps och Power Automate
    6. Acrobat Sign Connector för Microsoft Search
    7. Acrobat Sign för Microsoft Dynamics 
    8. Acrobat Sign för Microsoft SharePoint 
  4. Övriga integreringar
    1. Acrobat Sign för ServiceNow
    2. Acrobat Sign för HR ServiceNow
    3. Acrobat Sign för SAP SuccessFactors
    4. Acrobat Sign för Workday
    5. Acrobat Sign för NetSuite
    6. Acrobat Sign för VeevaVault
    7. Acrobat Sign för Coupa BSM Suite
  5. Partnerhanterade integreringar
  6. Så skapar du en integreringsnyckel

Adobe Sign-utvecklare

  1. REST-API:er 
    1. Dokumentation av metoder
    2. SDK/Användarhandbok för utvecklare
    3. Vanliga frågor om API:er  
  2. Webhookar 
    1. Webhook-översikt
    2. Konfigurera en ny webhook
    3. Visa eller redigera en webhook
    4. Inaktivera eller återaktivera en webhook
    5. Ta bort en webhook
    6. Tvåvägs SSL-certifikat
    7. Webhookar i API:n

Support och felsökning

  1. Kundsupportresurser 
  2. Storföretagsresurser för kundframgång 

API-åtkomst är exklusivt reserverad för storföretags- och utvecklarkonton.

Länkar till viktig dokumentation

Obs!

Stödet för de äldre SOAP-API:erna upphörde i maj 2021.

Alla kunder som använder SOAP-API:er bör migrera till REST API så snart som möjligt.

När du är inloggad går du till Konto > Acrobat Sign API > API-information > REST API:er och dokumentation.


Allmänna begrepp

Du kan inte skapa dokumentet genom att se sidan i webbgränssnittet eller genom att dra och släppa eller tilldela signeringsroller med transientDocumentId via API.

Anropet transientDocuments returnerar ett transientDocumentID, som är giltigt i sju dagar.  Du kan bara använda det för de ytterligare API-anropen. Den lagras på API-servern och tilldelas detta ID. Överför en fil och referera sedan dess ID i de övriga API-anropen.

Du kan inte överföra ett dokument direkt i avtalet med hjälp av REST API.

Enligt REST-kravet måste du först skapa ett tillfälligt dokument och sedan använda detta ID i metoderna Agreement, Widget eller Library som filkälla.

Det tillfälliga dokumentet är en Raw-källfil, t.ex. .PDF, .doc eller .docx som har överförts till Adobe-servrarna. Det är alltså ett bekvämt sätt att skicka basdokumentet till API-servrarna och ett tillfälligt dokument på webben.

Ja, du kan bokföra avtal med arbetsflöden i v6 genom att använda API-anrop/avtal. Skicka parametern workflowId i API-anropet.

Du kan hämta workflowId för ett arbetsflöde med hjälp av GET /workflows-anrop.

  1. Logga in i Adobe Sign som administratör

  2. Gå till Konto > Adobe Sign-API > API-begärningslogg

    API-loggar

  1.  Logga in på Adobe Sign-kontot som administratör

  2. Gå till Konto > Adobe Sign-API > API-information

  3. Klicka på länken REST API-exempel.

    Obs!

    Hämta JavaScript SDK genom att gå till https://github.com/adobe-sign/AdobeSignJsSdk.

Från och med v6 är alternativet skicka via webben inte längre tillgängligt. Tillståndet ersätter det. Det är tillståndet som avtalet gäller i. Tillståndsfältet kan bara anges i POST-anrop. Det returneras aldrig i GET/agreements/{ID} och ignoreras om det anges i PUT /agreements/{ID}-anrop. Avtalets slutliga status kan hämtas från GET/avtal/ID.

state(string) = ['AUTHORING', 'DRAFT' eller 'IN_PROCESS'].

AUTHORING låter en användare redigera avtalsdokumenten innan de skickas ut. Utvecklingsåtgärden här avser att skapa, redigera eller placera formulärfält tillsammans med deras konfigurationer (tilldelning, villkor, datatyp osv.). i avtalsdokumenten. När dokumentet har publicerats i redigeringsläget visas det i avsnittet Utkast på fliken Hantera i Adobe Sign.

DRAFT är ett tillfälligt eller primitivt steg i den slutliga avsedda resursen som kan uppdateras stegvis för att skapa den slutliga resursen och visas inte i avsnittet Utkast på fliken Hantera i Adobe Sign. Om du använder utkastläget krävs ingen information om deltagaruppsättningen och den kan tilldelas senare när du gör PUT/avtal/agreementId för att slutföra utkastet. Det här steget kan itereras flera gånger till du har alla nödvändiga data för att skapa avtalet.

IN_PROCESS ändrar avtalsstatusen till Skickat för signatur och visas i avsnittet Skickat för signatur på fliken Hantera i Adobe Sign.

Med sendThroughWeb kan du skicka avtalet interaktivt. De olika parametrarna i alternativfältet i v5 POST-/avtalsbegäran låter användaren konfigurerar den här interaktiva vyn (skicka sida). Alla dessa konfigurationsparametrar för sidan, såsom Uppladdningsalternativ flyttas till POST avtal/ID/vy-api.

Det innebär att du kan uppnå sendThroughWeb genom att skapa ett avtal i läget AUTHORING via API:et POST /agreements. Du kan sedan anropa webbadressen till nästa sida i önskad konfiguration genom att anropa API:et POST avtal/ID/vyer.

Utför följande åtgärder:

1. Gå till dokumentationen för REST API V6 och välj metoden POST/agreements.
2. Använd följande begärandekod:

{

  "fileInfos": [

    {

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

    }

  ],

  "name": "test",

  "participantSetsInfo": [

    {

      "memberInfos": [

        {

          "email": "abc@gmail.com"

        }

      ],

      "order": 1,

      "role": "SIGNER"

    }

  ],

  "signatureType": "ESIGN",

  "state": "AUTHORING"

}

 

3. Använd sedan metoden post/avtal/{agreementId}/vyer med begärandekoden nedan:

 

{

  "name": "AUTHORING"

}

Svarskoden tillhandahåller URL:en för redigeringsfälten.

Du kan definiera callback-URL:en på följande sätt:

  • Använd parametern nedan för att definiera callback-URL:en efter behov:

    "callbackInfo": "",
  • Kontakta supporten för Adobe Sign för att ange den standardiserade callback-URL:en för fullständigt konto.

SOAP-gränssnittet (SmartBear) får SSL-anslutningsfel som liknar följande, vilket du får när du gör API-anrop. Det här felet inträffar vanligtvis om du använder ett inaktuellt SSL- eller TLS-protokoll som är äldre än TLS1.2

FEL: undantag i begäran: javax.net.ssl.SSLException: allvarlig varning togs emot: protocol_version
FEL: ett fel uppstod [allvarlig varning togs emot: protocol_version], mer information finns i felloggen

  1. Lägg till (-Dsoapui.https.protocol=SSLv3,TLSv1.2) i VMOPTIONS-filen under Bin-mappen.

  2. Gå till C:\Program Files\SmartBear\SoapUI-5.2.1\bin (beroende på var du har installerat SOAP-gränssnittet. Det kan finnas under C:\Program Files (x86))

  3. Aktivera fullständig läs-/skrivbehörighet i VMOPTIONS-filen.

    VMOPTIONS

  4. Högerklicka på VMOPTIONS-filen > Egenskaper > fliken Säkerhet > Välj Användare > Klicka på Redigera. (Ikonen Kontroll av användaråtkomst visas på knappen Redigera) > Markera alla kryssrutorna och klicka på OK.

  5. Upprepa samma sak för Administratörer, System och alla programpaket.

  6. Öppna filen med Anteckningar.

  7. Lägg till det här protokollet längst ned "-Dsoapui.https.protocol=SSLv3,TLSv1.2" och spara ändringarna.

  8. Stäng SOAP-gränssnittet och starta om. Det fungerar utan SSL-fel när du gör API-anrop. (Utför ett ping-anrop för att kontrollera).

Så skapar du klient-ID och klienthemlighet i programmet Adobe Sign:

  1. Logga in på Adobe Sign-kontot.

  2. Gå till Konto > Adobe Sign-API > API-program

    Fnord.

  3. Klickar på +-ikonen för att skapa ett program.

    Fnord.

  4. Ange namn och visningsnamn.

  5. Välj KUND under Under Domän och klicka på Spara.

    Fnord.

  6. Markera programmet med ett klick.

  7. Klicka på Konfigurera OAuth för program.

    Fnord.

  8. Ange omdirigerings-URI.

  9. Markera respektive kryssruta och klicka på Spara för att aktivera önskade omfång.

  1. Logga in på Adobe Sign som kontoadministratör

  2. Gå till Konto > Adobe Sign-API > API-information

  3. Klicka på länken Integreringsnyckel

    Gå till integreringsnyckel

    Obs!

    Om du inte ser länken Integreringsnyckel ska du kontakta din Success Manager och be denne aktivera kontot.

    • Namnge nyckeln med ett intuitivt värde
    • Välj de olika omfång som krävs för din programfunktion
    • Klicka på Spara när nyckeln är helt konfigurerad
    Skapa integrationsnyckelns gränssnitt

  4. När nyckeln har sparats finns den i: Konto > Personliga inställningar > Åtkomsttoken

    Namnet på nyckeln och alla aktiverade omfång visas.  

    Klicka på nyckelbeskrivningen en gång för att visa åtgärdslänkarna:

    • Integreringsnyckel – den här länken innehåller den faktiska nyckeln 
    • Återkalla – detta återkallar och tar bort åtkomsttoken permanent
    Åtkomsttoken – integreringsnyckel

  1. Logga in på Adobe Sign-kontot.

  2. Gå till Konto > Adobe Sign-API > API-program

  3. Klicka på +-ikonen för att skapa ett program.

    Postman1

  4. Klicka på Konfigurera OAuth för program.

    Fnord.

  5. Generera en auktoriseringskod med följande länk. Klient-ID, omdirigerings-URI och omfattningar måste vara samma som i följande URL som har valts i programmet (undvik utrymme i följande URL och kortet såsom ”NA1” är lika som det som Adobe Sign-kontot tillhör):

    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. Om samtalet lyckas ska du välja auktoriseringskod i adressfältet.

    Fnord.

  7. Hämta och installera Postman via länken https://www.getpostman.com/apps.

  8. Klicka på NYTT för att skapa en POST när nedladdningen och installationen är klar.

  9. Ange länken https://secure.na1.echosign.com/oauth/token enligt ditt Adobe Sign-konto.

  10. Ange Innehållstyp som application/x-www-form-urlencoded under Rubriker.

  11. Kontrollera att x-www-form-urlencoded är markerad under Text och ange nedanstående parametrar med motsvarande värden från programmet som skapats i Adobe Sign och klicka på SKICKA.

    Fnord.

  12. Om all information är korrekt returneras åtkomsttoken och uppdateringstoken i svaret:

    Fnord.

När du kör OAuth-processen ska du se till att följa nedanstående punkter:

1. Korrekt klient-ID och omdirigerings-URI har angetts.
2. Omfattningar som anges i auktoriserings-URL:en ska överensstämma exakt med de omfattningar som anges i Adobe Sign-programmet.
3. Använd rätt kort (na1, na2, au1, eu1, jp1) enligt det konto som konfigureras.
4. Ta bort alla blanksteg som finns i auktoriserings-URL:en (om några).
5. Kontrollera syntaxen för auktoriserings-URL:en:

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

Åtkomsttoken är bara giltiga i 3600 sekunder (en timme) efter vilka de upphör att gälla.

Innehavaren av API-begäran kan använda uppdateringstoken för att generera nya åtkomsttoken efter behov.

Webhooks stöds i REST API v6 och senare versioner.

Om en Webhooks-mottagare inte svarar inom 72 timmar inaktiveras den och inget meddelande skickas.

Om mål-URL:en för en webhook av någon anledning inte fungerar ställer Adobe Sign JSON-servern i kö och försöker sedan köra push-funktionen på nytt under 72 timmar.

De ej levererade händelserna sparas i en kö för återförsök och allt görs under de kommande 72 timmarna för att leverera meddelandena i den ordning de inträffade.

Strategin för att försöka leverera meddelanden på nytt är en fördubbling av tiden mellan försöken, med ett intervall på 1 minut som ökar till var 12:e timme, vilket resulterar i 15 försök under 72 timmar.

 

Skapa en webhook direkt från gränssnittet i Adobe Sign genom att först skapa en webhook-URL via Azure AD-funktionsapparna genom att använda stegen nedan:

  1. Logga in via Microsoft-kontot https://portal.azure.com/.

  2. Registrera dig för funktionsappar under Azure AD-kontot.

    Azure-meny

  3. Gå till Azure AD och sedan till Funktionsappar > Klicka på +-ikonen för funktioner.

  4. Välj Webhook+API med Javascript som språk och klicka på funktionen Skapa.

    Azure API-gränssnitt

  5. Ersätt filen Index.js med följande kodfragment:

    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. Klicka på knappen Testa till höger och ange följande rubrik:

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

    API-test

  7. Klicka på Spara och kör.

  8. När du fått 200 OK-svar med följande rubrik ska du klicka på Hämta funktions-URL

    200 svar

  9. Kopiera webbadressen och gå till Adobe Sign UI > Webhooks > Klicka på +-ikonen för att skapa.

  10. Ange följande information: 

    • Namn: vi föreslår ett intuitivt namn som andra administratörer lätt kan förstå.
    • Omfång: hur brett nätet är som fångas upp av en webhook. Kontot och gruppen är tillgängliga i gränssnittet.
      API:et stöder omfattningar för konto, grupper, användare och resurser.
    • Endast ett omfång per webhook kan definieras
    • URL: mål-URL:en som Adobe Sign överförde JSON-nyttolasten till.
    • Händelser: utlösaren som gör att Adobe Sign skapar JSON och skickar den till URL:en.
      Varje händelse bygger en egen nyttolast som är relevant för att utlösa händelsen
      Flera händelser kan inkluderas i en webbhook.
    • Meddelandeparametrar: meddelandeparametrarna identifierar de avsnitt av händelsens JSON-nyttolast som gör att du bara kan välja de avsnitt av händelsen som är viktiga.
    Gränssnittet i Webhook

  11. När en webhook är helt definierad ska du klicka på Spara och den nya webhook:en börjar direkt reagera på utlösande händelser.

Avtalsresursen refererar till en resurs genom vilken du kan skapa ett avtal, såsom biblioteksdokument, widget och avtal.

Sök efter avtalshändelser genom att först skapa en begäran till API:et som skapar agreementAssetEvents med relevanta sökparametrar.

Svaret är den första resultatsidan tillsammans med en söknings ID-parametrar och nästa sidmarkör. Du kan använda den för att hämta ytterligare sidresultat om de är tillgängliga med API:et som hämtar avtalshändelser baserat på sök-ID.

  1. Öppna REST API-dokumentationen för version 5.

  2. Gå till post/search/agreementAssetEvents och generera åtkomsttoken med relevant omfång.

  3. Definiera start- och slutdatum i begärandekoden enligt kravet:

    { 
      "endDate": "2018-05-22T22:33:33", 
      "startDate": "2017-12-22T22:33:33" 
    }
  4. Klicka på Prova. Det hämtar ID:n för avtalstillgångar, som också kan användas som avtals-ID:n.


Användar-/kontohantering

  1. Logga in på Adobe Sign.
  2. Gå till Konto > Adobe Sign-API > REST API-dokumentation
  3. Välj version 5.
  4. Under metoden post/user ska du använda den begärandekod som anges under metoden
    UserCreationInfo
    {
    "email": "email@email.com",
    "firstName": "AA",
    "lastName": "AB",
    "password":"12******rte"
    }

Konton i Adobe Sign som använder Admin Console (Adobe One) för att hantera sina användarrättigheter kan inte använda API:et för Adobe Sign för att skapa användare eller hantera befintliga användare.

Adobe One Admin Console använder ett annat API än API:et för Adobe Sign. Mer information finns i följande artiklar:

 

Hämtar grupp-ID:

  1. Gå till https://secure.na1.echosign.com/public/docs/restapi/v5.

  2. Klicka på Grupper under Resurser och Åtgärder.

  3. Klicka på GET/grupper.

  4. Klicka på knappen för oAuth-åtkomsttoken.

  5. Generera åtkomsttoken.

  6. Klicka på knappen Prova.

    Du får ett svar enligt följande med gruppnamnet och grupp-ID:et:

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

Tar bort grupp:

  1. Klicka på DELETE /grupper/{groupId}.

  2. Klicka på knappen Åtkomsttoken för autentisering för att generera en åtkomsttoken.

  3. Lägg till det grupp-ID som togs emot som svar på föregående anrop som du vill ta bort i rutan groupId.

  4. Klicka på Prova.

    Du får svaret enligt följande när gruppen har tagits bort: inget innehåll

Obs!

Du kan inte ta bort en grupp som har tilldelats en användare. I själva verket kan du bara ta bort den tomma gruppen. Du får ett svar enligt följande om det finns en användare i gruppen.


{

  "code": "GROUP_NOT_EMPTY",

  "message": "Gruppen kan inte raderas eftersom den inte är tom."

}


Initiera/skicka avtal

Generera ett övergående dokument

  1. Klicka på transientDocuments och expandera metoden POSTEN /transientDocuments

  2. Klicka på knappen OAuth Access-token

    Metoden API TransientDocument

    • Aktivera omfånget för transaktionen
    • Klicka på Auktorisera
    OAuth-omfång

  3. Tillåt åtkomst

    Klicka på Tillåt åtkomst om du så uppmanas

  4. Du återgår nu till sidan API-metoder. Auktoriseringsvärdet är nu ifyllt.

    • Ange filnamnet i fältet Filnamn
    • Klicka på knappen Välj fil och överför dokumentet för avtalet
    • Klicka på Prova! knapp
    Prova!

  5. Svaret genereras.

    transientDocumentID kan hittas i svarstexten:

    Övergående dokument-ID

Generera ett avtal med hjälp av det övergående dokumentet

  1. Klicka på avtal och expandera metoden POST /agreements

    • Klicka på knappen OAuth Access-token
    • Aktivera OAuth-omfånget
    • Klicka på Auktorisera
      • Klicka på Tillåt åtkomst om du så uppmanas
  2. Du återgår nu till sidan API-metoder. Auktoriseringsvärdet är nu ifyllt.

    • Kopiera skriptet nedan till en textredigerare (detta skript är bara ett minimalt konfigurerat exempel. Din produktionskod kommer att vara annorlunda)
    •  Infoga ditt TransientDocumentId-värde i koden där så indikeras
    { 
      "fileInfos": [ 
       {"transientDocumentId":"PASTE YOUR TRANSIENTDOCUMENTID HERE"} 
      ], 
      "name": "test doc", 
      "participantSetsInfo": [ 
        { 
          "memberInfos": [ 
            { 
              "email": "noreply@echosign.com" 
            } 
          ], 
          "order": 1, 
          "role": "SIGNER" 
        } 
      ], 
      "signatureType": "ESIGN", 
      "state": "DRAFT" 
    }

     

    • Kopiera det anpassade skriptet och klistra in det i fältet AgreementInfo
    • Klicka på Prova! knapp
    Avtalsmetod för POST

  3. Svaret genereras.

    Du kan hitta agreementID i svarstexten:

    Svar på avtalsmetod för POST

Så lägger du till filer i parametern FileInfo:

  1. Använd ett övergående ID:

    Gå till POST/transientDocuments och överför dokumentet som ska användas från ditt lokala system.
    Använd det övergående ID:et som har genererats under avsnittet Filinformation i POST/Agreements:

    "fileInfos": [ 
         { 
           "transientDocumentId": "" 
         } 
       ],
  2. Använd biblioteksdokument-ID:

    Gå till kontrollpanelen. Klicka på Lägg till dokument i biblioteket och spara mallen.
    Klicka på GET /libraryDocuments under REST API-dokumentationen och hämta biblioteks-ID:et för mallen som har skapas.
    Ange biblioteksdokumentets ID under POST/Agreements:

    "libraryDocumentId": "", 
      "libraryDocumentName": "",
  3. Använd offentligt tillgänglig URL:

    Ange den offentligt tillgängliga URL som ska användas under parametern FileInfo:

    { 
          "documentURL": { 
            "mimeType": "", 
            "name": "", 
            "url": "" 
          },
  1. Markera alternativet Avtal > POST/agreements. 

  2. Välj alternativet Oauth-åtkomsttoken och ange nödvändiga omfång.

  3. När åtkomsttoken har lagts till kan du använda följande begärandekod:

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

Med anropet POST /agreement kan du för signaturflödesparametern skicka värdet SENDER_SIGNS_FIRST eller SENDER_SIGNS_LAST för att lägga till avsändaren som den första respektive sista signeraren.

Här är ett exempel på anropet i JSON-format:

{

  "documentCreationInfo": {

    "fileInfos": [

      {        "transientDocumentId":"3AAABLblqZ-yourIDGoesHere"

      }

    ],

    "name": "Test",

    "recipientSetInfos": [

      {

        "recipientSetMemberInfos": [

          {

            "email": "test@email.com"

          }

        ],

        "recipientSetRole": "SIGNER"

      }

    ],

    "signatureType": "ESIGN",

    "signatureFlow": "SENDER_SIGNS_FIRST"

  }

}

Obs!

Alternativet för att Skicka på uppdrag av är endast tillgängligt i REST API V6 med avancerad delning aktiverat.

Om sändningsbehörighet inte har angetts vid delning eller om Avancerad delning inte har aktiverats får du följande svar:

 

{"code":"PERMISSION_DENIED","message": "Användare som anges i rubriken x-on-hand-of-user saknar behörighet att utföra den här åtgärden."}

 

För funktionen Skicka på uppdrag av ska du aktivera Avancerad kontodelning för kontot så att användare kan ge behörighet att skicka till andra användare när de delar sitt konto. Se Aktivera avancerad kontodelning för mer information om avancerad delning.

När användardelning är aktiverad ska du följa dessa steg för att Skicka på uppdrag av:

Generera ett övergående dokument:

  1. Klicka på POST/transientDocuments under transientDocuments.

  2. Klicka på OAUTH ACCESS-TOKEN för att generera en token för auktorisering.

  3. Ange e-postadressen för den användare du vill, skicka på uppdrag av, i följande format: e-postadress: test@email.com

  4. Klicka på Välj fil och sedan Testa den för att välja en fil.

    Du får följande svar med transientDocumentId:

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

Generera ett avtal med hjälp av det övergående dokumentet:

  1. Klicka på POST/agreements under Avtal.

  2. Klicka på OAUTH ACCESS-TOKEN för att generera en token för auktorisering.

  3. Ange användarens e-postadress som avklarad när det övergående dokumentet skapas i x-on-behalf-of-user.

  4. Lägg till följande kod i AgreementInfo och klicka på Prova.

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

     

    Du får följande svar med agreementId:

    { 
      
      "id": "CBJCHBCAABAAUlen3l_fzlj1Kbn_wGZAhYcIgN0J7Qtq" 
      
    }
  1. Logga in på Adobe Sign.

  2. Gå till Konto > Adobe Sign API >API-information och klicka på dokumentation för metoden REST API.

    Gränssnittet i Webhook

  3. POST /transientDocuments och ladda upp en fil och skapa ett övergående dokument-ID.

  4. Kopiera det tillfälliga dokument-ID:et och använd det i metoden POST/agreements. Ange följande JSON-begäran i rutan:

    { 
        "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. Klicka på knappen Prova för att köra JSON-begäran.

    Gränssnittet i Webhook

    Rätt JSON returnerar svaret med avtals-ID:et.

    Gränssnittet i Webhook

Du kan ange följande parametrar i koden för att ange ett öppet lösenord:

 

{

    "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": "Öppna lösenordet för att se dokumentet",

               "securityOptions": {        

            "openPassword": "1234",

                     "protectOpen": true   

        }  

    }]

}

 

Så skapar du avtal med API:et med statusen "AUTHORING" med följande steg:

Gå till Post/agreements och skapa en åtkomsttoken med de nödvändiga omfången.

Använd begärandekoden på följande sätt:

 

{

  "fileInfos": [

    {

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

    }

  ],

  "name": "A1",

  "participantSetsInfo": [

    {

      "memberInfos": [

        {

          "email": "abc@xyz.com"

        }

      ],

      "order": 1,

      "role": "SIGNER"

    }

  ],

  "signatureType": "ESIGN",

  "state": "AUTHORING"

}

 

v6 har en uppsättning API:er för att skapa ett avtal. I v5 förbrukas formFields direkt i API:et POST/agreements. I v6 kan användare dock skapa ett avtal i läget AUTHORING (tillstånd = AUTHORING) via v6 POST/agreements och sedan använda PUT /agreements/ID/formFields för att lägga till formulärfält i dokumenten i det här avtalet.

Så här gör du:

  1. Gå till dokumentationen för REST API V6 och välj metoden POST/agreements.

  2. Använd följande begärandekod:

    { 
      "fileInfos": [ 
        { 
          "transientDocumentId": "***************************" 
        } 
      ], 
      "name": "test", 
      "participantSetsInfo": [ 
        { 
          "memberInfos": [ 
            { 
              "email": "abc@gmail.com" 
            } 
          ], 
          "order": 1, 
          "role": "SIGNER" 
        } 
      ], 
      "signatureType": "ESIGN", 
      "state": "AUTHORING" 
    }
  3. Använd metoden put /agreements/{agreementId}/formFields med följande begäran som exempel:

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

     

    Avtalet skickas till den angivna mottagaren när begäran har slutförts.

  1. Logga in på Adobe Sign.

  2. Gå till Konto > Adobe Sign API >API-information och klicka på dokumentation för metoden REST API.

    Gränssnittet i Webhook

  3. POST /transientDocuments och ladda upp en fil och skapa ett övergående dokument-ID.

  4. Kopiera det tillfälliga dokument-ID:et och använd det i metoden POST/agreements. Ange följande JSON-begäran i rutan:

    { 
        "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. Klicka på knappen Prova för att köra JSON-begäran.

    Gränssnittet i Webhook

    Rätt JSON returnerar svaret med avtals-ID:et.

    Gränssnittet i Webhook

  1. Logga in på Adobe Sign.

  2. Gå till Konto > Adobe Sign API >API-information och klicka på dokumentation för metoden REST API.

    Fnord.

  3. POST /transientDocuments och ladda upp en fil och skapa ett övergående dokument-ID.

  4. Kopiera det tillfälliga dokument-ID:et och använd det i metoden POST/agreements. Ange följande JSON-begäran i rutan:

    { 
        "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. Klicka på knappen Prova för att köra JSON-begäran.

    Fnord.

    Rätt JSON returnerar svaret med avtals-ID:et.

    Fnord.

  6. Kopiera webbadressen och klistra in den i en webbläsares adressfält för att öppna avtalet i redigeringsläge.

  7. Dra och släpp formulärfälten på den önskade platsen.

  8. Klicka på Skicka för att skicka ut avtalet för signering. 

Använd POST/agreements för att skapa ett avtal. Skickar ut det för signering och returnerar agreementID som svar till klienten. Nedan visas JSON-formatet för att skicka avtal med autentiseringsmetoden Telefon.

 

{

"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": "Granska och signera detta dokument.",

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

}

}

 

Du kan sammanfoga data direkt i formulärfälten på följande sätt:

  • Använda en biblioteksmall:

    Om du använder ett biblioteksmalls-ID under parametern FileInfo måste du ange det exakta fältnamnet och tillhörande data under avsnittet nedan:

 

"mergeFieldInfo": [

     {

       "defaultValue": "",

       "fieldName": ""

     }

   ],

 

  • Använda texttaggar i ett dokument som har överförts som ett övergående dokument:

    Om du överför ett dokument som har texttaggar tillagda som ett tillfälligt dokument måste du ange det exakta fältnamnet och tillhörande data i avsnittet nedan: 

 

"mergeFieldInfo": [

     {

       "defaultValue": "",

       "fieldName": ""

     }

   ],

 

Så skickar du ett avtal med API som har förifyllda värden för specifika formulärfält (slå samman fält)

Förutsättningen för det här anropet är att först slutföra steget ”Övergående uppladdning” och erhålla ett ”transientDocumentId” (med: secure.na1.echosign.com/public/docs/restapi/v5#!/transientDocuments/createTransientDocument) som ska användas här.

  • Det här anropet innehåller avsnittet ”mergeFieldInfo” där standardvärden för specifika formulärfält anges.
  • Detta fyller i data automatiskt från ett annat system i API-anropet.
  • Dessa fält i avtalet är antingen redigerbara eller skrivskyddade.

 

Krav:

  1. Övergående dokument-ID
  2. Fältnamn och deras värden

 

Exempelanrop:

 

Begär:

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

Värd: api.na1.echosign.com (alternativt kan du ange ditt delade namn som du hittar med anropet getBaseURis): https://secure.na1.echosign.com/public/docs/restapi/v5#!/base_uris/getBaseUris

Åtkomsttoken: 2AAABLblqZhA_D1mluNKQP7py5vXtt-1UHl9NR25e_C3LnKTUH14IblbrXODbXGRozyr7ChBkJNM*

x-user-email: sender@yourdomain.com

Innehållstyp: application/json

Cache-Control: no-cache

 

{

   "documentCreationInfo": {

       "signatureType": "ESIGN",

       "recipientSetInfos": [

           {

               "recipientSetMemberInfos": [

                   {

                       "email": “signerEmail@domain.com"

                   }

               ],

               "recipientSetRole": "SIGNER"

           }

        ],

      

       "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED",

       "message": "Signera det här från oss!",

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

            }

        ]

   }

 

}

 

Svaret på det här anropet är "agreementId" som du måste spara i systemet för efterföljande anrop (signingUrl, status, formData osv.)

 

Svar:

{

  "agreementId": "3AAABLblqZhCf_7xDcrOgKFwAabp1S-OFfvUdHf2wJsSMwlB95_x_WdUeab67jOkJi1IJzWuSJ0zdNNKugS1blZB4LT5vNVyJ"

}

 

När metoden ”post /megaSigns/{megaSignId}/views” körs visas ett fel som ”Begärd vy är inte tillgänglig för resursen i det aktuella tillståndet”.

Felet visas om det angivna namnets parametervärde är ogiltigt i följande begärandekod:

{
  "name": " "
}

Om MegaSign-avtalet till exempel redan är ”IN_PROCESS” genereras det angivna felet om du anger värdet som ”AUTHORING”. Kontrollera att det angivna värdet överensstämmer med det aktuella avtalstillståndet.

När metoden put /megaSigns/{megaSignId}/state kördes visas ett fel som ”Inget värde har angetts för MegaSign-annulleringsinformation”.

Felet orsakas av att begärandekoden saknar parametern:

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

I stället för att använda ”Minimalt schema” ska du klicka på ”Fullständigt modellschema” och ange den fullständiga begärandekoden för att köra API-anropet.

Om du vill ändra statusen för MegaSign-avtalet ska du använda /megaSigns/{megaSignId}/state och göra följande:

  1. Gå till REST API-dokumentation för V6 och välj metoden 
    put /megaSigns/{megaSignId}/state.
  2. Ange auktoriseringsvärdet och även If-Match och megasignID.
    • Om du vill hämta megasignID ska du använda get /megaSigns
    • Om du vill hämta If-Match ska du använd get /megaSigns/{megaSignId} och letar upp ”Etag” under rubriken
  3. {
      "state": "CANCELED",
      "megaSignCancellationInfo": {
       "comment": "cancel",
       "notifyOthers": false
      }

För att kunna registrera en webhook svarar dess URL på denna verifieringsbegäran med en 2XX-svarskod och kan dessutom skicka tillbaka samma klient-ID-värde på något av följande två sätt:

  1. I ett svarsrubrik X-AdobeSign-ClientId. Det är samma rubrik, som skickas i begäran, och som sedan skickas tillbaka i svaret.
  2. I JSON-svarstexten med nyckeln X-AdobeSign-ClientId och dess värde är det samma klient-ID som skickas i begäran.

Adobe Sign tar emot 2xx-svaret med X-AdobeSign-ClientId. Användaren kan kontrollera om den är korrekt konfigurerad i en webbhook eller inte.

Webbhook-URL:en svarar inte enligt det förväntade beteendet. För varje Post-meddelande som Adobe Sign skickar svarar URL:en med 2XX-statuskod och returnerar det klient-ID, som har skickats i begäranderubrikerna (X-AdobeSign-ClientId), tillbaka i svarsrubrikerna. 

Fullständig information finns på följande länk:
https://www.adobe.io/apis/documentcloud/sign/docs.html#!adobedocs/adobe-sign/master/webhooks/webhook_events.md

När URL:en inte följer det här protokollet anser Adobe Sign att den inte har bekräftat begäran och försöker schemalägga igen enligt den tillförlitliga principen.

Om en webhook inte svarar och antingen den maximala återförsökstiden eller det maximala återförsöksintervallet överskrids, inaktiveras den.

Det här arbetet är licensierat enligt en Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Inlägg från Twitter™ och Facebook omfattas inte av villkoren i Creative Co


Hantera/hämta information om avtal

Om du vill ändra det dokument som redan skickats ut för signatur ska du använda metoden PUT /agreements/{agreementId} som du kan använda för att uppdatera ett befintligt avtal. Ange det övergående ID:et tillsammans med avtals-ID:et i följande begärandekod:

 

{

  "documentUpdateInfo": {

    "fileInfos": [

      {

        "agreementDocumentId": "",

        "transientDocumentId": ""

      }

    ]

  }

}

 

Nedan följer instruktionerna för att uppdatera status från ”AUTHORING” till ”IN_PROCESS” med Put /agreements/{agreementId}/state:

  1. Hämta avtals-ID:et som laddades ned med metoden POST/Agreement.

  2. Använd Get /agreements/{agreementId} för att hämta den senaste ETag.

  3. Gå till Put /agreements/{agreementId}/state och ange följande information: "state": "IN_PROCESS"

Nej.

Det finns ingen metod i det aktuella REST API:et för att ladda upp en signerad kopia.

Avsändaren måste överföra den signerade kopian från sidan Hantera.

DELETE /agreements/ID som används för att tillåta att ett avtal döljs på hanteringssidan.

Adobe har ett nytt API, PUT/agreements/ID/me/visibility, som styr synligheten hos ett avtal (i GET /agreements). Förutom de funktioner som tillhandahålls av DELETE /agreements/ID kan den nya slutpunkten för synlighet även tillåta en användare att återställa åtgärden ”dölja”, d.v.s. göra avtalet synligt igen. 

Du kan också följa de detaljerade stegen nedan:

  1. Gå till metoden get /agreements och hämta avtals-ID:et.
  2. Klicka på put /agreements/{agreementId}/me/visibility och ange följande begäran som exempel:
    {
      "visibility": "HIDE"
    }
    Avtals-ID:et är endast dolt från get /libraryDocuments, men det är fortfarande synligt under gränssnittet på fliken Hantera.
Obs!

Funktionen API-kvarhållning är inte aktiverad som standard.

Kontakta din Success Manager och begär att API-kvarhållning ska aktiveras för kontot för att aktivera åtgärden DELETE/agreements.

Mer information om hur du aktiverar kvarhållningsfunktionerna för ditt konto finns i Adobe Sign – dokumentkvarhållning.

  1. Logga in som administratör i Adobe Sign och gå till: https://secure.adobesign.com/public/docs/restapi/v6

    • Klicka på avtal och expandera metoden GET /agreements
    • Klicka på knappen OAUTH ACCESS-TOKEN 
    • Aktivera omfånget agreement_read:self.
    • Klicka på knappen Auktorisera
      • Klicka på Tillåt åtkomst om du så uppmanas
    • Klicka på Prova!knapp
    Hämta avtalsmetod

  2. Svaret genereras.

    Du kan hitta agreementId i svarstexten:

    Hämta avtalssvar

  3. DELETE /agreements/{agreementId}/documents: tar bort alla dokument som hör till ett avtal. Själva avtalet visas fortfarande på sidan Hantera.

    • Välj åtgärden DELETE/agreements som ska köras.
    • Klicka på knappen OAUTH ACCESS-TOKEN och skapa en åtkomsttoken med omfång för agreement_retention.
    • Ange agreementId för avtal som du vill ta bort.
    • När avtalet har tagits bort har svarstexten ”inget innehåll”.

Du får följande svar om åtgärden DELETE/agreements inte är aktiverad:

 "code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED",

  "message": "Åtgärden kräver att vissa kontoinställningar är aktiverade. Kontakta Adobe Sign-teamet för att aktivera inställningarna."

Så hämtar du signerade dokument tillsammans med en revideringsrapport och stöddokument via REST API i Adobe Sign med följande metod i stället för att göra ett separat anrop för att hämta revideringsrapporten.

GET /agreements/{agreementId}/auditTrail

  1. Klicka på GET /agreements/{agreementId}/combinedDocument.

  2. Klicka på knappen för oAuth-åtkomsttoken.

  3. Åtkomsttoken genereras automatiskt när auktoriseringen har godkänts.

  4. Ange ett agreementId.

  5. Välj sant i listrutan under attachSupportingDocuments.

  6. Välj sant i listrutan under attachAuditReport.

  7. Klicka på Prova! knapp.

    Hämta kombinerade dokument

    Det hämtar den kombinerade PDF-filen från signatören med stöddokument och revideringsrapport.

Om du vill hämta gruppdokument är endast verktyget för dokumentexport tillgängligt och med ett API kan du bara hämta dokument ett i taget. Här följer API-metoden för samma sak:

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


Biblioteksmallar och webbformulär

  1. Logga in på Adobe Sign som administratör och gå till: https://secure.na1.adobesign.com/public/docs/restapi/v6

    • Klicka på libraryDocuments och expandera metoden GET /libraryDocuments
    • Klicka på knappen OAUTH ACCESS-TOKEN 
    • Aktivera omfånget library_read:self.
    • Klicka på knappen Auktorisera
      • Klicka på Tillåt åtkomst om du så uppmanas
    • Klicka på Prova!knapp
    Metoden Hämta biblioteksdokument

  2. Svaret genereras.

    Du kan hitta libraryDocumentId i svarstexten:

    Svar på hämta biblioteksdokument

Adobe har ett nytt API PUT/libraryDocuments/ID/me/visibility som styr synligheten för ett avtal (i GET /agreements). Förutom de funktioner som tillhandahålls av DELETE /agreements/ID kan den nya slutpunkten för synlighet även tillåta en användare att återställa åtgärden ”dölja”, d.v.s. göra avtalet synligt igen.

Följ de detaljerade stegen nedan:

  1. Gå till metoden get /libraryDocuments och hämta avtals-ID:et.
  2. Klicka på put /libraryDocuments/{libraryDocumentId}/me/visibility och ange följande begäran som exempel:
    {
      "visibility": "HIDE"
    }
    Biblioteks-ID:et är endast dolt från get /libraryDocuments, men det är fortfarande synligt under gränssnittet på fliken Hantera.
Obs!
  • Skicka en begäran till supportteamet för att aktivera omfattningen för borttagning av bibliotek.
  • API:et tar bort biblioteksdokumentet. Avtal som skapas med det här biblioteksdokumentet påverkas dock inte.


Generera ett libraryDocumentID

  1. Gå till https://secure.echosign.com/public/docs/restapi/v5.

  2. Klicka på libraryDocuments.

  3. Klicka på knappen för oAuth-åtkomsttoken

    Auktorisera åtkomst – token för dig själv, grupp eller konto.

  4. Välj libraryTemplateType – dokument eller Form_field_layer.

  5. Klicka på Prova.

    Du kan få följande svar för alla dina mallar: (Kopiera libraryDocumentId för den biblioteksmall du vill ta bort).

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


Ta bort biblioteksmallar

  1. Kopiera libraryDocumentID från svarstexten.

  2. Gå till Ta bort biblioteksdokument.

  3. Klicka på knappen för oAuth-åtkomsttoken. Auktorisera åtkomst – token för dig själv, grupp eller konto.

  4. Klistra in libraryDocumentId i fältet Värde.

  5. Klicka på Prova. 
    Mallen tas bort.

    Du får följande svarskod: 204

Obs!

Endast webbformulär i ett utkasttillstånd kan uppdateras.

  1. Skapa widgeten med hjälp av post /widgets.

  2. Hämta widget-ID:et från get/widgets.

  3. När du har skapat taggen med GET /widgets/{widgetId} ska du hämta taggen från svarsrubriken.

    Foo

  4. Använd Etag från GET /widgets/{widgetId} under put /widgets/{widgetId}. Ange widgetId och widgetInfo under If-Match-parametern.

    Foo

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


Exempel på användningsfall

  1. Utför ett get/agreements-anrop med rätt x-api-användare.

  2. I Svarstexten ska du leta reda på koden för det signaturavtal som du vill hitta signerings-URL:en för och noterar avtals-ID:et

  3. Gör ett get/agreements/{agreementId}/signingUrls-anrop med det avtals-ID som du fick från get/agreements-anropet.

     

    Resultat

    Utdata returnerar e-postadressen för signeraren/signerarna och e-signatur-URL:en.

    Hämta avtalsmetod

 Adobe

Få hjälp snabbare och enklare

Ny användare?