Användarhandbok Avbryt

Översikt över webhookar

 

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ä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
    5. Skapa funktionsfokuserade användare
      1. Tekniska konton - API-drivna
      2. Tjänstkonton - manuellt drivna
    6. Sök efter användare med etableringsfel
    7. Ändra namn/e-postadress
    8. Redigera en användares gruppmedlemskap
    9. Redigera en användares gruppmedlemskap via gruppgränssnittet
    10. Uppgradera en användare till en administratörsroll
    11. Användaridentitetstyper och SSO
    12. Byt användaridentitet
    13. Autentisera användare med MS Azure
    14. Autentisera användare med Google-federation
    15. Produktprofiler
    16. Inloggningsupplevelse
  3. Konto-/gruppinställningar
    1. Inställningsöversikt
    2. Globala inställningar
      1. Kontonivå och ID
      2. Arbetsflöden för självsignering
      3. Massutskick
      4. Webbformulär
      5. Anpassat arbetsflöde för utskick
      6. Power Automate-arbetsflöden
      7. Biblioteksdokument
      8. Samla formulärdata med avtal
      9. Begränsad dokumentsynlighet
      10. Bifoga en PDF-kopia av det signerade avtalet
      11. Inkludera en länk i e-postmeddelandet
      12. Inkludera en bild i e-postmeddelandet
      13. Filer som bifogas i e-post namnges som
      14. Bifoga granskningsrapporter till dokument
      15. Sammanfoga flera dokument till ett
      16. Ladda upp ett signerat dokument
      17. Delegering för användare i mitt konto
      18. Tillåt att externa mottagare delegerar
      19. Behörighet att signera
      20. Behörighet att skicka
      21. Behörighet att lägga till elektroniska stämplar
      22. Ange standardtidszon
      23. Ange standarddatumformat
      24. Användare i flera grupper (UMG)
        1. Uppgradera för att använda UMG
      25. Behörigheter för gruppadministratörer
      26. Ersätt mottagare
      27. 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
      28. I produktmeddelanden och -vägledning
      29. Åtkomliga PDF-filer
      30. Ny författarupplevelse
      31. 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. Avböj att signera
      8. Tillåt stämpelarbetsflöden
      9. Kräv att signerare tillhandahåller sin titel eller sitt företag
      10. Tillåt att signerare skriver ut och gör en skriftlig signatur
      11. Visa meddelanden vid e-signering
      12. Kräv att signerare gör signaturer och initialer med en mobil enhet
      13. Begär IP-adress av undertecknare
      14. 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. Mottagargrupper
      6. Obligatoriska fält
      7. Bifoga dokument
      8. Förenkla fält
      9. Ändra avtal
      10. Avtalsnamn
      11. Språk
      12. Privata meddelanden
      13. Tillåtna signaturtyper
      14. Påminnelser
      15. Lösenordsskydd för signerade dokument
      16. 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
      17. Innehållsskydd
      18. Aktivera Notarize-transaktioner
      19. Förfallotid för dokument
      20. Förhandsgranska, placera signaturer och lägg till fält
      21. Signeringsordning
      22. Liquid Mode
      23. Anpassade arbetsflödeskontroller
      24. Uppladdningsalternativ för e-signeringssidan
      25. 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. Massutskick – manuella mottagare
      3. Massutskick – CSV-uppladdning
      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. 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. Redigera en dataexport
      3. Uppdatera innehållet för dataexport
      4. 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. Spåra Power Automate-användningen
    4. Skapa ett nytt flöde (Exempel)
    5. Utlösare som används för flöden
    6. Importera flöden från utanför Acrobat Sign
    7. Hantera flöden
    8. Redigera flöden
    9. Dela flöden
    10. Inaktivera eller aktivera flöden
    11. Ta bort flöden
    12. 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 

Översikt

En webhook är en användardefinierad HTTPS-begäran som utlöses när en prenumerationshändelse inträffar på källplatsen, (i detta fall Adobe Acrobat Sign).

En webhook är alltså en REST-tjänst som accepterar data eller en dataström.

Webhookar är avsedda för tjänst till tjänst -kommunikation i en PUSH-modell.

När en utlösande händelse inträffar, skapar Acrobat Sign en HTTPS-POST med JSON-text och skickar den till angiven URL.

