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

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

Acrobat Sign-konton som använder Admin Console (Adobe One) för att hantera sina användarbehörigheter kan inte använda Acrobat Sign API för att skapa användare eller hantera befintliga användare.

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

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

Hämtar grupp-ID:

Tar bort grupp:

Generera ett övergående dokument

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

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

I POST /agreements-anropet kan du för parameter signatureflow skicka värdet SENDER_SIGNS_FIRST eller SENDER_SIGNS_LAST för att lägga till avsändaren som första eller sista signerare.

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

{

  "documentCreationInfo": {

    "fileInfos": [

      {        "transientDocumentId":"3AAABLblqZ-yourIDGoesHere"

      }

    ],

    "name": "Test",

    "recipientSetInfos": [

      {

        "recipientSetMemberInfos": [

          {

            "email": "test@email.com"

          }

        ],

        "recipientSetRole": "SIGNER"

      }

    ],

    "signatureType": "ESIGN",

    "signatureFlow": "SENDER_SIGNS_FIRST"

  }

}

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

När användardelning är aktiverad följer du dessa steg för att skicka för någon annans räkning:

Generera ett övergående dokument:

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

Följande är de parametrar som du kan skicka i koden för att ställa in öppningslösenord:

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

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

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

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

Så här gör du:

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

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

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

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

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

Förutsättningen för detta anrop är att först slutföra steget "Transient Upload" och få ett "transientDocumentId" (med: secure.na1.echosign.com/public/docs/restapi/v5#!/transientDocuments/createTransientDocument) att använda här.

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

Krav:

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

Exempelanrop:

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

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

{
  "name": " "
}

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

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

Felet orsakas av att begärandekoden saknar parametern:

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

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

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

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

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

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

Acrobat Sign tar emot 2xx-svaret med X-AdobeSign-ClientId. Användaren kan kontrollera om det är korrekt konfigurerat i webhook eller inte.

Webbhook-URL:en svarar inte enligt det förväntade beteendet. För varje Post-avisering som Acrobat Sign skickar svarar URL:en med 2XX-statuskod och skickar tillbaka klient-ID:t som skickades i begäranshuvudena (X-AdobeSign-ClientId) i svarshuvudena. 

För fullständig information, se följande länk:
https://developer.adobe.com/acrobat-sign/docs/overview/developer_guide/#!adobedocs/adobe-sign/master/webhooks/webhook_events.md

När URL:en inte följer detta protokoll anser Acrobat Sign att den inte bekräftade begäran och försöker schemalägga om enligt den tillförlitliga policyn.

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

  Inlägg från Twitter™ och Facebook omfattas inte av villkoren i Creative Co

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

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

Nej.

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

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

DELETE /agreements/ID användes för att tillåta att dölja ett avtal från hanteringssidan.

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

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

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

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

 "code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED",

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

Hur laddar du ned signerat dokument tillsammans med granskningsrapport och stödjande dokument via Acrobat Sign REST API istället för att göra ett separat anrop för att ladda ned granskningsrapporten med följande metod.

GET /agreements/{agreementId}/auditTrail

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

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

Adobe har ett nytt API PUT/libraryDocuments/ID/me/visibility som styr synligheten för ett avtal (i GET /agreements). Utöver den funktion som tillhandahålls av DELETE /agreements/ID, tillåter den nya synlighetsslutpunkten också en användare att återställa "dölja"-operationen, det vill säga göra avtalet synligt igen.

Du kan följa de detaljerade stegen nedan:

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

Generera ett libraryDocumentID

Ta bort biblioteksmallar