Adobe Acrobat Sign API – ofte stillede spørgsmål

1. Log på Acrobat Sign.
2. Gå til Acrobat Sign API > REST API-dokumentation.
3. Vælg Version 5.
4. 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 Acrobat Sign API’en til at oprette brugere eller administrere eksisterende brugere.

Adobe One Admin Console bruger en anden API end Acrobat Sign API’en. Se disse artikler for mere information:

• https://helpx.adobe.com/dk/enterprise/help/users.html
• https://developer.adobe.com/umapi/

Hentning af gruppe-id:

Sletning af gruppe:

Generering af et kortvarigt dokument

Oprettelse af en aftale ved hjælp af det kortvarige dokument

Følgende er trinnene til at tilføje filer i FileInfo Parameter:

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

  }

}

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 se 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:

Generering af en aftale ved hjælp af det kortvarige dokument:

Følgende er de parametre, du kan angive i koden for at indstille åben adgangskode.

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:

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:

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.

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:

• 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: 

Hvordan sendes en aftale ved hjælp af API, der har forudfyldte værdier for de specifikke formularfelter (mergefield)?

Forudsætning for dette kald er først at gennemføre trinnet "Transient Upload" og få et "transientDocumentId" (ved brug af: secure.na1.echosign.com/public/docs/restapi/v5#!/transientDocuments/createTransientDocument), som 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:

1. Kortvarigt dokument-id
2. Feltnavne og deres værdier

Eksempel på anmodning om kald:

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:

1. Gå til REST API-dokumentationen for V6, og vælg metoden  
   put /megaSigns/{megaSignId}/state.
2. 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
3. {
     "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:

1. I en svaroverskrift X-AdobeSign-ClientId. Det er den samme overskrift, der sendes i anmodningen og gentages i svaret.
2. 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.

Acrobat Sign modtager 2xx-svaret med X-AdobeSign-ClientId. Brugeren kan tjekke, 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 Acrobat Sign sendte, svarer URL med 2XX-statuskode og gengælder det klient-id, der blev sendt i anmodningsoverskrifter (X-AdobeSign-ClientId) tilbage i svarets header. 

Få de fulde oplysninger via dette link:
https://developer.adobe.com/acrobat-sign/docs/overview/developer_guide/#!adobedocs/adobe-sign/master/webhooks/webhook_events.md

Når URL'en ikke overholder denne protokol, tager Acrobat Sign højde for, at den ikke har bekræftet anmodningen og forsøgt at rykke den 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

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:

Følgende er instruktionerne til at opdatere tilstanden fra "AUTHORING" til "IN_PROCESS" ved hjælp af Put /agreements/{agreementId}/state:

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/I brugt til at tillade at skjule en aftale fra siden Administrer

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:

1. Gå til metoden get /agreements, og hent aftale-id'et.
2. 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.

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 Acrobat Sign-teamet for at aktivere indstillingerne."

Sådan downloades det underskrevne dokument sammen med revisionsrapport og supplerende dokumenter med Acrobat Sign REST API, i stedet for at man foretager et separat kald for at downloade revisionsrapporten med følgende metode.

GET /agreements/{agreementId}/auditTrail

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

Adobe har en ny API PUT/libraryDocuments/ID/me/visibility til at styre synligheden af en aftale (i GET /agreements). Ud over funktionaliteten leveret af DELETE /agreements/ID, giver det nye synlighedsslutpunkt også brugere mulighed for at fortryde "skjul"-handlingen, dvs. at gøre aftalen synlig igen

Du kan følge de detaljerede trin som angivet nedenunder:

1. Gå til metoden get /libraryDocuments, og hent aftale-id’et.
2. 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.

Generering af et libraryDocumentID

Sletning af biblioteksskabeloner