Innan du konfigurerar webhookar, se till att ditt nätverk accepterar de IP-intervall som krävs för funktionalitet.

 

Webhookar erbjuder flera fördelar jämfört med den tidigare återanropsmetoden, varav några är:

  • Administratörer kan aktivera sina egna webbhookar utan att behöva involvera Acrobat Signs support för att lista återanrops-URL
  • Webhookar är bättre när det gäller ”uppdaterade” data, effektivitet i kommunikation, och säkerhet. Ingen avsökning krävs
  • Webhooks tillåter enkelt olika nivåer av omfattning (konto/grupp/användare/resurs). 
  • Webhookar är en modernare API-lösning, som gör det enklare att konfigurera moderna program
  • Flera webbhookar kan konfigureras per omfattning (konto/grupp/användare/resurs) där återanrop måste vara unika
  • Webhookar gör det möjligt att välja data som ska returneras, där återanrop är en ”allt eller inget”-lösning
  • Metadata som medföljer en webhook kan konfigureras (grundläggande eller detaljerad)
  • Webhooks är mycket enklare att skapa, redigera eller inaktivera efter behov eftersom användargränssnittet är helt inom administratörens kontroll.
Obs!

Det här dokumentet är främst inriktat på webbhooks-gränssnittet i webbprogrammet Acrobat Sign (tidigare Adobe Sign).

Utvecklare som söker efter API-information hittar mer information här:

Förutsättningar

Du måste tillåta IP-intervallen för webhookar via din nätverkssäkerhet för att tjänsten ska fungera. 

Den äldre tjänsten för återanrops-URL i REST v5 använder samma IP-intervall som webhook-tjänsten.

Administratörer kan logga in på Adobe Admin Console för att lägga till användare. När du har loggat in går du till administratörsmenyn och bläddrar ner till Webhookar.

Så fungerar det

Administratörer måste först ha en webhook-tjänst som är redo att acceptera den inkommande push-tjänsten från Acrobat Sign. Det finns många alternativ i detta avseende, och så länge tjänsten kan acceptera POST- och GET-förfrågningar kommer denna webhook att lyckas.

När tjänsten är på plats, kan en Acrobat Sign-administratör skapa en ny webhook från Webhook-gränssnittet på kontomenyn på Acrobat Sign-webbplatsen.

Administratörer kan konfigurera webhooken för att utlösa händelser för avtal, webbformulär (Widget) och massutskick (MegaSign). Resursen Biblioteksmall (Biblioteksdokument) kan också konfigureras via API:et.

Omfattningen för en webhook kan inkludera hela kontot eller enskilda grupper via administratörsgränssnittet. API:et ger större justeringsmöjligheter genom val av användar- eller resursomfång.

Den typ av data som skickas till URL:en kan konfigureras och inkludera saker som avtalsinformation, deltagarinformation, dokumentinformation och så vidare.

När en webhook har konfigurerats och sparats, skickar Acrobat Sign ett nytt JSON-objekt till angiven URL varje gång prenumerationshändelsen utlöses. Ingen pågående manipulering av en webhook krävs om du inte vill ändra villkor för händelseutlösare eller JSON-nyttolasten.

Verifiering av avsikten med webhook-URL

Innan du registrerar en webhook kontrollerar Acrobat Sign om den webhook-URL som anges i registreringsbegäran har för avsikt att ta emot meddelanden eller inte. När Acrobat Sign får en ny begäran om registrering av en webhook gör den därför först en verifieringsbegäran till webhookens URL. Denna verifieringsbegäran är en HTTPS GET-begäran som skickas till webhook-URL:en. Denna begäran har ett anpassat HTTP-huvud X-AdobeSign-ClientId. Värdet i den här rubriken är inställt på klient-ID (program-ID) för det API-program som begär att en webhook ska skapas/registreras. För att kunna registrera en webhook, måste webhook-URL:en svara på denna verifieringsbegäran med en 2XX-svarskod och MÅSTE dessutom skicka tillbaka samma klient-ID-värde på något av följande två sätt:

  • Antingen i en svarsrubrik med X-AdobeSign-ClientId. Det är samma rubrik som skickas i begäran och som sedan skickas tillbaka i svaret.
  • Eller i JSON-svarstexten med nyckeln xAdobeSignClientId där värdet är samma klient-ID som skickades i begäran.

