Log på Adobe Sign som en administrator
Nyheder
Kom godt i gang
- Vejledning til hurtig start for administratorer
- Vejledning til hurtig start for brugere
- For udviklere
- Bibliotek med videoselvstudier
- Ofte stillede spørgsmål
Administrer
- Oversigt over Admin Console
- Brugeradministration
- Tilføjelse af brugere
- Opret funktionsfokuserede brugere
- Søg efter brugere med klargøringsfejl
- Skift navn/e-mailadresse
- Rediger en brugers gruppemedlemskab
- Rediger en brugers gruppemedlemskab via gruppegrænsefladen
- Forfrem en bruger til en administratorrolle
- Brugeridentitetstyper og enkeltlogin
- Skift brugeridentitet
- Godkend brugere med MS Azure
- Godkend brugere med Google-føderation
- Produktprofiler
- Login-oplevelse
- Konto-/gruppeindstillinger
- Oversigt over indstillinger
- Globale indstillinger
- Kontoniveau og ID
- Ny modtageroplevelse
- Selvunderskrivelsesarbejdsforløb
- Send i massevis
- Webformularer
- Arbejdsforløb for brugerdefineret afsendelse
- Power Automate-arbejdsforløb
- Biblioteksdokumenter
- Indsaml formulardata med aftaler
- Begrænset dokumentsynlighed
- Vedhæft en PDF-kopi af den underskrevne aftale
- Inkluder et link i mailen
- Medtag et billede i e-mailen
- Filer, der vedhæftes i mail, navngives som
- Vedhæft redigeringsrapport til dokumenter
- Flet flere dokumenter sammen til ét
- Download individuelle dokumenter
- Upload et underskrevet dokument
- Delegering til brugere af min konto
- Tillad eksterne modtagere at delegere
- Tilladelse til at underskrive
- Tilladelse til at sende
- Autoritet til at tilføje elektroniske segl
- Indstil en standardtidszone
- Indstil et standarddatoformat
- Brugere i flere grupper (UMG)
- Tilladelser for gruppeadministratorer
- Udskift modtager
- Revisionsrapport
- Fodnote om transaktion
- Beskeder og vejledning i produktet
- Tilgængelige PDF'er
- Ny oprettelsesoplevelse
- Sundhedsplejekunde
- Kontoopsætning
- Tilføj logo
- Tilpas firmaets værtsnavn/URL
- Tilføj firmanavn
- URL-omdirigering efter aftale
- Signaturindstillinger
- Velformaterede signaturer
- Tillad modtagere at underskrive ved
- Underskrivere kan ændre deres navn
- Tillad modtagere at bruge deres gemte signatur
- Brugerdefinerede vilkår for anvendelse og videregivelse af oplysninger
- Naviger modtagere gennem formularfelter
- Genstart aftalearbejdsforløb
- Afvis at underskrive
- Tillad arbejdsforløb for stempler
- Kræv, at underskrivere angiver deres titel eller virksomhed
- Tillad underskrivere at udskrive og placere en håndskreven signatur
- Vis meddelelser ved e-signering
- Kræve, at underskrivere bruger en mobilenhed til at oprette deres underskrift
- Anmod om IP-adresse fra underskrivere
- Udelad firmanavn og titel fra deltagelsesstempler
- Digitale signaturer
- Elektroniske segl
- Digital identitet
- Rapportindstillinger
- Ny rapportoplevelse
- Klassiske rapportindstillinger
- Sikkerhedsindstillinger
- Indstillinger for Single Sign-on
- Husk mig-indstillinger
- Politik for adgangskode til login
- Styrke af login-adgangskode
- Varighed af websession
- PDF-krypteringstype
- API
- Adgang for bruger- og gruppeoplysninger
- Tilladte IP-områder
- Kontodeling
- Tilladelser til kontodeling
- Kontroller til aftaledeling
- Bekræftelse af underskrivers identitet
- Adgangskode til underskrivelse af aftaler
- Dokumentadgangskodens styrke
- Bloker underskrivere efter geolokalitet
- Telefongodkendelse
- Videnbaseret godkendelse (KBA)
- Tillad sideudtrækning
- Udløb af dokumentlink
- Upload et klientcertifikat til webhooks/tilbagekald
- Tidsstempel
- Afsendelsesindstillinger
- Vis Send-siden efter login
- Kræv modtagernavn ved afsendelse
- Lås navneværdier for kendte brugere
- Tilladte modtagerroller
- Tillad e-vidner
- Modtagergrupper
- CC'er
- Adgang til modtagerrapport
- Obligatoriske felter
- Vedhæftning af dokumenter
- Samkopiering af felter
- Rediger aftaler
- Aftalenavn
- Sprog
- Private beskeder
- Tilladte signaturtyper
- Påmindelser
- Beskyttelse af underskrevne dokumenter med adgangskode
- Send aftalenotifikation via
- Muligheder for underskriveridentifikation
- Indholdsbeskyttelse
- Aktivér Notarize-transaktioner
- Dokumentudløb
- Forhåndsvisning, placer signaturer, og tilføj felter
- Rækkefølge for underskrivelse
- Liquid-tilstand
- Brugerdefinerede arbejdsforløbskontrolelementer
- Uploadindstillinger for e-underskrivelsessiden
- Omdirigering af bekræftelses-URL efter underskrivelse
- Beskedskabeloner
- Indstillinger for biomedicin
- Arbejdsforløbintegration
- Notariseringsindstillinger
- Integration af betalinger
- Underskrivermeddelelser
- SAML-indstillinger
- SAML-konfiguration
- Installer Microsoft Active Directory Federation Service
- Installer Okta
- Installer OneLogin
- Installer Oracle Identity Federation
- SAML-konfiguration
- Dataforvaltning
- Tidsstempelindstillinger
- Eksternt arkiv
- Kontosprog
- E-mailindstillinger
- Migrering fra echosign.com til adobesign.com
- Konfigurer indstillinger for modtagere
- Vejledning om forskriftsmæssige krav
- Hjælp til handicappede
- HIPAA
- Persondataforordning
- 21 CFR del 11 og EudraLex bilag 11
- Kunder i sundhedssektoren
- IVES-understøttelse
- "Lagring" af aftaler
- EU/UK-overvejelser
- Download aftaler i massevis
- Gør krav på dit domæne
- Rapportér misbrug-links
Send, underskriv og administrer aftaler
- Modtagerindstillinger
- Annuller en mailpåmindelse
- Indstillinger på e-underskrivelsessiden
- Oversigt over e-underskrivelsessiden
- Åbn for at læse aftalen uden felter
- Afvis at underskrive en aftale
- Deleger underskrivelsesautoritet
- Genstart aftalen
- Download en PDF af aftalen
- Se aftalens historik
- Vis aftalemeddelelserne
- Konvertér fra elektronisk til håndskreven signatur
- Konvertér fra håndskreven til elektronisk signatur
- Naviger formularfelterne
- Ryd dataene fra formularfelterne
- Forstørrelse og navigation på e-underskrivelsesside
- Skift det sprog, der bruges i aftaleværktøjerne og -oplysningerne
- Gennemse de juridiske meddelelser
- Juster Acrobat Sign-cookieindstillinger
- Send aftaler
- Oprettelse af felter i dokumenter
- Oprettelsesmiljø i appen
- Opret formularer med teksttags
- Opret formularer med Acrobat (AcroForms)
- Felter
- Ofte stillede spørgsmål om oprettelse
- Underskriv aftaler
- Administrer aftaler
- Administrer sideoversigt
- Deleger aftaler
- Udskift modtagere
- Begræns dokumentsynlighed
- Annuller en aftale
- Opret nye påmindelser
- Gennemgå påmindelser
- Annuller en påmindelse
- Få adgang til Power Automate-forløb
- Flere handlinger ...
- Sådan fungerer søgning
- Se en aftale
- Opret en skabelon fra en aftale
- Skjul/vis aftaler fra visning
- Upload en underskrevet aftale
- Rediger en sendt aftales filer og felter
- Rediger en modtagers godkendelsesmetode
- Tilføj eller rediger en udløbsdato
- Føj en note til aftalen
- Del en individuel aftale
- Annuller deling af en aftale
- Download en individuel aftale
- Download de enkelte filer i en aftale
- Download revisionsrapporten for en aftale
- Download feltindholdet af en aftale
- Revisionsrapport
- Rapportering og dataeksport
- Oversigt
- Giv brugere adgang til rapportering
- Rapportdiagrammer
- Dataeksporter
- Omdøb en rapport/eksport
- Dubler en rapport/eksport
- Planlæg en rapport/eksport
- Slet en rapport/eksport
- Brug af kontroltransaktion
Avancerede aftalefunktioner og arbejdsforløb
- Webformularer
- Genanvendelige skabeloner (Biblioteksskabeloner)
- Amerikanske regeringsformularer i Acrobat Sign-biblioteket
- Opret en biblioteksskabelon
- Skift en biblioteksskabelons navn
- Skift en biblioteksskabelons type
- Skift en biblioteksskabelons tilladelsesniveau
- Kopiér, rediger og gem en delt skabelon
- Download de aggregerede feltdata for en biblioteksskabelon
- Overfør ejerskab af webformularer og biblioteksskabeloner
- Power Automate-arbejdsforløb
- Oversigt over Power Automate-integrationen og inkluderede rettigheder
- Aktivér Power Automate-integrationen
- Kontekstintegrerede handlinger på siden Administrer
- Spor Power Automate-brug
- Opret et nyt forløb (eksempler)
- Udløsere, der bruges til forløb
- Import af forløb uden for Acrobat Sign
- Administrer forløb
- Rediger forløb
- Del forløb
- Deaktivere eller aktivere forløb
- Slet forløb
- Nyttige skabeloner
- Kun administrator
- Aftalearkivering
- Arkivering af webformularaftaler
- Gem udfyldte webformulardokumenter i SharePoint-bibliotek
- Gem udfyldte webformulardokumenter i OneDrive for Business
- Gem alle fuldførte dokumenter i Google Drive
- Arkiver udfyldte webformulardokumenter i Box
- Udtrækning af aftaledata
- Aftalenotifikationer
- Send brugerdefinerede mailnotifikationer med dit aftaleindhold og din underskrevne aftale
- Få dine Adobe Acrobat Sign-notifikationer i en Teams-kanal
- Få dine Adobe Acrobat Sign-notifikationer i Slack
- Få dine Adobe Acrobat Sign-notifikationer på Webex
- Aftalegenerering
- Generer dokument fra Power App-formular og Word-skabelon, send til underskrivelse
- Generér aftale fra Word-skabelon i OneDrive, og få signatur
- Generér aftale for markeret Excel-række, send til gennemgang og underskrivelse
- Arbejdsforløb for brugerdefineret afsendelse
- Del brugere og aftaler
Integrer med andre produkter
- Oversigt over Acrobat Sign-integrationer
- Acrobat Sign til Salesforce
- Acrobat Sign til Microsoft
- Andre integrationer
- Partneradministrerede integrationer
- Sådan oprettes en integrationsnøgle
Acrobat Sign-udvikler
- REST API'er
- Webhooks
Support og fejlfinding
API-adgang er kun forbeholdt erhvervs- og udviklerkonti.
Links til kernedokumentation
REST API 6 nyttige links:
- Registrer en udviklerkonto: https://acrobat.adobe.com/dk/da/sign/developer-form.html
- Metoder i appen: https://secure.adobesign.com/public/docs/restapi/v6
- Eksempler: https://opensource.adobe.com/acrobat-sign/developer_guide/index.html#!adobedocs/adobe-sign/master/samples.md
- Webhooks: https://opensource.adobe.com/acrobat-sign/acrobat_sign_events/index.html
Support til de ældre SOAP API'er er afsluttet fra maj 2021.
Alle kunder, der bruger SOAP API, skal migrere til REST API så hurtigt som muligt.
Når du er logget på, skal du gå til Konto > Acrobat Sign API > API-oplysninger > REST API'er og dokumentation.
Generelle begreber
Du kan ikke oprette dokumentet ved at vise siden i Web UI eller trække og slippe eller tildele underskriverroller ved hjælp af transientDocumentId via API.
TransientDocuments-kaldet returnerer transientDocumentID, som er gyldig i 7 dage. Du kan kun bruge det til de yderligere API-kald. Det er gemt på API-serveren og tildelt dette id. Upload en fil, og henvis derefter til dens id i de yderligere API-kald.
Du kan ikke uploade et dokument direkte i aftalen ved hjælp af REST API.
I henhold til REST-kravet skal du først oprette et kortvarigt dokument først og derefter bruge dette id i aftale-, widget- eller biblioteksmetoder som filkilden.
Det kortvarige dokument er en rå kildefil som PDF, doc, docx uploadet til Adobes servere. Så det er en praktisk måde at overføre dit grunddokument til API-serverne og et kortvarigt dokument på nettet.
Ja, du kan sende aftaler ved hjælp af workflows i v6 ved hjælp af API-kald POST /agreements. Godkend workflowId-parameteren i API-kaldet.
Du kan hente workflowId for et workflow ved hjælp af kaldet GET /workflows.
-
-
Gå til Konto > Adobe Sign API > API-anmodningslog
-
Log på Adobe Sign som en kontoadministrator
-
Gå til: Konto > Adobe Sign API > API-oplysninger
-
Klik på linket REST API-prøver.
Bemærk:Download JavaScript SDK på https://github.com/adobe-sign/AdobeSignJsSdk.
Fra v6 er muligheden "sendTroughWeb" ikke længere tilgængelig. Tilstanden erstatter den. Det er tilstanden, hvori aftalen lander. Tilstandsfeltet kan kun leveres i POST-kald. Det returneres aldrig i GET /agreements/{ID} og ignoreres, hvis det angives i kaldet PUT /agreements/{ID}. Aftalens eventuelle status kan hentes fra GET /agreements/ID.
state(string) = ['AUTHORING' eller 'DRAFT' eller 'IN_PROCESS'].
AUTHORING lader en bruger oprette en aftales dokumenter, før de sendes. Oprettelseshandlingen her refererer til oprettelse, redigering eller placering af formularfelter sammen med deres konfigurationer (tildelt, betingelser, datatype og så videre.) i aftaledokumenterne. Efter at have sendt dokumentet i oprettelsestilstand, er det synligt på i kladdesektionen af fanen Adobe Sign Administrer.
DRAFT er en midlertidig eller primitiv fase af den endelige tilsigtede ressource, som kan opdateres i trin for at oprette den endelige ressource, og er ikke synlig i kladdesektionen af fanen Adobe Sign Administrer. Ved at bruge kladdetilstanden kræves deltagersætinfo ikke, og den kan senere tildele ved oprettelse af PUT /agreements/agreementId for at fuldføre denne kladde. Dette trin kan gentages flere gange, indtil du har alle de nødvendige data til at oprette aftalen.
IN_PROCESS ændrer aftalestatussen til Sendt til underskrivelse og er synlig i sektionen Sendt til underskrivelse på fanen Adobe Sign Administrer.
SendThroughWeb giver dig mulighed for at sende aftalen interaktivt. De forskellige parametre i feltet "muligheder" i v5 POST /agreements-anmodning lader brugeren konfigurere denne interaktive visning (Send-side). Alle disse sidekonfigurationsparametre, såsom fileUploadOptions flyttes til POST agreements/ID/views api.
Så reelt kan du opnå sendThroughWeb ved at oprette en aftale i AUTHORING-tilstand via POST /agreements API. For at bede om URL'en til den næste side i den ønskede konfiguration skal du kalde POST agreements/ID/views API.
Udfør følgende trin:
1. Gå til REST API V6-dokumentation, og vælg metoden POST/agreements.
2. Brug følgende anmodningskode:
{ "fileInfos": [ { "transientDocumentId": "***************************" } ], "name": "test", "participantSetsInfo": [ { "memberInfos": [ { "email": "abc@gmail.com" } ], "order": 1, "role": "SIGNER" } ], "signatureType": "ESIGN", "state": "AUTHORING" }
3. Brug nu metoden post /agreements/{agreementId}/views med nedenstående anmodningskode:
{ "name": "AUTHORING" } |
Svarkoden indeholder URL'en til oprettelsesfelter.
Man kan definere tilbagekalds-URL'en på følgende måder:
- Brug nedenstående parameter til at definere tilbagekalds-URL'en efter behov:
"callbackInfo": "",
- Kontakt Adobe Sign-support for at indstille standard-URL'en for tilbagekaldelse for komplet konto.
SOAP UI (SmartBear) får SSL-forbindelsesfejl i stil med den følgende, som du får, når du foretager API-kald. Denne fejl opstår typisk, hvis du bruger forældet SSL- eller TLS-protokol, der er lavere end TLS1.2
FEJL: Undtagelse i anmodning: javax.net.ssl.SSLException: Modtaget kritisk advarsel: protocol_version
FEJL: Der opstod en fejl [Modtaget kritisk advarsel: protocol_version], se detaljer i fejlloggen
-
Tilføj (-Dsoapui.https.protocols=SSLv3,TLSv1.2) i VMOPTIONS -filen under Bin-mappen.
-
Gå til C:\Programmer\SmartBear\SoapUI-5.2.1\bin (den afhænger af, om du har installeret SOAP UI. Det kan være under C:\Programmer (x86))
-
I VMOPTIONS-filen skal du aktivere fuld læse-/skrivetilladelse til filen
-
Højreklik på VMOPTIONS-filen> Egenskaber>fanen Sikkerhed>Vælg bruger>Klik på Rediger. (Ikonet for Brugeradgangskontrol vises på knappen Rediger)>Markér alle afkrydsningsfelterne, og klik på OK.
-
Gentag det samme for administratorer, systemer og alle programpakker.
-
Åbn filen via Notesblok.
-
Tilføj denne protokol i bunden “-Dsoapui.https.protocols=SSLv3,TLSv1.2”, og gem ændringerne.
-
Luk SOAP UI, og genstart. Det virker uden SSL-fejl, når du foretager API-kald. (Udfør test-ping-kald for at kontrollere).
Gør følgende for at oprette klient-id og klienthemmelighed i Adobe Sign-programmet:
-
Log på din Adobe Sign-konto.
-
Gå til Konto > Adobe Sign API > API-programmer.
-
For at oprette et program skal du klikke på ikonet +.
-
Angiv navn og visningsnavn.
-
Under Domæne skal du vælge KUNDE og klikke på Gem.
-
Fremhæv programmet ved at klikke én gang.
-
Klik på Konfigurer OAuth for programmet.
-
Angiv omdirigerings-URI'en.
-
For at aktivere de nødvendige omfang skal du markere de respektive afkrydsningsfelter og klikke på Gem.
-
Log på Adobe Sign som en kontoadministrator
-
Gå til: Konto > Adobe Sign API > API-oplysninger
-
Klik på linket Integrationsnøgle
Bemærk:Hvis du ikke kan se linket til integrationsnøglen, skal du kontakte din Success Manager for at få denne til at aktivere din konto.
-
- Navngiv nøglen med en intuitiv værdi
- Vælg de forskellige Omfang, der kræves til din programfunktion
- Klik på Gem, når nøglen er fuldt konfigureret
-
Når nøglen er gemt, kan den findes her: Konto > Personlige indstillinger > Adgangstokens
Navnet på nøglen og alle de aktiverede omfang er angivet.
Klik én gang på nøglebeskrivelsen for at eksponere handlingslinks:
- Integrationsnøgle – dette link giver den bogstavelige nøgle
- Tilbagekald – dette tilbagekalder og sletter adgangstokenen permanent
-
Log på din Adobe Sign-konto.
-
Gå til Konto > Adobe Sign API > API-programmer.
-
Klik på ikonet + for at oprette et program.
-
Klik på Konfigurer OAuth for programmet.
-
Generer autorisationskode via følgende link. Klient-id'et, omdirigerings-URI'en og omfang skal være det samme som i følgende URL, som er valgt i programmet (undgå mellemrum i følgende URL, og Shard som 'NA1' tilhører iht. Adobe Sign):
https://secure.na1.echosign.com/public/oauth?redirect_uri=https://www.google.co.in&response_type=code&client_id=CBJCHBCAABAAo9FZgq31_5BVG_kcIXEe6gNtn-R-gdNe&scope=user_login:self+agreement_send:account -
Hvis kaldet er vellykket, skal du vælge autorisationskode fra adresselinjen.
-
Download og installér Postman fra linket https://www.getpostman.com/apps
-
Når den er downloadet og installeret, skal du klikke på NY for at oprette en POST.
-
Skriv linket the https://secure.na1.echosign.com/oauth/token iht. den Adobe Sign-konto, det tilhører.
-
Under Overskrifter skal du skrive Content-Type som application/x-www-form-urlencoded.
-
Sørg for, at x-www-form-urlencoded er valgt under Body, og angiv nedenstående parametre med deres tilsvarende værdier fra det program, der blev oprettet i Adobe Sign-kontoen, og klik på SEND.
-
Hvis alle oplysningerne er korrekte, returneres adgangstokenen og opdateringstokenen i svaret:
Mens du kører OAuth Process, skal du følge nedenstående punkter:
1. Korrekt klient-id og omdirigerings-URI er angivet.
2. Omfang, der er angivet i godkendelses-URL, skal matche nøjagtigt med de omfang, der er angivet i Adobe Sign-programmet.
3. Brug det korrekte shard (na1, na2, au1, eu1, jp1) iht. den konto, der konfigureres.
4. Fjern eventuelle mellemrum i godkendelses-URL'en (hvis nogen).
5. Kontrollér godkendelses-URL'ens syntaks:
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
Adgangstokener er kun gyldige i 3600 sekunder (en time), hvorefter de er udløbet.
API-anmodningsindehaveren kan bruge Opdater tokens for at generere nye adgangstokens efter behov.
Webhooks understøttes i REST API v6 og senere.
Hvis en Webhook-modtager ikke reagerer inden for 72 timer, bliver webhook deaktiveret, og der sendes ingen notifikation.
Hvis mål-URL'en til webhooken er nede af en eller anden grund, sætter Adobe Sign JSON i kø og prøver igen i en progressiv cyklus over 72 timer.
De ikke-leverede hændelser bliver vedvarende i en "forsøg igen"-kø, og der gøres den bedste indsats i løbet af de næste 72 timer for at levere notifikationerne i den rækkefølge, de opstod i.
Strategien for at prøve at levere notifikationer igen er en fordobling af tiden mellem forsøg, startende med et interval på 1 minut, der stiger til hver 12. time, hvilket resulterer i 15 forsøg i løbet af 72 timer.
For at oprette webhook direkte fra Adobe Sign UI skal du først oprette webhook-URL via Azure AD-funktionsapps via nedenstående trin:
-
Log på via Microsoft-konto https://portal.azure.com/.
-
Tilmeld dig Funktionsapps under Azure AD-kontoen.
-
Gå til Azure AD, og gå til Funktionsapps > Klik på ikonet + for funktioner.
-
Vælg Webhook+API med Javascript som sprog, og klik på Opret funktion.
-
Erstat Index.js-filen med følgende kodestykke:
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(); };
-
Klik på Test-knappen i det højre hjørne, og angiv følgende overskrift:
X-AdobeSign-ClientId as ***********************
-
Klik på Gem og Kør.
-
Når du modtager 200 OK-svar med følgende overskrift, skal du klikke på Hent funktions-URL
-
Kopiér URL'en, og gå til Adobe Sign UI > Webhooks > Klik på ikonet + for at oprette.
-
Angiv følgende oplysninger:
- Navn: Et intuitivt navn, som andre administratorer nemt kan forstå er foreslået.
- Omfang: Hvor stort et net webhooken fanger. Konto og Gruppe er tilgængelige i grænsefladen.
API'en understøtter omfangene Konto, Gruppe, Bruger og Ressource. - Der kan kun defineres ét omfang per webhook
- URL: Den mål-URL, som Adobe Sign skubbede JSON-nyttelasten til.
- Hændelser: Den udløser, der får Adobe Sign til at oprette JSON og skubbe den til URL'en.
Hver hændelse bygger en anden nyttelast, der er relevant for udløsningshændelsen
Flere hændelser kan inkluderes i en webhook. - Notifikationsparametre: Notifikationsparameter identificerer sektionerne i Hændelse JSON-nyttelasten, så du kun kan vælge hændelsens sektioner, som er vigtige.
-
Når webhook er fuldt defineret, skal du klikke på Gem, og den nye webhook begynder at reagere for at udløse hændelser med det samme.
Aftaleaktivet refererer til et aktiv, hvorigennem du selv kan oprette en aftale, f.eks. biblioteksdokument, widget og aftale.
For at søge efter aftalens aktivhændelser skal du først lave en anmodning til API'en, der opretter agreementAssetEvents med relevante søgeparametre.
Svaret er den første side med resultater sammen med en søge-id-parameter og markøren for næste side. Du kan bruge den til at hente flere sideresultater, hvis de er tilgængelige via API'en, som henter agreementAssetEvents baseret på søge-id.
-
Åbn REST API-dokumentationen til version 5.
-
Gå til post/search/agreementAssetEvents, og generer adgangstokenen med relevante omfang.
-
I anmodningskoden skal du definere start- og slutdato i henhold til kravet:
{ "endDate": "2018-05-22T22:33:33", "startDate": "2017-12-22T22:33:33" }
-
Klik på Prøv det. Det henter aftalens aktiv-id'er, som også kan bruges som aftale-id'er.
Bruger-/kontoadministration
- Log på Adobe Sign.
- Gå til Konto > Adobe Sign API > REST API-dokumentation.
- Vælg Version 5.
- Under metoden post /users skal du bruge den anmodningskode, der er nævnt under
UserCreationInfo method
{
"email": "email@email.com",
"firstName": "AA",
"lastName": "AB",
"password":"12******rte"
}
Adobe Sign-konti, der bruger Admin Console (Adobe One) til at administrere deres brugerrettigheder, kan ikke bruge Adobe Sign API'en til at oprette brugere eller administrere eksisterende brugere.
Adobe One Admin Console bruger en anden API end Adobe Sign API. Se disse artikler for mere information:
- https://helpx.adobe.com/dk/enterprise/help/users.html
- https://www.adobe.io/apis/cloudplatform/umapi-new.html
Hentning af gruppe-id:
-
Gå til https://secure.na1.echosign.com/public/docs/restapi/v5.
-
Klik på grupper under Ressourcer og handlinger.
-
Klik på GET /groups.
-
Klik på knappen oAuth-adgangstoken.
-
Generér adgangstokenen.
-
Klik på knappen Prøv det.
Du modtager et svar som følger med gruppens navn og gruppe-id:
{ "groupInfoList": [ { "groupId": "3AAABLblqZhB4o9EnlvmGB_m8CrG5O6XClTBO7vmojOOexu5r3G95LtEV2Sp7BuhNvQYSvWB7PmmwVPXnhPIiYSuHV98Cerkp", "groupName": "Default Group" }, { "groupId": "3AAABLblqZhC3dPT6za5h7r1-BOEWivCe_OcAVONhcsKa57SL9_iCwGr5v_JED1No5jE20Pcjv0mYH2J-LoY1AcmqS69vRkO7", "groupName": "test" }, ] }
Sletning af gruppe:
-
Klik på DELETE /groups/{groupId}.
-
For at generere Adgangstoken skal du klikke på knappen oAuth-adgangstoken.
-
Tilføj groupId, der er modtaget som svar på det forrige kald, som du vil slette i groupId Box.
-
Klik på Prøv det.
Du modtager et svar som følger, når gruppen er slettet: Intet indhold
Du kan ikke slette en gruppe, som en bruger er tildelt. Egentlig kan du kun slette den tomme Gruppe. Du modtager et svar som følger, hvis der er en bruger i gruppen.
"code": "GROUP_NOT_EMPTY", "besked": "Gruppen kan ikke slettes, fordi den ikke er tom." } |
Igangsættelse/afsendelse af aftaler
Generering af et kortvarigt dokument
-
Klik på transientDocuments, og udvid metoden POST /transientDocuments
-
Klik på knappen OAuth-adgangstoken
-
- Aktivér Omfang for transaktionen
- Klik på Godkend
-
Klik på Giv adgang, hvis du bliver spurgt om det
-
Du returneres til siden med API-metoder. Godkendelsesværdien er nu udfyldt.
- Skriv filnavnet i feltet Filnavn
- Klik på knappen Vælg fil, og upload dokumentet for aftalen
- Klik på knappen Prøv det!
-
Svaret genereres.
transientDocumentID kan findes i Svarets brødtekst:
Oprettelse af en aftale ved hjælp af det kortvarige dokument
-
Klik på aftaler, og udvid metoden POST /agreements
-
- Klik på knappen OAuth-adgangstoken
- Aktivér OAuth-omfanget
- Klik på Godkend
- Klik på Giv adgang, hvis du bliver spurgt om det
-
Du returneres til siden med API-metoder. Godkendelsesværdien er nu udfyldt.
- Kopiér nedenstående script til en teksteditor (dette script er bare et minimalt konfigureret eksempel; din produktionskode vil være anderledes)
- Indsæt din trasientDocumentId-værdi i koden, hvor det er angivet
{ "fileInfos": [ {"transientDocumentId":"PASTE YOUR TRANSIENTDOCUMENTID HERE"} ], "name": "test doc", "participantSetsInfo": [ { "memberInfos": [ { "email": "noreply@echosign.com" } ], "order": 1, "role": "SIGNER" } ], "signatureType": "ESIGN", "state": "DRAFT" }
- Kopiér dit brugerdefinerede script, og indsæt det i feltet AgreementInfo
- Klik på knappen Prøv det!
-
Svaret genereres.
agreementID kan findes i Svarets brødtekst:
Følgende er trinnene til at tilføje filer i FileInfo Parameter:
-
Brug kortvarigt id:
Gå til POST/transientDocuments, og upload det dokument, der skal bruges fra dit lokale system.
Brug det kortvarige id, der er genereret under sektionen Filinfo i POST/Agreements:"fileInfos": [ { "transientDocumentId": "" } ],
-
Brug biblioteksdokument-id:
Gå til Dashboard. Klik på Føj dokument til bibliotek, og gem skabelonen.
Under REST API-dokumentation skal du klikke på GET /libraryDocuments og hente biblioteks-id'et til den skabelon, der oprettes.
Under POST/Agreements skal du angive biblioteksdokument-id'et:"libraryDocumentId": "", "libraryDocumentName": "",
-
Brug offentligt tilgængelig URL:
Angiv den offentligt tilgængelige URL, der skal bruges under FileInfo-parameteren:
{ "documentURL": { "mimeType": "", "name": "", "url": "" },
-
Vælg Aftaler> POST/agreements.
-
Vælg Oauth-adgangstoken, og angiv de nødvendige omfang.
-
Når adgangstokenen er tilføjet, kan du bruge følgende anmodningskode:
{ "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*"} ] } }
I POST /agreements-kald for signaturflow-parameteren kan du godkende værdien SENDER_SIGNS_FIRST eller SENDER_SIGNS_LAST for at tilføje afsenderen som henholdsvis den første eller sidste underskriver.
Her er et eksempel på kaldet i JSON-format:
{
"documentCreationInfo": {
"fileInfos": [
{ "transientDocumentId":"3AAABLblqZ-yourIDGoesHere"
}
],
"name": "Test",
"recipientSetInfos": [
{
"recipientSetMemberInfos": [
{
"email": "test@email.com"
}
],
"recipientSetRole": "SIGNER"
}
],
"signatureType": "ESIGN",
"signatureFlow": "SENDER_SIGNS_FIRST"
}
}
Muligheden for at sende på vegne er kun tilgængelig i REST API V6 med Avanceret deling aktiveret.
Hvis Send-tilladelse ikke gives i deling, eller hvis Avanceret deling ikke er aktiveret, får du et svar som følger:
{"code":"PERMISSION_DENIED","message":"Brugeren, der er angivet i x-på-vegne-af-bruger overskrift har ikke den nødvendige tilladelse til at udføre denne handling."}
|
For funktionen Send på vegne skal du aktivere Avanceret kontodeling for kontoen, så brugerne kan give afsendelsestilladelser til andre brugere, mens de deler deres konto. For Avanceret deling skal du se under Aktivering af avanceret kontodeling.
Når brugerdeling er aktiveret, skal du gennemgå følgende trin for at sende på vegne:
Generering af et kortvarigt dokument:
-
Under transientDocuments skal du klikke på POST /transientDocuments.
-
For at generere token til godkendelse skal du klikke på knappen OAUTH-ADGANGSTOKEN.
-
I x-på-vegne-af-bruger skal du angive mailen på den bruger, du vil sende på vegne af, i følgende format: mail: test@email.com
-
For at vælge en fil skal du klikke på Vælg fil og klikke på Prøv det.
Du modtager et svar som følger med transientDocumentId:
{"transientDocumentId":"3AAABLblqZhB9Mjo0mrIu_pSgrf5VsMaKM68_Vmn80cimaqiUAD2OxrPp2e5H8GvjfiOxj4d5B8bCPkUfvaozW3KLisp_wseGVOL8A7oNZni1DWyFi4uNoxLQu4nUO44Wh63GQv9_HEJMePust0Pk94vJ_rbS96R7ic-vl7jbOkN0b4EB5-JMqlC-Fl_Vpyz8I1EQUrM5I4nB9ztMov4ad00yiOtDw0tB-Y2t5JdzM07P-mpJmwYEl8Fq2IeDuWjcR2tV7qY7TNGX2CNyh9jt0aMyduHeYa0GABr69z8Hm76eKdtaM_1E1ggWj205fSrNcwJsnpSO278*"}
Generering af en aftale ved hjælp af det kortvarige dokument:
-
Under aftaler skal du klikke på POST /agreements.
-
For at generere token til godkendelse skal du klikke på knappen OAUTH-ADGANGSTOKEN.
-
I x-på-vegne-af-bruger skal du angive brugerens mail, som det gøres ved oprettelse af det kortvarige dokument.
-
I AgreementInfo skal du tilføje følgende kode og klikke på Prøv det.
{ "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 modtager et svar som følger med agreementId:
{ "id": "CBJCHBCAABAAUlen3l_fzlj1Kbn_wGZAhYcIgN0J7Qtq" }
-
Log på Adobe Sign.
-
Gå til Konto > Adobe Sign API > API-oplysninger, og klik på REST API Method Documentation.
-
POST /transientDocuments, og upload en fil, og opret et kortvarigt dokument-id.
-
Kopiér det kortvarige dokument-id, og brug det i metoden POST /agreement. Nævn følgende JSON-anmodning i feltet:
{ "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 }] } }
-
For at udføre JSON-anmodningen skal du klikke på knappen Prøv det.
Den korrekte JSON returnerer svaret med aftale-id'et.
Følgende er de parametre, som du kan sende i koden for at indstille åben adgangskode:
{ "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": "Åbn adgangskode for at se dokumentet", "securityOptions": { "openPassword": "1234", "protectOpen": true } }] }
|
For at oprette aftalen ved hjælp af API med tilstanden "AUTHORING" skal du gøre følgende:
Gå til Post /agreements, og opret Adgangstoken med de krævede omfang.
Brug anmodningskoden som følger:
{ "fileInfos": [ { "transientDocumentId": "*********************" } ], "name": "A1", "participantSetsInfo": [ { "memberInfos": [ { "email": "abc@xyz.com" } ], "order": 1, "role": "SIGNER" } ], "signatureType": "ESIGN", "state": "AUTHORING" }
|
V6 har et sæt oprettende API'er til at oprette en aftale. I v5 forbruges formFields direkte i POST /agreements api. I v6 kan brugeren dog oprette en aftale i AUTHORING-tilstand (tilstand = AUTHORING) gennem v6 POST /agreements og bruge PUT /agreements/ID/formFields på et senere tidspunkt for at tilføje formularfelter til dokumenterne i denne aftale.
Gør følgende:
-
Gå til REST API V6-dokumentation, og vælg metoden POST/agreements.
-
Brug følgende anmodningskode:
{ "fileInfos": [ { "transientDocumentId": "***************************" } ], "name": "test", "participantSetsInfo": [ { "memberInfos": [ { "email": "abc@gmail.com" } ], "order": 1, "role": "SIGNER" } ], "signatureType": "ESIGN", "state": "AUTHORING" }
-
Brug metoden put /agreements/{agreementId}/formFields med følgende anmodning som eksempel:
{ "fields": [ { "locations": [ { "height": 36, "left": 75, "pageNumber": "1", "top": 200, "width": 150 } ], "contentType": "SIGNATURE_BLOCK", "name": "sigBlock1", "inputType": "SIGNATURE", "recipientIndex":1 } ]}
Den sender aftalen til den nævnte modtager, når anmodningen er fuldført.
-
Log på Adobe Sign.
-
Gå til Konto > Adobe Sign API > API-oplysninger, og klik på REST API Method Documentation.
-
POST /transientDocuments, og upload en fil, og opret et kortvarigt dokument-id.
-
Kopiér det kortvarige dokument-id, og brug det i metoden POST /agreement. Nævn følgende JSON-anmodning i feltet:
{ "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 } ] } }
-
For at udføre JSON-anmodningen skal du klikke på knappen Prøv det.
Den korrekte JSON returnerer svaret med aftale-id'et.
-
Log på Adobe Sign.
-
Gå til Konto > Adobe Sign API > API-oplysninger, og klik på REST API Method Documentation.
-
POST /transientDocuments, og upload en fil, og opret et kortvarigt dokument-id.
-
Kopiér det kortvarige dokument-id, og brug det i metoden POST /agreement. Nævn følgende JSON-anmodning i feltet:
{ "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" }] } }
-
For at udføre JSON-anmodningen skal du klikke på knappen Prøv det.
Den korrekte JSON returnerer svaret med aftale-id'et.
-
For at åbne aftalen i Authoring Mode skal du kopiere URL'en og indsætte den i en browsers adresselinje.
-
Træk og slip formularfelterne på det ønskede sted.
-
For at sende aftalen til underskrivelse skal du klikke på Send.
Brug POST /agreements til at oprette en aftale. Sender den til underskrivelse og returnerer agreementID i svaret til klienten. Nedenfor er JSON-formatet til afsendelse af aftale med telefongodkendelse.
{ "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": "Gennemgå og underskriv dette 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 flette dataene direkte i formularfelterne ved hjælp af følgende metoder:
- Brug af en biblioteksskabelon:
Hvis du bruger et biblioteksskabelon-id under FileInfo-parameteren, skal du sørge for at angive det nøjagtige feltnavn og dets tilknyttede data under nedenstående sektion:
"mergeFieldInfo": [ { "defaultValue": "", "fieldName": "" } ],
|
- Brug af teksttags i et dokument, der er uploadet som et kortvarigt dokument:
Hvis du uploader et dokument, der har teksttags føjet til sig som et kortvarigt dokument, skal du sørge for at angive det nøjagtige feltnavn og dets tilknyttede data under nedenstående sektion:
"mergeFieldInfo": [ { "defaultValue": "", "fieldName": "" } ],
|
Hvordan sendes en aftale ved hjælp af API, der har forudfyldte værdier for de specifikke formularfelter (mergefield)?
Forudsætningen for dette kald er først at gennemføre trinnet "Transient Upload" og opnå et "transientDocumentId" (ved brug af: secure.na1.echosign.com/public/docs/restapi/v5#!/transientDocuments/createTransientDocument), der skal bruges her.
- Dette kald inkluderer sektionen "mergeFieldInfo", hvor standardværdier for specifikke formularfelter er angivet.
- Dette forudfylder data fra et andet system i API-kaldet.
- Disse felter i aftalen er enten redigerbare eller skrivebeskyttede.
Forudsætninger:
- Kortvarigt dokument-id
- Feltnavne og deres værdier
Eksempel på anmodning om kald:
Anmodning: POST /api/rest/v5/agreements HTTP/1.1 Vært: api.na1.echosign.com (eller du kan angive dit shard-navn, som du kan finde ved at bruge kaldet getbaseURis: https://secure.na1.echosign.com/public/docs/restapi/v5#!/base_uris/getBaseUris Adgangstoken: 2AAABLblqZhA_D1mluNKQP7py5vXtt-1UHl9NR25e_C3LnKTUH14IblbrXODbXGRozyr7ChBkJNM* x-user-email: sender@yourdomain.com Content-Type: application/json Cache-Control: no-cache
{ "documentCreationInfo": { "signatureType": "ESIGN", "recipientSetInfos": [ { "recipientSetMemberInfos": [ { "email": “signerEmail@domain.com" } ], "recipientSetRole": "SIGNER" } ],
"signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED", "message": "Please Sign this from us!", "fileInfos": [ { "transientDocumentId": "3AAABLblqZhD1uP3ZnkJximC0JV1S677PR5xmybSJ-SJn6OtEy2tVqFyMN4xUAbhKTSkLw2Zb6HEF4zAGsrUd2ycoB8fFHQJhrci0O6267VztmIL4nCicSqvAjO7HckATHAsovVmuYwI9_FDDgHg0ogyti62L13HQFZIQRe9iyQMvvzbmksM7ODNK_HEepEKRCeJTtis9FOlz6uRCcIMNlbX_2GU8utWT" } ], "name": "MSA Edited”, "mergeFieldInfo": [ { "fieldName": "AccountName", "defaultValue": "Sam's Garage" }, { "fieldName": "AccountNumber", "defaultValue": "8756999" }, { "fieldName": "Zip", "defaultValue": "94501" }, { "fieldName": "City", "defaultValue": "CityVille" }, { "fieldName": "State", "defaultValue": "CA" }, { "fieldName": "Street", "defaultValue": "123 Some Road" }, { "fieldName": "Title1", "defaultValue": "COO" }, { "fieldName": "Description", "defaultValue": "Some new description here" } ] }
}
Svaret på dette kald er det "agreementId", som du skal gemme i dit system til efterfølgende kald (underskrivelses-URL, status, formulardata osv.)
Svar: { "agreementId": "3AAABLblqZhCf_7xDcrOgKFwAabp1S-OFfvUdHf2wJsSMwlB95_x_WdUeab67jOkJi1IJzWuSJ0zdNNKugS1blZB4LT5vNVyJ" }
|
Når du kører metoden "post /megaSigns/{megaSignId}/views", vises der en fejl som "Den anmodede visning er ikke tilgængelig for ressourcen i den aktuelle tilstand."
Fejlen vises, hvis den angivne navneparameterværdi er ugyldig i nedenstående anmodningskode:
{
"name": " "
}
For eksempel hvis MegaSign-aftalen allerede er "IN_PROCESS", så giver værdien "AUTHORING" den nævnte fejl. Sørg for, at den angivne værdi er i overensstemmelse med den aktuelle aftaletilstand.
Når du kører metoden "put /megaSigns/{megaSignId}/state", vises der en fejl som "Ingen værdi angivet for MegaSign-annulleringsoplysninger."
Fejlen skyldes, at parameteren mangler i anmodningskoden:
"megaSignCancellationInfo": {
"comment": "",
"notifyOthers": false
}
I stedet for at bruge "Minimalt skema" skal du klikke på "Komplet modelskema" og angive den komplette anmodningskode for at køre API-kaldet.
For at ændre tilstanden af MegaSign-aftalen skal du bruge put /megaSigns/{megaSignId}/state og gøre følgende:
- Gå til REST API-dokumentationen for V6, og vælg metoden
put /megaSigns/{megaSignId}/state. - Angiv godkendelsesværdien og også If-Match og megasignID.
- For at hente megasignID skal du bruge get /megaSigns
- For at hente If-Match skal du bruge get /megaSigns/{megaSignId} og finde "Etag" under overskriften
- {
"state": "CANCELED",
"megaSignCancellationInfo": {
"comment": "cancel",
"notifyOthers": false
}
}
For at kunne registrere en webhook reagerer webhook-URL'en på denne verifikationsanmodning med en 2XX-svarkode, og den kan desuden sende den samme klient-id-værdi tilbage på én af følgende to måder:
- I en svaroverskrift X-AdobeSign-ClientId. Det er den samme overskrift, der sendes i anmodningen og gentages i svaret.
- I JSON-svarets brødtekst, hvor nøglen til X-AdobeSign-ClientId og dens værdi er det samme klient-id, der sendes i anmodningen.
Adobe Sign modtager 2xx-svaret med X-AdobeSign-ClientId. Brugeren kan kontrollere, om det er konfigureret korrekt i webhook eller ej.
Webhook-URL svarer ikke i henhold til den forventede adfærd. For hver Post-notifikation, som Adobe Sign sendte, svarer URL med 2XX-statuskode og gengælder det klient-id, der blev sendt i anmodningsoverskrifter (X-AdobeSign-ClientId), tilbage i svarets overskrifter.
Få de fulde oplysninger via dette link:
https://www.adobe.io/apis/documentcloud/sign/docs.html#!adobedocs/adobe-sign/master/webhooks/webhook_events.md
Når URL'en ikke overholder denne protokol, tager Adobe Sign højde for, at den ikke har bekræftet anmodningen og forsøgt at omlægge i henhold til den pålidelige politik.
Hvis webhooken ikke svarer, og enten den maksimale forsøgstid eller det maksimale interval for nyt forsøg overskrides, deaktiveres webhooken.
Twitter™ og Facebook-indlæg er ikke dækket af Creative Co-vilkårene
Administrer/få oplysninger om aftaler
For at ændre det dokument, der allerede er sendt til underskrivelse, skal du bruge metoden PUT /agreements/{agreementId}, med hvilken du kan opdatere en eksisterende aftale. Angiv det kortvarige id sammen med aftale-id'et i følgende anmodningskode:
{ "documentUpdateInfo": { "fileInfos": [ { "agreementDocumentId": "", "transientDocumentId": "" } ] } }
|
Følgende er instruktionerne til at opdatere tilstanden fra "AUTHORING" til "IN_PROCESS" ved hjælp af Put /agreements/{agreementId}/state:
-
Få aftale-id'et hentet ved hjælp af metoden POST/Agreement.
-
Brug Get /agreements/{agreementId} for at hente det nyeste ETag.
-
Gå til Put /agreements/{agreementId}/state, og angiv følgende oplysninger: "state": "IN_PROCESS"
Nej.
Der er ingen metode i den aktuelle REST API til at uploade en underskrevet kopi.
Afsenderen skal uploade den underskrevne kopi på siden Administrer.
DELETE /agreements/ID bruges til at tillade at skjule en aftale fra Administrer-siden.
Adobe har en ny API PUT /agreements/ID/me/visibility til at styre synligheden af en aftale (i GET /agreements). Ud over den funktionalitet, der leveres af DELETE /agreements/ID, giver det nye synlighedsslutpunkt også en bruger mulighed for at fortryde "skjul"-handlingen, dvs. at gøre aftalen synlig igen.
Du kan også følge de detaljerede trin nedenfor:
- Gå til metoden get /agreements, og hent aftale-id'et.
- Klik på put /agreements/{agreementId}/me/visibility, og angiv nedenstående anmodning som eksempel:
{
"visibility": "HIDE"
}
Aftale-id'et er kun skjult for get /libraryDocuments, men det er stadig synligt under Administrer-fanen.
API-tilbageholdelsesfunktionen er ikke aktiveret som standard.
For at aktivere handlingen DELETE/agreements skal du kontakte din Success Manager og anmode om, at API-tilbageholdelse aktiveres for kontoen.
Få mere at vide om, hvordan du aktiverer tilbageholdelsesfunktionerne for din konto, under Adobe Sign – dokumenttilbageholdelse.
-
Log på som Adobe Sign-administrator, og gå til: https://secure.adobesign.com/public/docs/restapi/v6
-
- Klik på agreements, og udvid metoden GET /agreements
- Klik på knappen OAUTH ACCESS-TOKEN
- Aktivér omfanget agreement_read:self
- Klik på knappen Godkend.
- Klik på Giv adgang, hvis du bliver spurgt om det
- Klik på knappen Prøv det!
-
Svaret genereres.
agreementId kan findes i Svarets brødtekst:
-
DELETE /agreements/{agreementId}/documents: Sletter alle de dokumenter, der er relateret til en aftale. Selve aftalen forbliver synlig på siden Administrer.
- Vælg handlingen DELETE/agreements, som skal køres.
- Klik på knappen OAUTH ACCESS-TOKEN, og opret adgangstoken med omfanget areement_retention.
- Angiv agreementId på den aftale, du vil slette.
- Når aftalen er slettet, har svarets brødtekst "intet indhold".
Du får følgende svar, hvis handlingen DELETE/agreements ikke er aktiveret:
"code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED",
"message": "Handlingen kræver, at nogle kontoindstillinger skal aktiveres. Kontakt Adobe Sign-teamet for at aktivere indstillingerne."
Sådan downloades det underskrevne dokument sammen med revisionsrapport og supplerende dokumenter via Adobe Sign REST API i stedet for at foretage et separat kald for at downloade revisionsrapporten via følgende metode.
-
Klik på GET /agreements/{agreementId}/combinedDocument.
-
Klik på knappen oAuth-adgangstoken.
-
Adgangstoken genereres automatisk, når godkendelsen er accepteret.
-
Angiv agreementId.
-
Under attachSupportingDocuments skal du vælge true på rullelisten.
-
Under attachAuditReport skal du vælge true på rullelisten.
-
Klik på knappen Prøv det!
Den downloader den kombinerede PDF af Underskrevet, supplerede dokument og revisionsrapport.
For at downloade mange dokumenter på én gang er kun dokumenteksportværktøjet tilgængeligt, og med API kan du kun downloade ét dokument ad gangen. Følgende er API-metoden for samme:
https://secure.na1.adobesign.com/public/docs/restapi/v5#!/agreements/getCombinedDocument
Biblioteksskabeloner og webformularer
-
Log på Adobe Sign som administrator, og gå til: https://secure.na1.adobesign.com/public/docs/restapi/v6
-
- Klik på libraryDocuments, og udvid metoden GET /libraryDocuments
- Klik på knappen OAUTH ACCESS-TOKEN
- Aktivér omfanget library_read:self.
- Klik på knappen Godkend.
- Klik på Giv adgang, hvis du bliver spurgt om det
- Klik på knappen Prøv det!
-
Svaret genereres.
libraryDocumentId kan findes i svarets brødtekst:
Adobe har en ny API PUT/libraryDocuments/ID/me/visibility til at styre synligheden af en aftale (i GET /agreements). Ud over den funktionalitet, der leveres af DELETE /agreements/ID, giver det nye synlighedsslutpunkt også en bruger mulighed for at fortryde "skjul"-handlingen, dvs. at gøre aftalen synlig igen.
Du kan følge de detaljerede trin nedenfor:
- Gå til metoden get /libraryDocuments, og hent aftale-id'et.
- Klik på put /libraryDocuments/{libraryDocumentId}/me/visibility, og angiv nedenstående anmodning som eksempel:
{
"visibility": "HIDE"
}
Biblioteks-id'et er kun skjult for get /libraryDocuments, men det er stadig synligt under Administrer-fanen.
- Send en anmodning med supportteamet for at få omfanget aktiveret til bibliotekssletning.
- API sletter biblioteksdokumentet. Aftaler, der oprettes med dette biblioteksdokument, påvirkes dog ikke.
Generering af et libraryDocumentID
-
Gå til https://secure.echosign.com/public/docs/restapi/v5.
-
Klik på libraryDocuments.
-
Klik på knappen oAuth Access-token.
Tillad adgang – token til dig selv, gruppe eller konto.
-
Vælg libraryTemplateType – Dokument eller Form_field_layer.
-
Klik på Prøv det.
Du kan modtage et svar som det følgende for alle dine skabeloner. (Kopiér libraryDocumentId for den biblioteksskabelon, du vil slette).
{ "libraryDocumentList": [ { "name": "testing fields", "modifiedDate": "2017-08-04T01:06:05-07:00", "scope": "PERSONAL", "libraryDocumentId": "3AAABLblqZhAK53Dvzq88Q1Ov0TEvMAySDPpIVjF1PWgUpy0H1uYggt4iwGiRSZYlWfl9ms_AcmgZ_uZMPPN2hNT9izwaspHc", "libraryTemplateTypes": [ "DOCUMENT" ] },
Sletning af biblioteksskabeloner
-
Kopiér libraryDocumentID fra svarets brødtekst.
-
Gå til Delete libraryDocuments.
-
Klik på knappen oAuth-adgangstoken. Tillad adgang – token til dig selv, gruppe eller konto.
-
Indsæt libraryDocumentId i feltet Værdi.
-
Klik på Prøv det.
Skabelonen slettes.Du får følgende svarkode: 204
Kun webformularer i en Kladde-tilstand kan opdateres.
-
Opret widget ved hjælp af post /widgets.
-
Hent widget-id'et fra get/widgets.
-
Når du har oprettet ved hjælp af metoden GET /widgets/{widgetId}, skal du hente Etag fra svarets brødtekst.
-
Under put /widgets/{widgetId} skal du bruge Etag fra GET /widgets/{widgetId}. Under If-Match parameteren skal du angive widgetId og widgetInfo.
{ "fileInfos": [ { "transientDocumentId": "******" } ], "name": "Widht_Name", "status": "DRAFT", "widgetParticipantSetInfo": { "memberInfos": [ { "email": "" } ], "role": "SIGNER" } }
-
Brug caseeksempler
-
Foretag et get/agreements-kald med den korrekte x-api-user.
-
I svarets brødtekst skal du finde den aftale, der er sendt til underskrive, og som du vil finde underskrivelses-URL'en for, og du skal notere aftale-id'et
-
Foretag et get/agreements/{agreementId}/signingUrls-kald ved hjælp af det aftale-id, du modtaget fra kaldet get/agreements.
Resultat
Outputtet returnerer mailadressen på underskriveren/underskriverne og e-underskrivelses-URL'en.