Logg på Adobe Sign som administrator
Veiledning for Adobe Acrobat Sign
Nyheter
Kom i gang
- Hurtigstartveiledning for administratorer
- Hurtigstartveiledning for brukere
- For utviklere
- Videoopplæringsbibliotek
- Vanlige spørsmål
Administrer
- Oversikt over Admin Console
- Brukeradministrasjon
- Legge til brukere
- Lage funksjonsfokuserte brukere
- Se etter brukere med klargjøringsfeil
- Endre navn/e-postadresse
- Redigere en brukers gruppemedlemskap
- Redigere en brukers gruppemedlemskap gjennom gruppegrensesnittet
- Forfremme en bruker til en administratorrolle
- Brukeridentitetstyper og SSO
- Bytte brukeridentitet
- Autentisere brukere med MS Azure
- Autentisere brukere med Google-føderasjon
- Produktprofiler
- Påloggingsopplevelse
- Innstillinger for konto/gruppe
- Innstillingsoversikt
- Globale innstillinger
- Kontonivå og ID
- Ny mottakeropplevelse
- Selvsigneringsarbeidsflyter
- Send samlet
- Nettskjemaer
- Tilpassede arbeidsflyter for sending
- Power Automate-arbeidsflyter
- Biblioteksdokumenter
- Samle inn skjemadata med avtaler
- Begrenset dokumentsynlighet
- Legge ved en PDF-kopi av den signerte avtalen
- Inkludere en kobling i e-posten
- Inkludere et bilde i e-postmeldingen
- Filer vedlagt e-post navngis som
- Legge ved revisjonsrapporter til dokumenter
- Slå sammen flere dokumenter til ett dokument
- Last ned enkeltdokumenter
- Laste opp signert dokument
- Delegering for brukere i kontoen min
- Tillate eksterne mottakere å delegere
- Myndighet til å signere
- Myndighet til å sende
- Rett til å legge til elektroniske segl
- Angi en standard tidssone
- Angi et standard datoformat
- Brukere i flere grupper
- Administratortillatelser for grupper
- Erstatte mottaker
- Revisjonsrapport
- Transaksjonsbunntekst
- I produktmeldinger og veiledning
- Tilgjengelige PDF-er
- Ny redigeringsopplevelse
- Kunde i helsevesenet
- Kontooppsett
- Signaturpreferanser
- Riktig formaterte signaturer
- La mottakere signere ved å
- Underskrivere kan endre navn
- La mottakere bruke den lagrede signaturen sin
- Tilpassede vilkår for bruk og forbrukerinformasjon
- Led mottakerne gjennom skjemafelt
- Start avtalens arbeidsflyt på nytt
- Avslå å signere
- Tillat Stempler-arbeidsflyt
- Krev at underskrivere angir stilling eller firma
- La underskrivere skrive ut og plassere en skriftlig signatur
- Vis meldinger ved e-signering
- Krev at underskrivere bruker en mobilenhet til å opprette sin signatur
- Be om IP-adresse fra underskrivere
- Utelat firmanavn og tittel fra deltakelsesstempler
- Digitale signaturer
- Elektroniske segl
- Digital identitet
- Rapportinnstillinger
- Ny rapportopplevelse
- Klassiske rapportinnstillinger
- Sikkerhetsinnstillinger
- Innstillinger for enkeltpålogging
- Innstillinger for Husk meg
- Policy for innloggingspassord
- Styrke på innloggingspassordet
- Varighet på nettøkt
- PDF-krypteringstype
- API
- Tilgang for bruker- og gruppeinformasjon
- Tillatte IP-serier
- Kontodeling
- Tillatelser for kontodeling
- Avtalens delingskontroller
- Bekreftelse av underskriveridentitet
- Signeringspassord for avtale
- Styrke på dokumentpassord
- Blokker underskrivere etter geografisk plassering
- Telefongodkjenning
- Kunnskapsbasert godkjenning (KBA)
- Tillat uttrekking av side
- Utløp for dokumentlenke
- Last opp et klientsertifikat for webhook/tilbakekall
- Tidsstempel
- Send-innstillinger
- Vis Send-siden etter pålogging
- Krev mottakernavn ved sending
- Lås navneverdier for kjente brukere
- Tillatte mottakerroller
- Tillat e-vitner
- Mottakergrupper
- Kopimottakere
- Tilgang til mottakeravtale
- Obligatoriske felt
- Legge ved dokumenter
- Feltutflating
- Endre avtaler
- Avtalenavn
- Språk
- Private meldinger
- Tillatte signaturtyper
- Påminnelser
- Passordbeskyttelse for signert dokument
- Send avtalevarsel gjennom
- Alternativer for underskriveridentifikasjon
- Innholdsbeskyttelse
- Aktiver Notarize-transaksjoner
- Dokumentutløp
- Forhåndsvis, plasser signaturer og legg til felt
- Sigeringsrekkefølge
- Liquid Mode
- Tilpassede arbeidsflytkontroller
- Opplastingsalternativer for e-signeringssiden
- Omdirigering til nettadresse for bekreftelse etter signering
- Meldingsmaler
- Bio-Pharma-innstillinger
- Arbeidsflytintegrasjon
- Innstillinger for notarisering
- Betalingsintegrering
- Underskrivermelding
- SAML-innstillinger
- SAML-konfigurasjon
- Installer Microsoft Active Directory Federation Service
- Installer Okta
- Installer OneLogin
- Installer Oracle Identity Federation
- SAML-konfigurasjon
- Datastyring
- Tidsstempelinnstillinger
- Eksternt arkiv
- Kontospråk
- E-post-innstillinger
- Flytte fra echosign.com til adobesign.com
- Konfigurere alternativer for mottakere
- Retningslinjer for lovfestede krav
- Tilgjengelighet
- HIPAA
- GDPR
- 21 CFR del 11 og EudraLex vedlegg 11
- Kunder innen helsesektoren
- IVES-støtte
- Oppbevaring av avtaler i hvelv
- Hensyn for EU/Storbritannia
- Last ned flere avtaler samtidig
- Kreve domenet ditt
- Koblinger for å rapportere misbruk
Sende, signere og behandle avtaler
- Mottakeralternativer
- Avbryte en e-postpåminnelse
- Alternativer på e-signeringssiden
- Oversikt over e-signeringssiden
- Åpne for å lese avtalen uten felt
- Avslå å signere en avtale
- Delegere signeringsautorisasjon
- Starte avtalen på nytt
- Laste ned avtalen som PDF
- Vise avtalehistorikken
- Vise avtalebeskjeder
- Konvertere fra elektronisk til skriftlig signatur
- Konvertere fra skriftlig til elektronisk signatur
- Bla gjennom skjemafeltene
- Fjerne dataene fra skjemafeltene
- Navigere og zoome på signeringssiden
- Endre språket som brukes i avtaleverktøyene og informasjonen
- Lese de juridiske merknadene
- Justere Acrobat Sign-innstillingene for informasjonskapsler
- Send avtaler
- Redigere felt til dokumenter
- Redigeringsmiljø i appen
- Opprette skjemaer og tekstkoder
- Opprette skjemaer med Acrobat (AcroForms)
- Felt
- Vanlige spørsmål om forfatting
- Signer avtaler
- Behandle avtaler
- Behandle sideoversikt
- Delegere avtaler
- Erstatte mottakere
- Begrense dokumentsynlighet
- Kansellere en avtale
- Opprette nye påminnelser
- Gå gjennom påminnelser
- Avbryte en påminnelse
- Få tilgang til Power Automate-flyter
- Flere handlinger ...
- Slik fungerer søk
- Vise en avtale
- Opprette en mal fra en avtale
- Skjule/vise avtaler fra visning
- Laste opp en signert avtale
- Endre filer og felt i en sendt avtale
- Redigere godkjenningsmetoden til en mottaker
- Legge til eller endre en utløpsdato
- Legge til et notat i avtalen
- Dele en enkeltavtale
- Oppheve deling av en avtale
- Laste ned en individuell avtale
- Laste ned de individuelle filene i en avtale
- Laste ned revisjonsrapporten for en avtale
- Laste ned feltinnholdet i en avtale
- Revisjonsrapport
- Rapportering og dataeksport
- Oversikt
- Gi brukere tilgang til rapportering
- Rapportdiagrammer
- Dataeksporter
- Gi nytt navn til et diagram / en eksport
- Duplisere en rapport/eksport
- Planlegge en rapport/eksport
- Slette en rapport/eksport
- Kontrollere transaksjonsbruk
Avanserte avtalefunksjoner og arbeidsflyter
- Nettskjemaer
- Gjenbrukbare maler (Bibliotekmaler)
- Overføre eierskap til nettskjemaer og bibliotekmaler
- Power Automate-arbeidsflyter
- Oversikt over Power Automate-integreringen og inkluderte rettigheter
- Aktivere Power Automate-integreringen
- Konteksthandlinger på Administrer-siden
- Sporing av Power Automate-bruk
- Opprette en ny flyt (eksempler)
- Utløsere som brukes for flyter
- Importere flyter fra utenfor Acrobat Sign
- Administrer flyter
- Rediger flyter
- Dele flyter
- Deaktivere eller aktivere flyter
- Slette flyter
- Nyttige maler
- Kun administrator
- Avtalearkiver
- Lagre de fullførte dokumentene i SharePoint
- Lagre de fullførte dokumentene i One Drive for Business
- Lagre de fullførte dokumentene på Google Disk
- Lagre dine fullførte dokumenter i DropBox
- Lagre de fullførte dokumentene i Box
- Arkivering av nettskjemaavtale
- Lagre fullførte nettskjemadokumenter i SharePoint-biblioteket
- Lagre fullførte nettskjemadokumenter i OneDrive for Business
- Lagre fullførte dokumenter på Google Disk
- Lagre fullførte nettskjemadokumenter i Box
- Avtaledatauttrekking
- Avtalevarsler
- Sende tilpassede e-postvarsler med avtaleinnholdet og signert avtale
- Få Adobe Acrobat Sign-varsler i en Teams-kanal
- Få Adobe Acrobat Sign-varsler i Slack
- Få Adobe Acrobat Sign-varsler i Webex
- Generering av avtaler
- Generere dokument fra Power App-skjema og Word-mal, sende til signering
- Generere avtale fra Word-mal i OneDrive, og få signatur
- Generere avtale for valgt Excel-rad, sende til gjennomgang og signering
- Tilpassede arbeidsflyter for sending
- Dele brukere og avtaler
Integrere med andre produkter
- Oversikt over Acrobat Sign-integrasjoner
- Acrobat Sign for Salesforce
- Acrobat Sign for Microsoft
- Andre integrasjoner
- Partneradministrerte integrasjoner
- Hvordan innhente en integrasjonsnøkkel
Acrobat Sign-utvikler
- REST-API-er
- Webhook
Kundestøtte og feilsøking
API-tilgang er reservert eksklusivt for Enterprise- og Developer-kontoer.
Lenker til kjernedokumentasjon
REST API 6 – nyttige lenker:
- Registrer en utviklerkonto: https://acrobat.adobe.com/no/no/sign/developer-form.html
- Metoder i appen: https://secure.adobesign.com/public/docs/restapi/v6
- Prøver: 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
Støtte for de eldre SOAP API-ene ble avsluttet fra mai 2021.
Alle kunder som bruker SOAP API, bør gå over til REST API så snart som mulig.
Når du er logget på, går du til Konto > API for Acrobat Sign > API-informasjon > Rest API-er og dokumentasjon.
Generelle begreper
Du kan ikke redigere dokumentet ved å vise siden i webgrensesnittet eller med dra og slipp, eller tilordne signaturroller ved hjelp av transientDocumentId via API.
TransientDocuments-kallet returnerer transientDocumentID, som er gyldig i 7 dager. Du kan bare bruke den til videre API-kall. Den lagres på API-serveren og tildeles denne ID-en. Last opp en fil og referer deretter til ID-en i de videre API-kallene.
Du kan ikke laste opp et dokument direkte i avtalen ved hjelp av REST API.
I henhold til REST-kravet må du først opprette et transient dokument og deretter bruke denne ID-en i avtale-, widget- eller bibliotekmetoder som filkilde.
Det transiente dokumentet er en rå kildefil som PDF, doc eller docx, lastet opp til Adobe-serverne. Så det er en praktisk måte å overføre basedokumentet til API-serverne og et transient dokument på nettet på.
Ja, du kan legge ut avtaler ved hjelp av arbeidsflyter i v6 med API-kallet POST /agreements. Send workflowId-parameteren i API-kallet.
Du kan få workflowId for en arbeidsflyt med kallet GET /workflows.
-
-
Gå til Konto > API for Adobe Sign > API-forespørselslogg
-
Logg på Adobe Sign som administrator
-
Gå til: Konto > API for Adobe Sign > API-informasjon
-
Klikk på lenken REST API Samples.
Merk:For å laste ned JavaScript SDK se https://github.com/adobe-sign/AdobeSignJsSdk.
Fra og med v6 er ikke alternativet "sendTroughWeb" lenger tilgjengelig. State erstatter det. Det er statusen avtalen lander i. Statusfeltet kan bare brukes i POST-kall. Det blir aldri returnert i GET /agreements/{ID} og ignoreres hvis det er gitt i PUT /agreements/{ID}-kall. Eventuell status for avtalen kan fås fra GET /agreements/ID.
stat(streng) = ['AUTHORING' eller 'DRAFT' eller 'IN_PROCESS'].
AUTHORING tillater en bruker å forfatte dokumentene til en avtale før de sendes ut. Forfatteroperasjonen her refererer til å opprette, redigere eller plassere skjemafelt sammen med konfigurasjonene (tildelt til, betingelser, datatype og så videre.) i avtaledokumentene. Etter at dokumentet er lagt ut med statusen Authoring, er dokumentet synlig under Utkast på Behandle-fanen i Adobe Sign.
DRAFT er midlertidig eller en primitiv fase av den endelige tiltenkte ressursen som kan oppdateres trinnvis for å opprette den endelige ressursen, og er ikke synlig under Utkast på Behandle-fanen i Adobe Sign. Ved bruk av Draft-status er ikke deltakersettinformasjon nødvendig, og det kan senere tildeles mens du utfører PUT /agreements/agreementId for å fullføre dette utkastet. Dette trinnet kan gjentas flere ganger til du har alle nødvendige data for å opprette avtalen.
IN_PROCESS endrer avtalestatusen til Out for Signature (Ute til signatur) og vises under Ute til signatur på Behandle-fanen i Adobe Sign.
SendThroughWeb lar deg sende avtalen interaktivt. De forskjellige parameterne i "opsjoner"-feltet i v5 POST /agreements tillater brukeren å konfigurere denne interaktive visningen (Send side). Alle disse sidekonfigurasjonsparameterne, som fileUploadOptions, er flyttet til API-et POST agreements/ID/views.
Så du kan faktisk oppnå sendThroughWeb ved å opprette en avtale i AUTHORING-status gjennom API-et POST /agreements. Kall deretter API-et POST agreements/ID/views for å be om URL-adressen til neste side i ønsket konfigurasjon.
Følg denne fremgangsmåten:
1. Gå til REST API V6-dokumentasjon og velg metoden POST /agreements.
2. Bruk følgende forespørselskode:
{ "fileInfos": [ { "transientDocumentId": "***************************" } ], "name": "test", "participantSetsInfo": [ { "memberInfos": [ { "email": "abc@gmail.com" } ], "order": 1, "role": "SIGNER" } ], "signatureType": "ESIGN", "state": "AUTHORING" }
3. Bruk nå metoden post /agreements/{agreementId}/views sammen med forespørselskoden nedenfor:
{ "name": "AUTHORING" } |
Svarkoden gir URL-adressen til forfatterfelt.
Man kan definere tilbakekall-URL på følgende måter:
- Bruk parameteren nedenfor til å definere tilbakekall-URL etter behov:
"callbackInfo": "",
- Kontakt Adobe Sign-støtte for å angi standard tilbakekall-URL for full konto.
SOAP UI (SmartBear) får SSL-tilkoblingsfeil som ligner på den følgende, som du får når du foretar API-kall. Denne feilen oppstår vanligvis hvis du bruker utdaterte SSL- eller TLS-protokoller som er lavere enn TLS1.2
FEIL: Unntak i forespørsel: javax.net.ssl.SSLException: Mottok alvorlig feil: protocol_version
FEIL: En feil oppsto [Received fatal alert: protocol_version], se feilloggen for detaljer
-
Legg til (-Dsoapui.https.protocols=SSLv3,TLSv1.2) i VMOPTIONS-filen under Bin-mappen.
-
Gå til C:\Programfiler\SmartBear\SoapUI-5.2.1\bin (Avhengig av hvor du har installert SOAP UI. Det kan være under C:\Programfiler (x86))
-
I VMOPTIONS-filen aktiverer du full lese-/skrivetillatelse.
-
Høyreklikk på VMOPTIONS-filen> Egenskaper>Sikkerhet-fanen> Velg bruker> Klikk på Rediger. (Ikonet for brukertilgangskontroll vises på Rediger-knappen)> Merk av i alle avmerkingsboksene og klikk på OK.
-
Gjenta det samme for administratorer, systemer og alle programpakker.
-
Åpne filen i Notisblokk.
-
Legg til denne protokollen nederst "-Dsoapui.https.protocols = SSLv3, TLSv1.2" og lagre endringene.
-
Lukk SOAP UI og start på nytt. Det fungerer uten SSL-feil når du foretar API-kall. (Utfør test-pingkall for å sjekke).
Det følgende er fremgangsmåten for å opprette klient-ID og klienthemmelighet i Adobe Sign-programmet:
-
Logg på Adobe Sign-kontoen.
-
Gå til Konto > API for Adobe Sign > API-programmer.
-
Klikk på +-ikonet for å opprette et program.
-
Skriv inn navn og visningsnavn.
-
Velg KUNDE under Domene og klikk på Lagre.
-
Merk programmet ved å klikke på det.
-
Klikk på Konfigurer OAuth for programmet.
-
Angi URI for omdirigering.
-
For å aktivere de nødvendige omfangene merker du av i de respektive avmerkingsboksene og klikker på Lagre.
-
Logg på Adobe Sign som kontoadministrator
-
Gå til: Konto > API for Adobe Sign > API-informasjon
-
Klikk på lenken Integreringsnøkkel
Merk:Hvis du ikke ser lenken til integreringsnøkkel, kan du kontakte den kundeansvarlige for å få aktivert kontoen din.
-
- Gi nøkkelen et navn med en intuitiv verdi
- Velg de forskjellige omfangene som kreves for programfunksjonen din
- Klikk på Lagre når nøkkelen er fullt konfigurert
-
Når du har lagret den, finner du nøkkelen i: Konto > Personlige innstillinger > Tilgangstokener
Navnet på nøkkelen og alle aktiverte omfang vises.
Klikk på nøkkelbeskrivelsen én gang for å vise handlingslenkene:
- Integreringsnøkkel – Denne lenken gir nøkkelen
- Opphev– Dette opphever og sletter tilgangstokenet permanent
-
Logg på Adobe Sign-kontoen.
-
Gå til Konto > API for Adobe Sign > API-programmer.
-
Klikk på +-ikonet for å opprette et program.
-
Klikk på Konfigurer OAuth for programmet.
-
Generer godkjenningskode ved hjelp av følgende lenke. Klient-ID, URI for omdirigering og omfang må være de samme som i følgende URL som valgt i programmet (unngå mellomrom i followingURL og Shard som 'NA1' i henhold til tilhørende Adobe Sign-konto):
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 kallet er vellykket, velger du godkjenningskode fra adresselinjen.
-
Last ned og installer Postman fra lenken https://www.getpostman.com/apps.
-
Når den er lastet ned og installert, klikker du på NEW for å opprette en POST.
-
Skriv inn lenken https://secure.na1.echosign.com/oauth/token i henhold til din Adobe Sign-konto.
-
Oppgi Content-Type som application/x-www-form-urlencoded under Headers.
-
Forsikre deg om at x-www-form-urlencoded er valgt under Body og skriv inn parameterne nedenfor med tilhørende verdier fra programmet opprettet i Adobe Sign-kontoen, og klikk på SEND.
-
Hvis all informasjonen er riktig, returneres tilgangstokenet og oppdateringstokenet i svaret:
Når du kjører OAuth Process, må du følge disse punktene:
1. Riktig klient-ID og URI for omdirigering er spesifisert.
2. Omfang gitt i godkjennings-URL må samsvare nøyaktig med omfanget som er gitt i Adobe Sign-programmet.
3. Bruk riktig shard (na1, na2, au1, eu1, jp1) i henhold til kontoen som konfigureres.
4. Fjern eventuelle mellomrom i godkjennings-URL-en (hvis noen).
5. Sjekk syntaksen for godkjennings-URL-en:
https://secure.na1.echosign.com/public/oauth?redirect_uri=https://secure.na1.echosign.com/public/oauthDemo&
response_type=code&client_id=9MEJXY4Y4R7L2T&scope=agreement_send
Tilgangstokener er bare gyldige i 3600 sekunder (én time) før de utløper.
API-forespørselinnehaveren kan bruke Oppdater tokens for å generere nye tilgangstokener etter behov.
Webhooks støttes i REST API v6 og nyere.
Hvis en Webhook-mottaker ikke svarer innen 72 timer, blir webhooken deaktivert, og ingen varsler blir sendt.
Hvis mål-URL-en for webhooken er nede av en eller annen grunn, setter Adobe Sign JSON i kø og prøver på nytt i en progressiv syklus over 72 timer.
De ikke-leverte hendelsene blir værende i en prøv på nytt-kø, og det gjøres en best mulig innsats i løpet av de neste 72 timene for å levere varslene i den rekkefølgen de oppsto.
Strategien for å prøve å levere varsler på nytt er en dobling av tiden mellom forsøk, og starter med et ett minutts intervall som øker til hver 12. time, og resulterer i 15 nye forsøk i løpet av 72 timer.
For å opprette webhook direkte fra Adobe Sign-brukergrensesnittet må du først opprette webhook-URL gjennom Azure AD-funksjonsapper ved å bruke fremgangsmåten nedenfor:
-
Logg på via Microsoft-konto https://portal.azure.com/.
-
Registrer deg for funksjonsapper under AzureAD-kontoen.
-
Gå til AzureAD og gå til Function Apps > Klikk på +-ikonet for Functions.
-
Velg Webhook+API med Javascript som språk, og klikk på Create Function.
-
Erstatt Index.js-filen med følgende kodesnutt:
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(); };
-
Klikk på Test-knappen i høyre hjørne og oppgi følgende overskrift:
X-AdobeSign-ClientId as ***********************
-
Klikk på Save and Run.
-
Når du mottar 200 OK-svar med følgende overskrift, klikker du på Get function URL
-
Kopier URL-en, og gå til Adobe Sign UI > Webhooks > Klikk på +-ikonet for å opprette.
-
Skriv inn følgende informasjon:
- Name: Det foreslås et intuitivt navn som andre administratorer lett kan forstå.
- Scope: Hvor bredt nett skal webhooken fange. Konto og gruppe er tilgjengelig i grensesnittet.
API-et støtter omfangene Konto, Gruppe, Bruker og Ressurs. - Bare ett omfang per webhook kan defineres
- URL: Mål-URL som Adobe Sign sendte JSON-nyttelasten til.
- Events: Utløseren som får Adobe Sign til å bygge JSON og sende til URL-en.
Hver hendelse bygger en annen nyttelast som er relevant for utløserhendelsen
Flere hendelser kan inkluderes i en webhook. - Notification Parameters: Varslingsparameterne identifiserer delene av Event JSON-nyttelasten, slik at du kan velge de delene av hendelsen som er viktige.
-
Når webhooken er fullt definert, klikker du på Save, og den nye webhooken begynner å reagere for å utløse hendelser umiddelbart.
Avtaleressursen refererer til en ressurs der du kan opprette en avtale, for eksempel bibliotekdokument, widget og avtale.
For å søke etter avtaleressurshendelser må du først sende en forespørsel til API-et som oppretter agreementAssetEvents med relevante søkeparametere.
Svaret er den første siden med resultater sammen med en søke-ID-parameter og markøren for neste side. Du kan bruke den til å hente ytterligere sideresultater ved hjelp av API-et, som henter agreementAssetEvents basert på søke-ID.
-
Åpne REST API-dokumentasjonen for versjon 5.
-
Gå til post/search/agreementAssetEvents og generer tilgangstokenet med relevante omfang.
-
I forespørselskoden definerer du start- og sluttdato i henhold til kravet:
{ "endDate": "2018-05-22T22:33:33", "startDate": "2017-12-22T22:33:33" }
-
Klikk på Try it out. Den henter avtaleressurs-ID-er, som også kan brukes som avtale-ID-er.
Bruker-/kontoadministrasjon
- Logg på Adobe Sign.
- Gå til Konto > API for Adobe Sign > REST API-dokumentasjon.
- Velg versjon 5.
- Under metoden post /users bruker du forespørselskoden nevnt under
UserCreationInfo-metoden
{
"email": "email@email.com",
"firstName": "AA",
"lastName": "AB",
"password": "12******rte"
}
Adobe Sign-kontoer som bruker Admin Console (Adobe One) til å administrere brukerrettigheter, kan ikke bruke Adobe Sign-API til å opprette brukere eller administrere eksisterende brukere.
Adobe One Admin Console bruker et annet API enn Adobe Sign-API. Se disse artiklene for mer informasjon:
- https://helpx.adobe.com/no/enterprise/help/users.html
- https://www.adobe.io/apis/cloudplatform/umapi-new.html
Hente gruppe-ID:
-
Gå til https://secure.na1.echosign.com/public/docs/restapi/v5.
-
Klikk på grupper under Resources and Operations.
-
Klikk på GET /groups.
-
Klikk på knappen oAuth Access-token.
-
Generer tilgangstokenet.
-
Klikk på knappen Try it out.
Du mottar et svar som dette, med gruppenavn og gruppe-ID:
{ "groupInfoList": [ { "groupId": "3AAABLblqZhB4o9EnlvmGB_m8CrG5O6XClTBO7vmojOOexu5r3G95LtEV2Sp7BuhNvQYSvWB7PmmwVPXnhPIiYSuHV98Cerkp", "groupName": "Default Group" }, { "groupId": "3AAABLblqZhC3dPT6za5h7r1-BOEWivCe_OcAVONhcsKa57SL9_iCwGr5v_JED1No5jE20Pcjv0mYH2J-LoY1AcmqS69vRkO7", "groupName": "test" }, ] }
Slette gruppe:
-
Klikk på DELETE /groups/{groupId}.
-
Klikk på knappen oAuth Access-token for å generere tilgangstoken.
-
Legg til groupId mottatt i svaret på forrige kall, som du vil slette, i groupId Box.
-
Klikk på Try it out.
Du får svar som det følgende når gruppen er slettet: No content
Du kan ikke slette en gruppe som har en tildelt bruker. Du kan hovedsakelig bare slette den tomme gruppen. Du får svar som det følgende hvis det er en bruker i gruppen.
"code": "GROUP_NOT_EMPTY", "message": "The group cannot be deleted because it is not empty." } |
Starte/sende avtaler
Generere et transient dokument
-
Klikk på transientDocuments og utvid metoden POST /transientDocuments
-
Klikk på knappen OAuth Access-token
-
- Aktiver omfangene for transaksjonen
- Klikk på Authorize (Godkjenn)
-
Hvis du blir utfordret, klikker du på Allow Access (Gi tilgang)
-
Du kommer tilbake til API-metodesiden. Godkjenningsverdien er nå fylt ut.
- Skriv inn filnavnet i feltet File-Name
- Klikk på Choose File-knappen og last opp dokumentet for avtalen
- Klikk på knappen Prøv det! Start
-
Svaret genereres.
transientDocumentID finner du i Response Body:
Generere en avtale ved hjelp av transientdokumentet
-
Klikk på agreements og utvid metoden POST /agreements
-
- Klikk på knappen OAuth Access-token
- Aktiver OAuth-omfanget
- Klikk på Authorize (Godkjenn)
- Hvis du blir utfordret, klikker du på Allow Access (Gi tilgang)
-
Du kommer tilbake til API-metodesiden. Godkjenningsverdien er nå fylt ut.
- Kopier skriptet nedenfor til et tekstredigeringsprogram (dette skriptet er bare et minimalt konfigurert eksempel; produksjonskoden din vil være annerledes)
- Sett inn trasientDocumentId-verdien i koden der det er angitt
{ "fileInfos": [ {"transientDocumentId":"PASTE YOUR TRANSIENTDOCUMENTID HERE"} ], "name": "test doc", "participantSetsInfo": [ { "memberInfos": [ { "email": "noreply@echosign.com" } ], "order": 1, "role": "SIGNER" } ], "signatureType": "ESIGN", "state": "DRAFT" }
- Kopier det tilpassede skriptet og lim det inn i feltet AgreementInfo
- Klikk på knappen Prøv det! Start
-
Svaret genereres.
AgreementID finner du i Response Body:
Det følgende er trinnene for å legge til filer i FileInfo Parameter:
-
Bruk transient ID:
Gå til POST/transientDocuments og last opp dokumentet som skal brukes, fra ditt lokale system.
Bruk transient-ID-en generert under Filinfo-delen i POST /Agreements:"fileInfos": [ { "transientDocumentId": "" } ],
-
Bruk bibliotekdokument-ID:
Gå til Dashboard. Klikk på Legg til dokument i bibliotek og lagre malen.
Under REST API-dokumentasjon klikker du på GET /libraryDocuments og henter biblioteks-ID for malen som opprettes.
Oppgi bibliotekdokument-ID-en under POST /Agreements:"libraryDocumentId": "", "libraryDocumentName": "",
-
Bruk offentlig tilgjengelig URL:
Oppgi den offentlig tilgjengelige URL-en som skal brukes under FileInfo-parameteren:
{ "documentURL": { "mimeType": "", "name": "", "url": "" },
-
Velg alternativet Agreements> POST/agreements.
-
Velg alternativet Oauth Access-Token, og oppgi nødvendige omfang.
-
Når tilgangstokenet er lagt til, kan du bruke følgende forespørselskode:
{ "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-kall, for signatureflow-parameteren kan du sende verdien SENDER_SIGNS_FIRST eller SENDER_SIGNS_LAST verdien for å legge til avsenderen som henholdsvis første eller siste underskriver.
Her er et eksempel på kallet i JSON-format:
{
"documentCreationInfo": {
"fileInfos": [
{ "transientDocumentId":"3AAABLblqZ-yourIDGoesHere"
}
],
"name": "Test",
"recipientSetInfos": [
{
"recipientSetMemberInfos": [
{
"email": "test@email.com"
}
],
"recipientSetRole": "SIGNER"
}
],
"signatureType": "ESIGN",
"signatureFlow": "SENDER_SIGNS_FIRST"
}
}
Alternativet for sending på vegne er bare tilgjengelig i REST API V6 med avansert deling på.
Hvis Send-tillatelse ikke er gitt ved deling eller hvis Avansert deling ikke er aktivert, får du et svar som dette:
{"code":"PERMISSION_DENIED","message":"User provided in x-on-behalf-of-user header does not have required permission to perform this operation."}
|
For funksjonen Send på vegne aktiverer du Avansert kontodeling for kontoen, slik at brukere kan gi sendetillatelser til andre brukere mens de deler kontoen sin. For avansert deling se Aktivering av avansert kontodeling.
Når brukerdeling er aktivert, går du gjennom følgende trinn for å sende på vegne av:
Generere et transient dokument:
-
Klikk på POST /transientDocuments under transientDocuments.
-
For å generere token for godkjenning klikker du på knappen OAUTH ACCESS-TOKEN.
-
I x-on-behalf-of-user oppgir du e-postadressen til brukeren du vil sende på vegne av i følgende format: email: test@email.com
-
Klikk på Choose File for å velge en fil, og klikkpå Try it out.
Du får et svar som dette med transientDocumentId:
{"transientDocumentId":"3AAABLblqZhB9Mjo0mrIu_pSgrf5VsMaKM68_Vmn80cimaqiUAD2OxrPp2e5H8GvjfiOxj4d5B8bCPkUfvaozW3KLisp_wseGVOL8A7oNZni1DWyFi4uNoxLQu4nUO44Wh63GQv9_HEJMePust0Pk94vJ_rbS96R7ic-vl7jbOkN0b4EB5-JMqlC-Fl_Vpyz8I1EQUrM5I4nB9ztMov4ad00yiOtDw0tB-Y2t5JdzM07P-mpJmwYEl8Fq2IeDuWjcR2tV7qY7TNGX2CNyh9jt0aMyduHeYa0GABr69z8Hm76eKdtaM_1E1ggWj205fSrNcwJsnpSO278*"}
Generere en avtale ved hjelp av Transient-dokumentet:
-
Klikk på POST /agreements under agreements.
-
For å generere token for godkjenning klikker du på knappen OAUTH ACCESS-TOKEN.
-
I x-on-behalf-of-user oppgir du brukerens e-postadresse som da Transient-dokumentet ble opprettet.
-
I AgreementInfo legger du til følgende kode og klikker på Try it out.
{ "fileInfos": [ { "transientDocumentId":"3AAABLblqZhB9Mjo0mrIu_pSgrf5VsMaKM68_Vmn80cimaqiUAD2OxrPp2e5H8GvjfiOxj4d5B8bCPkUfvaozW3KLisp_wseGVOL8A7oNZni1DWyFi4uNoxLQu4nUO44Wh63GQv9_HEJMePust0Pk94vJ_rbS96R7ic-vl7jbOkN0b4EB5-JMqlC-Fl_Vpyz8I1EQUrM5I4nB9ztMov4ad00yiOtDw0tB-Y2t5JdzM07P-mpJmwYEl8Fq2IeDuWjcR2tV7qY7TNGX2CNyh9jt0aMyduHeYa0GABr69z8Hm76eKdtaM_1E1ggWj205fSrNcwJsnpSO278*" } ], "name": "Test", "participantSetsInfo": [ { "memberInfos": [ { "email": "signer@email.com" } ], "order": 1, "role": "SIGNER" } ], "signatureType": "ESIGN", "state": "IN_PROCESS" }
Du får et svar som dette med agreementID:
{ "id": "CBJCHBCAABAAUlen3l_fzlj1Kbn_wGZAhYcIgN0J7Qtq" }
-
Logg deg på Adobe Sign.
-
Gå til Konto> Adobe Sign API> API-informasjon og klikk på REST API Method Documentation.
-
POST / transientDocuments og last opp en fil og opprett en transient Document ID.
-
Kopier transient Document ID og bruk den i POST /agreements-metoden. Nevn følgende JSON-forespørsel i boksen:
{ "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 å utføre JSON-forespørselen klikker du på knappen Try it out.
Riktig JSON returnerer svaret med avtale-IDen.
Det følgende er parameterne du kan gi i koden for å angi passord for åpning:
{ "documentCreationInfo": [{ "signatureType": "ESIGN", "recipientSetInfos": [{ "recipientSetMemberInfos": [{ "email": "abc@xyz.com" }],
"recipientSetRole": "SIGNER" }], "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED", "fileInfos": [ { "libraryDocumentId": "3AAABLblqZhBsm_vH7TVzU3hRdbtWuvzfTKDvBzaKZTiehjO2eGTk5Rlu02K-0BYn8HBJVFTWOmT_BQlrofPBlrCdjiJ_JI-V" } ], "name": "Open password to view document", "securityOptions": { "openPassword": "1234", "protectOpen": true } }] }
|
Gjør følgende for å opprette en avtale ved hjelp av API med statusen "AUTHORING":
Gå til Post /agreements og opprett tilgangstoken med de nødvendige omfangene.
Bruk følgende forespørselskode:
{ "fileInfos": [ { "transientDocumentId": "*********************" } ], "name": "A1", "participantSetsInfo": [ { "memberInfos": [ { "email": "abc@xyz.com" } ], "order": 1, "role": "SIGNER" } ], "signatureType": "ESIGN", "state": "AUTHORING" }
|
V6 har et sett med authoring-API-er for oppretting av avtale. I v5 konsumeres formFields direkte i API-et POST /agreements. I v6 kan imidlertid brukeren opprette en avtale i AUTHORING-status (state = AUTHORING) gjennom v6 POST /agreements og bruke PUT /agreements/ID/formFields senere for å legge til skjemafelt i dokumentene til denne avtalen.
Dette er trinnene:
-
Gå til REST API V6-dokumentasjonen og velg POST /agreements-metoden.
-
Bruk følgende forespørselskode:
{ "fileInfos": [ { "transientDocumentId": "***************************" } ], "name": "test", "participantSetsInfo": [ { "memberInfos": [ { "email": "abc@gmail.com" } ], "order": 1, "role": "SIGNER" } ], "signatureType": "ESIGN", "state": "AUTHORING" }
-
Bruk metoden put /agreements/{agreementId}/formFields med følgende forespørsel 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 avtalen til nevnte mottaker når forespørselen er fullført.
-
Logg deg på Adobe Sign.
-
Gå til Konto> Adobe Sign API> API-informasjon og klikk på REST API Method Documentation.
-
POST / transientDocuments og last opp en fil og opprett en transient Document ID.
-
Kopier transient Document ID og bruk den i POST /agreements-metoden. Nevn følgende JSON-forespørsel i boksen:
{ "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 å utføre JSON-forespørselen klikker du på knappen Try it out.
Riktig JSON returnerer svaret med avtale-IDen.
-
Logg deg på Adobe Sign.
-
Gå til Konto> Adobe Sign API> API-informasjon og klikk på REST API Method Documentation.
-
POST / transientDocuments og last opp en fil og opprett en transient Document ID.
-
Kopier transient Document ID og bruk den i POST /agreements-metoden. Nevn følgende JSON-forespørsel i boksen:
{ "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 å utføre JSON-forespørselen klikker du på knappen Try it out.
Riktig JSON returnerer svaret med avtale-IDen.
-
For å åpne avtalen i Authoring-modus kopierer du URL-en og limer den inn i nettleserens adressefelt.
-
Dra og slipp skjemafeltene på ønsket sted.
-
Klikk på Send for å sende ut avtalen for signatur.
Bruk POST /agreements til å opprette en avtale. Sender den ut til signering, og returnerer agreementID-en i svaret til klienten. Nedenfor er JSON-formatet for å sende avtale ved bruk av telefongodkjenningsmetode.
{ "documentCreationInfo": { "mergeFieldInfo": null, "recipientSetInfos": [{ "signingOrder": null, "recipientSetRole": "SIGNER", "recipientSetMemberInfos": [{ "securityOptions": null, "email": "Signer@email.com" }],
"privateMessage": null, "securityOptions": [{ "authenticationMethod": "PHONE", "phoneInfos": [{ "phone": "1111111111", "countryCode": "+1" }] }] }],
"signatureType": "ESIGN", "callbackInfo": null, "message": "Please review and sign this document.", "locale": "en_US", "vaultingInfo": null, "securityOptions": null, "reminderFrequency": null, "ccs": null, "postSignOptions": null, "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED", "daysUntilSigningDeadline": null, "formFieldLayerTemplates": [], "name": "Adobe Sign Agreement-Phone authentication testing", "formFields": null, "fileInfos": [{ "libraryDocumentName": null, "transientDocumentId": "3AAABLYourTransactionID", "documentURL": null, "libraryDocumentId": null }] },
"options": { "autoLoginUser": true, "authoringRequested": false, "noChrome": true, "sendThroughWeb": null, "sendThroughWebOptions": null, "locale": "en_US" } }
|
Du kan flette dataene direkte i skjemafeltene ved å bruke følgende metoder:
- Med en bibliotekmal:
Hvis du bruker en bibliotekmal-ID under FileInfo-parameteren, må du sørge for å oppgi nøyaktig feltnavn og tilhørende data under delen nedenfor:
"mergeFieldInfo": [ { "defaultValue": "", "fieldName": "" } ],
|
- Bruk av tekstkoder i et dokument lastet opp som et transient dokument:
Hvis du laster opp et dokument som har tekstkoder lagt til som et transient dokument, må du sørge for å oppgi det nøyaktige feltnavnet og tilhørende data under delen nedenfor:
"mergeFieldInfo": [ { "defaultValue": "", "fieldName": "" } ],
|
Hvordan sender jeg en avtale ved hjelp av API som har forhåndsutfylte verdier for de spesifikke skjemafeltene (mergefield)?
Forutsetningen for dette kallet er å fullføre trinnet "Transient Upload" og få en "transientDocumentId" (med: secure.na1.echosign.com/public/docs/restapi/v5#!/transientDocuments/createTransientDocument) for å bruke her.
- Dette kallet inkluderer "mergeFieldInfo"-delen der standardverdier for spesifikke skjemafelt er gitt.
- Dette forhåndsutfyller dataene fra et annet system i API-kallet.
- Disse feltene i avtalen er enten redigerbare eller skrivebeskyttede.
Forutsetninger:
- Transient dokument-ID
- Feltnavn og tilhørende verdier
Eksempel på forespørselskall:
Forespørsel: POST /api/rest/v5/agreements HTTP/1.1 Host: api.na1.echosign.com (eller du kan angi shard-navn, som du kan finne med kallet getbaseURis: https://secure.na1.echosign.com/public/docs/restapi/v5#!/base_uris/getBaseUris Access-Token: 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 kallet er "agreementId" som du må lagre i systemet ditt for påfølgende kall (signingUrl, status, formData osv.)
Svar: { "agreementId": "3AAABLblqZhCf_7xDcrOgKFwAabp1S-OFfvUdHf2wJsSMwlB95_x_WdUeab67jOkJi1IJzWuSJ0zdNNKugS1blZB4LT5vNVyJ" }
|
Ved kjøring av metoden "post /megaSigns/{megaSignId}/views", vises feilmeldingen "Requested view is not available for the resource in the current state."
Feilen vises hvis den angitte navneparameterverdien er ugyldig i nedenstående forespørselskode:
{
"name": " "
}
Hvis for eksempel MegaSign-avtalen allerede er "IN_PROCESS", vil verdien "AUTHORING" gi nevnte feilmelding. Forsikre deg om at den oppgitte verdien du får er i samsvar med gjeldende status for avtalen.
Ved kjøring av metoden "put /megaSigns/{megaSignId}/state", vises feilmeldingen "No value provided for MegaSign cancellation info."
Feilen skyldes at forespørselskoden mangler parameteren:
"megaSignCancellationInfo": {
"comment": "",
"notifyOthers": false
}
I stedet for å bruke "Minimal Schema", klikker du på "Complete Model Schema" og oppgir hele forespørselskoden for å kjøre API-kallet.
For å endre statusen for MegaSign-avtalen bruker du put /megaSigns/{megaSignId}/state og utfører følgende trinn:
- Gå til REST API-dokumentasjon for V6 og velg metoden
put /megaSigns/{megaSignId}/state. - Oppgi Authorization-verdi samt If-Match og megasignID.
- For å hente megasignID bruker du get /megaSigns
- For å hente If-Match bruker du get /megaSigns/{megaSignId} og lokaliserer "Etag" under Header
- {
"state": "CANCELED",
"megaSignCancellationInfo": {
"comment": "cancel",
"notifyOthers": false
}
}
For å lykkes med å registrere en webhook svarer webhook-URL-en på denne bekreftelsesforespørselen med en 2XX-svarkode, og kan dessuten sende tilbake samme klient-ID-verdi på en av følgende to måter:
- I et svarhode X-AdobeSign-ClientId. Det er det samme hodet som sendes i forespørselen, og blir gjentatt i svaret.
- I JSON-svarteksten med nøkkelen X-AdobeSign-ClientId og tilhørende verdi den samme klient-ID-en som sendes i forespørselen.
Adobe Sign mottar 2xx-svaret med X-AdobeSign-ClientId. Brukeren kan sjekke om det er konfigurert riktig i webhook eller ikke.
Webhook-URLen reagerer ikke i henhold til forventet virkemåte. For hvert innleggsvarsel som Adobe Sign sender, svarer URL med 2XX-statuskode og sender klient-ID sendt i forespørselshoder (X-AdobeSign-ClientId) tilbake i responshodene.
Fullstendig informasjon finnes her:
https://www.adobe.io/apis/documentcloud/sign/docs.html#!adobedocs/adobe-sign/master/webhooks/webhook_events.md
Når URL-en ikke overholder denne protokollen, anser Adobe Sign at forespørselen ikke er anerkjent, og forsøker å planlegge på nytt i henhold til policy.
Hvis webhooken ikke svarer, og enten maksimumstiden før nytt forsøk eller maksimumsintervallet for nye forsøk overskrides, deaktiveres webhooken.
Twitter™- og Facebook-innlegg dekkes ikke under vilkårene for Creative Co
Behandle / få informasjon om avtaler
For å endre dokumentet som allerede er sendt ut for signatur bruker du metoden PUT /agreements/{agreementId} som du kan oppdatere en eksisterende avtale med. Oppgi transient ID sammen med agreement ID i følgende forespørselskode:
{ "documentUpdateInfo": { "fileInfos": [ { "agreementDocumentId": "", "transientDocumentId": "" } ] } }
|
Det følgende er instruksjoner for å oppdatere statusen fra "AUTHORING" til "IN_PROCESS" ved hjelp av Put /agreements/{agreementId}/state:
-
Få agreement-ID hentet ved hjelp av POST /Agreement-metoden.
-
Bruk Get /agreements/{agreementId} for å hente siste ETag.
-
Gå til Put /agreements/{agreementId}/ state og oppgi følgende informasjon: "state": "IN_PROCESS"
Nei.
Det er ingen metode i nåværende REST API for å laste opp en signert kopi.
Avsenderen må laste opp den signerte kopien fra Behandle-siden.
DELETE /agreements/ID brukes til å skjule en avtale fra Behandle-siden.
Adobe har det nye API-et PUT /agreements/ID/me/visibility for å kontrollere synligheten av en avtale (i GET /agreements). I tillegg til funksjonaliteten som tilbys av DELETE /agreements/ID, tillater det nye synlighetsendepunktet også en bruker å reversere "skjul" -operasjonen, det vil si gjøre avtalen synlig igjen.
Du kan også følge de detaljerte trinnene nedenfor:
- Gå til metoden get /agreements og hent agreement ID.
- Klikk på put /agreements/{agreementId}/me/visibility og oppgi forespørselen nedenfor som eksempel:
{
"visibility": "HIDE"
}
Agreement ID er bare skjult fra get /libraryDocuments, den er fremdeles synlig på Behandle-fanen i brukergrensesnittet.
API Retention-funksjonen er ikke aktivert som standard.
For å aktivere operasjonen DELETE/agreements kontakter du kundeansvarlig og ber om at API Retention blir slått på for kontoen.
For mer informasjon om hvordan du aktiverer Retention-funksjoner for kontoen din kan du se Adobe Sign – dokumentoppbevaring.
-
Logg på som Adobe Sign-administrator og gå til: https://secure.adobesign.com/public/docs/restapi/v6
-
- Klikk på agreeements og utvid metoden GET /agreements
- Klikk på knappen OAUTH ACCESS-TOKEN
- Aktiver agreement_read:self-omfanget.
- Klikk på knappen Authorize.
- Hvis du blir utfordret, klikker du på Allow Access (Gi tilgang)
- Klikk på knappen Prøv det!-knapp
-
Svaret genereres.
AgreementID finner du i Response Body:
-
DELETE /agreements/{agreementId}/documents: Sletter alle dokumenter relatert til en avtale. Selve avtalen forblir synlig på siden Behandle.
- Velg DELETE/agreements-operasjonen som skal kjøres.
- Klikk på knappen OAUTH ACCESS-TOKEN og opprett tilgangstoken med omfanget areement_retention.
- Oppgi agreementId for avtalen du vil slette.
- Når avtalen er slettet, er svarteksten uten innhold.
Du får følgende svar hvis DELETE/agreements-operasjonen ikke er aktivert:
"code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED",
"message": "The operation requires some account settings to be enabled. Please contact the Adobe Sign team to enable the settings."
Hvordan laste ned signert dokument sammen med revisjonsrapport og støttedokument gjennom Adobe Sign REST API i stedet for å lage et separat kall for å laste ned revisjonsrapport ved hjelp av følgende metode.
-
Klikk på GET /agreements/{agreementId}/combinedDocument.
-
Klikk på knappen oAuth Access-token.
-
Tilgangstoken genereres automatisk når godkjenningen er akseptert.
-
Oppgi agreementId.
-
Velg true fra rullegardinmenyen under attachSupportingDocuments.
-
Velg true fra rullegardinmenyen under attachAuditReport.
-
Klikk på knappen Prøv det! knappen.
Laster ned den kombinerte PDF-filen med signert, støttedokument og revisjonsrapport.
For å laste ned mange dokumenter er bare dokumenteksportverktøy tilgjengelig, og med API kan du bare laste ned ett og ett dokument. Det følgende er API-metoden for det samme:
https://secure.na1.adobesign.com/public/docs/restapi/v5#!/agreements/getCombinedDocument
Bibliotekmaler og webskjemaer
-
Logg på Adobe Sign som administrator og gå til: https://secure.na1.adobesign.com/public/docs/restapi/v6
-
- Klikk på libraryDocuments og utvid metoden GET /libraryDocuments
- Klikk på knappen OAUTH ACCESS-TOKEN
- Aktiver library_read:self-omfanget.
- Klikk på knappen Authorize.
- Hvis du blir utfordret, klikker du på Allow Access (Gi tilgang)
- Klikk på knappen Prøv det!-knapp
-
Svaret genereres.
libraryDocumentId finner du i Response Body:
- Gå til metoden get /libraryDocuments og hent agreement ID.
- Klikk på put /libraryDocuments/{libraryDocumentId}/me/visibility og oppgi forespørselen nedenfor som eksempel:
{
"visibility": "HIDE"
}
Bibliotek-ID er bare skjult fra get /libraryDocuments, den er fremdeles synlig på Behandle-fanen i brukergrensesnittet.
- Send inn en forespørsel til støtteteamet for å aktivere omfanget for sletting av biblioteket.
- API sletter bibliotekdokumentet. Avtalene som er opprettet ved bruk av dette bibliotekdokumentet, påvirkes imidlertid ikke.
Generere en libraryDocumentID
-
Gå til https://secure.echosign.com/public/docs/restapi/v5.
-
Klikk på libraryDocuments.
-
Klikk på knappen oAuth Access-token.
Authorize Access – Token for Self, Group eller Account.
-
Velg libraryTemplateType - Document eller Form_field_layer.
-
Klikk på Try it out.
Du kan motta et svar som dette for alle malene dine. (Kopier libraryDocumentId for bibliotekmalen du vil slette).
{ "libraryDocumentList": [ { "name": "testing fields", "modifiedDate": "2017-08-04T01:06:05-07:00", "scope": "PERSONAL", "libraryDocumentId": "3AAABLblqZhAK53Dvzq88Q1Ov0TEvMAySDPpIVjF1PWgUpy0H1uYggt4iwGiRSZYlWfl9ms_AcmgZ_uZMPPN2hNT9izwaspHc", "libraryTemplateTypes": [ "DOCUMENT" ] },
Slette bibliotekmaler
-
Kopier libraryDocumentID fra svarteksten.
-
Gå til Delete libraryDocuments.
-
Klikk på knappen oAuth Access-token. Authorize Access – Token for Self, Group eller Account.
-
Lim inn libraryDocumentId i feltet Value.
-
Klikk på Try it out.
Malen slettes.Du får følgende svarkode: 204
Bare webskjemaer med statusen Draft kan oppdateres.
-
Opprett widgeten med post /widgets.
-
Hent widget-ID fra get /widgets.
-
Etter oppretting med metoden GET /widgets/{widgetId}, henter du Etag fra svarhodet.
-
Bruk Etag fra GET /widgets/{widgetId} under put /widgets/{widgetId}. Oppgi widgetId og widgetInfo under parameteren If-Match.
{ "fileInfos": [ { "transientDocumentId": "******" } ], "name": "Widht_Name", "status": "DRAFT", "widgetParticipantSetInfo": { "memberInfos": [ { "email": "" } ], "role": "SIGNER" } }
-
Brukseksempler
-
Foreta et get/agreements-kall med riktig x-api-user.
-
I svarteksten finner du signaturavtalen du vil finne signerings-url for, og noterer agreement ID
-
Foreta et get/agreements/{agreementId}/signingUrls-kall med agreement ID du mottok fra kallet get/agreements.
Resultat
Utdataene returnerer e-postadressen til undertegneren/undertegnerne og URL-en for e-signering.