En webhook registreras endast vid framgångsrikt svar (2XX-svarskod) och valideringen av klient-ID i rubriken eller svarstexten. Syftet med denna verifieringsbegäran är att visa att webhook-URL:en verkligen vill ta emot meddelanden till avsedd URL. Om du av misstag har angett fel URL, kommer denna URL inte att svara korrekt på bekräftelsen av avsiktsbegäran och Acrobat Sign kommer inte att skicka några meddelanden till denna URL. Dessutom kan en webhook-URL även validera att den endast tar emot meddelanden via de webhookar som registreras av ett specifikt program. Detta kan göras genom att validera klient-ID för programmet som skickas i rubriken med X-AdobeSign-ClientId. Om en webhook-URL inte känner igen ett klient-ID, får den INTE svara med framgångsrik svarskod, och Acrobat Sign kommer att se till att denna URL inte registreras som en webhook.

Verifieringen av anrop till webhook-URL:en görs i följande situationer:

  • Registrera webhook: om denna verifiering av ett anrop till en webhook-URL misslyckas, kommer denna webhook inte att skapas.
  • Uppdatera webhook: INAKTIV till AKTIV: om denna verifiering av ett anrop till en webhook-URL misslyckas ändras inte tillståndet för denna webhook till AKTIV.

Så besvaras ett webhook-meddelande

Acrobat Sign utför en implicit avsiktsverifiering i varje begäran om webhook-meddelande som skickas till denna webhook-URL. Således innehåller varje HTTPS-begäran för webhook-avisering även det anpassade HTTP-huvudet som kallas X-AdobeSign-ClientId. Värdet på huvudet är klient-ID (program-ID) för programmet som skapade denna webhook. Vi kommer att betrakta webhook-meddelandet som framgångsrikt levererad om, och endast om, ett svar (2XX-svarskod) returneras och klient-ID skickas i HTTP-rubriken (X-AdobeSign-ClientId) eller via en JSON-svarstext med nyckeln xAdobeSignClientId och värdet som samma klient-ID. I annat fall försöker vi leverera meddelandet på nytt till webhook-URL:en tills alla nya försök har slutförts.

Som nämnts ovan, rubriken 'X-AdobeSign-ClientId' som ingår i varje aviseringsbegäran från Sign ska värdet på detta huvud (klient-ID) upprepas på något av följande två sätt:

1. HTTP-huvudet med X-AdobeSign-ClientId och värde som detta klient-id

Ta ett exempel på JavaScript-kod för att hämta klient-ID, validera det och returnera det sedan i svarshuvudet

// Hämta klient-ID

var clientid = request.headers['X-ADOBESIGN-CLIENTID'];

 

//Validera det

if (clientid ==="BGBQIIE7H253K6") //Ersätt 'BGBQIIE7H253K6' med klient-ID för programmet som denna webhook skapas med

{

    //Returnera det i svarsrubriken

    response.headers['X-AdobeSign-ClientId'] = clientid;

    response.status = 200; // standardvärde

}

Ta ett exempel på PHP-kod för att hämta klient-ID, validera det och returnera det sedan i svarshuvudet

<?php

// Hämta klient-ID

$clientid = $_SERVER['HTTP_X_ADOBESIGN_CLIENTID'];

//Validera det

if($clientid == "BGBQIIE7H253K6") //Ersätt 'BGBQIIE7H253K6' med klient-ID för programmet som denna webhook skapas med

{

    //Returnera det i svarsrubriken

   header("X-AdobeSign-ClientId:$clientid");

   header("HTTP/1.1 200 OK"); // standardvärde

}

?>


2. JSON-svarstext med nyckel som xAdobeSignClientId och värde som samma klient-id

Ta ett exempel på JavaScript-kod för att hämta klient-ID, validera det och returnera det i svarstexten

// Hämta klient-ID

var clientid = request.headers['X-ADOBESIGN-CLIENTID'];

 

 

//Validera det

if (clientid ==="BGBQIIE7H253K6") //Ersätt 'BGBQIIE7H253K6' med klient-ID för programmet som denna webhook skapas med

{

    var responseBody = {

                         "xAdobeSignClientId" : clientid // Returnera klient-ID i brödtexten

                       };

    response.headers['Content-Type'] = 'application/json';

    response.body = responseBody;

    response.status = 200;

}

Ta ett exempel på PHP-kod för att hämta klient-ID, validera det och returnera det i svarstexten

<?php

// Hämta klient-ID

$clientid = $_SERVER['HTTP_X_ADOBESIGN_CLIENTID'];

//Validera det

if($clientid == "BGBQIIE7H253K6") //Ersätt 'BGBQIIE7H253K6' med klient-ID för programmet som denna webhook skapas med

{

   //Returnera det i svarstexten

   header("Content-Type: application/json");

   $body = array('xAdobeSignClientId' => $clientid);

   echo json_encode($body);

   header("HTTP/1.1 200 OK"); // standardvärde

}

?>

Exempel på JSON-brödtext för svaret

{

    "xAdobeSignClientId": "BGBQIIE7H253K6"

}

Förutsättningar

Du behöver:

  1. Ett Microsoft-konto med licens för att skapa Azure Functions-program
  2. Ett befintligt Azure-funktionsprogram kan du skapa med https://docs.microsoft.com/sv-se/azure/azure-functions/functions-create-first-azure-function 
  3. Grundläggande kunskaper i Javascript, så att du kan förstå och skriva koden på valfritt språk

Steg för att skapa en utlösare för Azure-funktioner som fungerar som en Acrobat Sign-webhook

Så här skapar du en HTTP-utlösarfunktion för JavaScript:

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

2. Öppna Azure Function-programmet som visas under fliken Function Apps.

Gå till Funktionsappar i Azure

Detta öppnar listan över Azure Function-program:

3. Välj programmet där du vill skapa den nya funktionen

4. Klicka på knappen Skapa (+) för att skapa en ny Azure-funktion

Skapa en Azure-funktion

 

5. Välj Webhook + API som scenario och JavaScript som språk

6. Klicka på Skapa denna funktion

En ny funktion som kan hantera en inkommande API-begäran skapas.

Lägg till logik för att registrera en Acrobat Sign-webhook

Innan du registrerar en webhook kontrollerar Acrobat Sign att den webhook-URL som anges i registreringsbegäran verkligen har för avsikt att ta emot meddelanden eller inte. När en ny begäran om registrering av en webhook tas emot av Acrobat Sign gör den därför först en verifieringsbegäran till webhook-URL:en. Denna verifieringsbegäran är en HTTPS GET-begäran som skickas till webhook-URL med ett anpassat HTTP-huvud X-AdobeSign-ClientId. Värdet i detta huvud är inställt på klient-ID för programmet som begär att skapa/registrera denna webhook. För att kunna registrera en webhook svarar dess URL på denna verifieringsbegäran med en 2XX-svarskod OCH måste dessutom skicka tillbaka samma klient-ID-värde på något av följande två sätt.

Det finns två alternativ som du kan använda:


Alternativ 1: Skicka klient-ID i X-AdobeSign-ClientId som svarshuvud

Skicka X-AdobeSign-ClientId i svarshuvudet. Det är samma huvud som skickas i begäran och som sedan skickas tillbaka i svaret.

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

Ersätt filen index.js

module.exports = function (context, req) {

    var clientId = req.headers['x-adobesign-clientid'];

    // Verifiera att inkommande ClientID är äkta

    if (clientId === '123XXX456') {

        context.res = {

            // status: 200, /* Standardvärdet är 200 */ // Alla 2XX-svar accepteras

            body: "Avisering accepterad",

            headers : {

                'x-adobesign-clientid' : req.headers['x-adobesign-clientid']

            }

        };

    }

    else {

        context.res = {

           status: 400,

            body: "Opps!! Illegitimate Call identified"

        };

    }

    context.done();

};

 

Testa beteendet genom att testa förfrågan:

1. Klicka på knappen Test längst ned till höger

2. Testa prov-förfrågan

Testa funktionen

Även om svarshuvuden inte visas ovan, kan du observera det genom testa det med postman/DHC eller någon annan tjänst.


Alternativ 2: Skicka klient-ID i svarstexten med nyckeln xAdobeSignClientId

I JSON-svarstexten med nyckeln xAdobeSignClientId och dess värde är det samma klient-ID som skickas i begäran.

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

Uppdatera innehållet i index.js-filen

module.exports = function (context, req) {

    var clientId = req.headers['x-adobesign-clientid'];

    // Verifiera att inkommande ClientID är äkta

    if (clientId === '123XXX456') {

        context.res = {

            // status: 200, /* Standardvärdet är 200 */ // Alla 2XX-svar accepteras

            body: {

                'xAdobeSignClientId' : clientId

            },

            headers : {

               'Content-Type' : 'application/json'

            }

        };

    }

    else {

        context.res = {

           status: 400,

            body: "Opps!! Illegitimate Call identified"

        };

    }

    context.done();

};

 

Testa beteendet genom att testa förfrågan

1. Klicka på knappen Test längst till höger

2. Testa prov-förfrågan

Testa funktionen

Observera också att samma beteende för clientID förväntas när webhook-URL tar emot POST-aviseringar. 


Klar att använda

När du har verifierat beteendet, fungerar denna webhook-URL enligt Acrobat Sign-standarder. Du kan uppdatera den anpassade logiken efter dina behov.

 

Hämta funktions-URL

  • Klicka på Hämta funktions-URL
Hämta funktions-URL

 

Kopiera URL:en och använd den för att skapa webbhooks i Acrobat Sign.

Kopiera funktions-URL

Skapa AWS Lambda-funktion

Om du vill skapa en AWS Lambda-funktion, logga in på AWS Management Console och välj tjänsten AWS Lambda i listan med tjänster.

  • Klicka på Skapa en Lambda-funktion med hjälp av alternativet “Skapa från grunden”
  • På sidan Konfigurera funktion, ange funktionsnamn “lambdaWebhooks” och välj Node.js 4.3 som körning
  • För Roll välj en befintlig roll eller skapa en ny roll från mallar
    • Om du har valt  Skapa ny roll från mallar, ange ett rollnamn (t.ex. roll-lamda) och välj Enkla Microservices-behörigheter från listan över Policymallar 
  • Klicka på knappen Skapa funktion
Skapa en funktion i AWS

  • På den nya sidan AWS lamda-funktion välj “Redigera kod inline” som “Typ av kodinmatning”, behåll index.handler som Handler.
  • Lägg till logik för att registrera Acrobat Sign Webhook

    Innan du registrerar en webhook kontrollerar Acrobat Sign att den webhook-URL som anges i registreringsbegäran verkligen har för avsikt att ta emot meddelanden eller inte. När en ny begäran om registrering av en webhook tas emot av Acrobat Sign gör den därför först en verifieringsbegäran till webhook-URL:en. Denna verifieringsbegäran är en HTTPS GET-begäran som skickas till webhook-URL med ett anpassat HTTP-huvud X-AdobeSign-ClientId. Värdet i detta huvud är inställt på klient-ID för programmet som begär att skapa/registrera denna webhook. 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. Observera även att samma beteende för clientID förväntas när en webhook-URL tar emot POST-aviseringar. 

    Gör något av följande:

    Fall 1: Skicka klient-ID i X-AdobeSign-ClientId som svarshuvud

    •  Skicka X-AdobeSign-ClientId i svarshuvudet. Det är samma huvud som skickas i begäran och som sedan skickas tillbaka i svaret.

      Kodfragment
      Ersätt det automatiskt genererade kodfragmentet med följande kod i filen index.js:

Exempelnodens JS-kod för att hämta klient-ID, validera den och returnera den sedan i svarshuvudet

exports.handler = function index(event, context, callback) {

  // Hämta klient-ID

  var clientid = event.headers['X-AdobeSign-ClientId'];

 

  //Validera det

  if (clientid =="BGBQIIE7H253K6") //ersätt 'BGBQIIE7H253K6' med klient-ID för programmet som denna webhook skapas med

  {

    var response = {

        statusCode: 200,

        headers: {

            "X-AdobeSign-ClientId": clientid

        }

     };

   callback(null,response);

  }

  else {

   callback("Oops!! illegitimate call");

  }

}

 

Fall 2: Skicka klient-ID i svarstexten med nyckel xAdobeSignClientId

I JSON-svarstexten med nyckel för xAdobeSignClientId och dess värde är samma klient-ID som skickas i begäran.

 

Kodfragment

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

Exempelnodens JS-kod för att hämta klient-ID, validera den och returnera den sedan i svarshuvudet

exports.handler = function index(event, context, callback) {

 // Hämta klient-ID

 var clientid = event.headers['X-AdobeSign-ClientId'];

  

 //Validera det

 if (clientid =="BGBQIIE7H253K6") //Ersätt 'BGBQIIE7H253K6' med klient-ID för programmet som denna webhook skapas med

 {

   var responseBody = {

        xAdobeSignClientId : clientid

   };

     

    var response = {

        statusCode: 200,

        body: JSON.stringify(responseBody)

    };

 

   callback(null,response);

 }

 else {

   callback("Opps!! illegitimate call");

  }

}

Uppdatera innehållet i index.js-filen

  • Spara funktionen. Lambda-funktionen skapas och vi är nästan redo att använda den i en webhook i realtid.

 

Konfigurera AWS API Gateway

För att göra denna Lambda offentligt tillgänglig via en HTTP-metod måste vi konfigurera AWS API Gateway med hjälp av vår funktion (skapad ovan) som serverdel för detta API.

I AWS Management Console väljer du API Gateway från AWS-tjänsten och klicka på knappen Skapa API

Konfigurera API-gatewayen

  • På sidan Skapa nytt API, välj Nytt API och ange webhooks som API-namn.
  • Klicka på knappen Skapa API
  • Välj Åtgärder i listrutan och välj alternativet Skapa resurs
  • Kontrollera alternativet Konfigurera som proxyresurs och ange validera som Resursnamn och {proxy+} i Resurssökväg
  • Lämna alternativet Aktivera API Gateway-CORS avmarkerat och klicka på knappen Skapa resurs
  • Behåll Lambda Funktionsproxy markerad som Integrationstyp och välj det område där du har skapat lambdafunktionen i listrutan Lambdaregionen (förmodligen är det samma region där du skapar API Gateway).
  • Ange validera som Lambda-funktion och klicka på knappen Spara
  • I dialogrutan Lägg till behörighet till Lambda-funktion, välj OK

Om alla steg ovan utförs korrekt ser du ungefär det här:

Konfigurerad metod

Distribuera API

Nästa steg är att distribuera detta API så att det blir klart att användas.

  • I listrutan Åtgärder, välj Distribuera API
  • Välj [New Stage] i Distributionssteg och ange prod (eller något annat som du vill identifiera detta steg med) i Stegnamn
  • Klicka på knappen Distribuera

API är nu klart att användas och du hittar anrops-URL i den blå rutan som visas nedan:

Distribuera API

Notera denna URL eftersom den måste anges som webhook-URL i realtid.

Klar att använda

Det är gjort. Använd ovanstående URL ovan med “/{nodeJSfunctionName}” som läggs till som webhook-url i POST /webhooks API-begäran.  När du har verifierat beteendet fungerar denna webhook-URL enligt
Acrobat Sign-standarder. Du kan uppdatera/lägga till anpassad logik efter dina behov.

Så här aktiverar och inaktiverar du

åtkomst till funktionen Webhooks är aktiverad som standard för konton med företagsplaner

administratörer på gruppnivå kan endast skapa/styra webhookar som fungerar inom gruppen.

Åtkomst till sidan Webhookar finns i den vänstra listen i Admininistrationsmenyn.

Gå till fliken Webhookar

Bästa praxis

  • Prenumerera på specifika händelser som behövs för att begränsa antalet HTTPS-begäranden till servern – ju mer specifika du kan göra dina webhookar, desto mindre volym behöver du gå igenom.
  • Vara dublettresistent – om du har fler än ett program som delar samma webhook-URL och samma användare mappas till varje program, skickas samma händelse till din webhook flera gånger (en gång per program). I vissa fall kan din webhook ta emot dubbletthändelser. Webhook-applikationen bör vara tolerant mot detta och dedupera med händelse-ID.
  • Besvara alltid webhookar snabbt – appen har bara tio sekunder på sig att besvara webhook-förfrågningar. För verifieringsbegäran är detta sällan ett problem eftersom din app inte behöver göra något egentligt arbete för att svara. För aviseringsförfrågningar kommer dock appen vanligtvis att göra något som tar tid vid svar på begäran. Vi rekommenderar att du arbetar på en separat tråd eller asynkront med en kö så att du säkert kan svara inom fem sekunder
  • Hantera samtidighet – när en användare gör ett antal ändringar i snabb följd får din app troligen flera meddelanden för samma användare vid ungefär samma tidpunkt. Om du inte är försiktig med hur du hanterar samtidig användning kan det sluta med att programmet bearbetar samma ändringar för samma användare flera gånger. För att dra nytta av Acrobat Sign webhooks måste du ha en tydlig förståelse för användningen av informationen. Var noga med att ställa frågor som: 
    • Vilka data vill du returnera i nyttolasten? 
    • Vem kommer att få tillgång till denna information? 
    • Vilka beslut eller rapporter kommer att genereras?
  • Rekommendationer för att ta emot signerade dokument – det finns flera faktorer att ta hänsyn till när du avgör hur du tar emot en signerad PDF-fil från Acrobat Sign i dokumenthanteringssystemet. 

Även om det är helt acceptabelt att bara välja alternativet Signerat avtalsdokument när du skapar en webhook, kan du använda API för Acrobat Sign för att hämta dokumenten när en utlösande händelse (till exempel avtalsstatus slutförd) tas emot.

Saker att tänka på ...

JSON storleksbegränsning

JSON nyttolast är begränsad till 10 MB.

Om en händelse genererar en större nyttolast utlöses en webhook men attribut för villkorlig parameter, om sådana finns i begäran, tas bort för att minska nyttolastens storlek. 

“ConditionalParametersTrimmed” returneras i svaret när detta inträffar för att informera klienten om att  conditionalParameters -informationen har tagits bort.

conditionalParametersTrimmed” är ett matris-objekt som innehåller information om de nycklar som har trimmats.

Trunkeringen sker i följande ordning:

  • includeSignedDocuments
  • includeParticipantsInfo
  • includeDocumentsInfo
  • includeDetailedInfo

Signerade dokument trunkeras först, följt av deltagarinformation, dokumentinformation och slutligen detaljerad information.

Detta kan till exempel inträffa vid en händelse för avtalsslutförande om den inkluderar ett signerat dokument (base 64-kodad) eller för ett avtal med flera formulärfält

Webhook-meddelanden

Via Acrobat Sign-webhookar skickas meddelanden till avtalets avsändare och eventuella webhookar som konfigurerats inom grupp som avtalet skickats från. Webbhooks med kontoomfattning mottar samtliga händelser.

Avsändare: användare A | Signerare: användare B | Part som delas med: användare C

Användare A och B finns på olika konton

Användare A och C finns på olika konton

Användningsfall

Avisering?

Kommentarer/anteckningar

Kontot för användare A har webhook på nivå KONTO (skapad av användare A eller kontoadministratör).

Ja

Med webhook på nivå KONTO meddelas alla händelser som aktiveras för det kontot.

Kontot för användare A har webhook på nivå GRUPP (skapad av användare A eller konto-/gruppadministratör).

Antagande: Användare A och gruppadministratör finns i samma grupp.

Ja

Med webhook på nivå GRUPP meddela alla händelser som aktiveras för den här gruppen.

Användare A har webhook på nivå ANVÄNDARE.

Ja

Webhook på nivå ANVÄNDARE för användare A har aktiverats då de är avsändare.

Användare A har webhook på nivå RESURS (för avtalet ovan som skickats).

Ja

 
     

Kontot för användare B har webhook på nivå KONTO (skapad av användare B eller kontoadministratör).

Nej

Webhook på nivå KONTO för användare B klassas som webhook för signerare.

Kontot för användare B har webhook på nivå GRUPP (skapad av användare B eller kontoadministratör).

Antagande: Användare B och gruppadministratör finns i samma grupp.

Nej

Webhook på nivå GRUPP för användare B klassas som webhook för signerare.

Användare B har webhook på nivå ANVÄNDARE.

Nej

Webhook på nivå ANVÄNDARE för användare B klassas som webhook för signerare.

     

Kontot för användare C har webhook på nivå KONTO (skapad av användare C eller kontoadministratör).

Nej

Webhook på nivå KONTO för användare C klassas som webhook för icke-upphovsman.

Kontot för användare C har webhook på nivå GRUPP (skapad av användare C eller kontoadministratör).

Antagande: Användare C och gruppadministratör finns i samma grupp.

Nej

Webhook på nivå GRUPP för användare C klassas som webhook för icke-upphovsman.

Användare C har webhook på nivå ANVÄNDARE.

Nej

Webhook på nivå ANVÄNDARE för användare C klassas som webhook för icke-upphovsman.

Avsändare: användare A | Signerare: användare B | Part som delas med: användare C

Användare A, B och C finns på samma konto

Användningsfall

Avisering?

Anteckningar

Kontot för användare A har webhook på nivå KONTO (skapad av användare A eller kontoadministratör).

Ja

Webhookar på nivå KONTO meddelar om händelser som aktiverats för kontot.

Kontot för användare A har webhook på nivå GRUPP (skapad av användare A eller konto-/gruppadministratör).

Antagande: Användare A och gruppadministratör finns i samma grupp.

Ja

Webhookar på nivå GRUPP meddelar om händelser som aktiveras av användarna i deras grupp.

Användare A har webhook på nivå ANVÄNDARE.

Ja

Webhook på nivå ANVÄNDARE för användare A har aktiverats då de är avsändare.

Användare A har webhook på nivå RESURS (för avtalet ovan som skickats).

Ja

 
     

Kontot för användare B har webhook på nivå KONTO (skapad av användare B eller kontoadministratör).

Ja

Eftersom användare A och B finns på samma konto kan webhookar på nivå KONTO meddela om alla händelser som aktiveras för det kontot.

Kontot för användare B har webhook på nivå GRUPP (skapad av användare B eller kontoadministratör).

Antagande: Användare A, B och gruppadministratör finns i samma grupp.

Ja

Eftersom användare A och B finns i samma grupp kan webhookar på nivå GRUPP meddela om alla händelser som aktiveras för den här gruppen.

Kontot för användare B har webhook på nivå GRUPP (skapad av användare B eller kontoadministratör).

Antagande: Användare A och B finns i olika grupper.

Nej

Webhook på nivå GRUPP för användare B klassas som webhook för signerare.

Webhook för användare A (RESURS/ANVÄNDARE/GRUPP/KONTO) aktiveras.

Användare B har webhook på nivå ANVÄNDARE.

Nej

Webhook för användare B på nivå ANVÄNDARE aktiveras inte då de är mottagare.

     

Kontot för användare C har webhook på nivå KONTO (skapad av användare C eller kontoadministratör).

Ja

Eftersom användare A och C finns på samma konto kan webhookar på nivå KONTO meddela om alla händelser som aktiveras för det kontot.

Kontot för användare C har webhook på nivå GRUPP (skapad av användare C eller kontoadministratör).

Antagande: Användare A, C och gruppadministratör finns i samma grupp.

Ja

Eftersom användare A och C finns i samma grupp kan webhookar på nivå GRUPP meddela om alla händelser som aktiveras för den här gruppen.

Kontot för användare C har webhook på nivå GRUPP (skapad av användare C eller kontoadministratör).

Antagande: Användare A och Användare C finns i olika grupper.

Nej

Webhook på nivå GRUPP för användare C klassas som webhook för icke-upphovsman.

Webhook för användare A (RESURS/ANVÄNDARE/GRUPP/KONTO) aktiveras.

Användare C har webhook på nivå ANVÄNDARE.

Nej

Webhook på nivå ANVÄNDARE för användare C klassas som webhook för icke-upphovsman.

Försök igen när lyssningstjänsten är nere

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

De ej levererade händelserna sparas i en kö för återförsök och under de kommande 72 timmarna görs allt 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 som startar på 1 minut och ökar till var 12:e timme, vilket resulterar i 15 försök under 72 timmar.

Om webhook-mottagaren inte svarar inom 72 timmar och inga meddelanden har skickats under de senaste sju dagarna kommer aktuell webhook att bli inaktiverad. Inga meddelanden skickas till denna URL förrän denna webhook är aktiverad igen.

Alla meddelanden mellan den tidpunkt då aktuell webhook inaktiverades och sedan aktiverades igen kommer att förloras.

 Adobe

Få hjälp snabbare och enklare

Ny användare?

Adobe MAX 2024

Adobe MAX
Kreativitetskonferensen

14–16 okt i Miami Beach och online

Adobe MAX

Kreativitetskonferensen

14–16 okt i Miami Beach och online

Adobe MAX 2024

Adobe MAX
Kreativitetskonferensen

14–16 okt i Miami Beach och online

Adobe MAX

Kreativitetskonferensen

14–16 okt i Miami Beach och online