Adobe Acrobat Sign-API – Häufig gestellte Fragen

1. Melde dich bei Acrobat Sign an.
2. Navigiere zu Konto > Acrobat Sign-API > REST-API-Dokumentation.
3. Wähle Version 5 aus.
4. Verwende unter der Methode POST /users den Anfragecode im Abschnitt
   UserCreationInfo method
   {
   "email": "email@email.com",
   "firstName": "AA",
   "lastName": "AB",
   "password":"12******rte"
   } }

Acrobat Sign-Konten, bei denen die Benutzerberechtigung über die Admin-Konsole (Adobe One) verwaltet wird, können die Acrobat Sign-API nicht verwenden, um Benutzer zu erstellen oder bestehende Benutzer zu verwalten.

Die Admin-Konsole Adobe One verwendet eine andere API als die Acrobat Sign-API. Weitere Informationen findest du in diesen Artikeln:

• https://helpx.adobe.com/de/enterprise/using/users.html
• https://developer.adobe.com/umapi/

Gruppen-ID abrufen:

Gruppe löschen:

Temporäres Dokument generieren

Vereinbarung mithilfe des temporären Dokuments generieren

Im Folgenden sind die Schritte zum Hinzufügen von Dateien in den Parameter FileInfo aufgeführt.

Du kannst im Aufruf POST /agreements für den signatureflow-Parameter den Wert SENDER_SIGNIERT_ZUERST oder SENDER_SIGNIERT_ZULETZT übergeben, um den Absender als ersten bzw. letzten Unterzeichner hinzuzufügen.

Es folgt ein Beispiel für diesen Aufruf im JSON-Format:

{

  "documentCreationInfo": {

    "fileInfos": [

      {        "transientDocumentId":"3AAABLblqZ-HierIDeinfügen"

      }

    ],

    "name": "Test",

    "recipientSetInfos": [

      {

        "recipientSetMemberInfos": [

          {

            "email": "test@email.com"

          }

        ],

        "recipientSetRole": "UNTERZEICHNER"

      }

    ],

    "signatureType": "E-SIGNATUR",

    "signatureFlow": "SENDER_SIGNS_FIRST"

  }

}

Aktiviere für die Funktion „Senden im Namen von“ die Option „Erweiterte Kontofreigabe“ für das Konto, sodass Benutzer anderen Benutzern die Berechtigung zum Senden erteilen können, wenn sie ihr Konto freigeben. Informationen zur erweiterten Freigabe findest du unter Aktivieren der erweiterten Kontofreigabe.

Führe die folgenden Schritte aus, sobald die Benutzendenfreigabe aktiviert ist, um im Namen einer anderen Person zu senden:

Temporäres Dokument generieren:

Vereinbarung mithilfe des temporären Dokuments generieren:

Folgende Parameter können im Code übergeben werden, um ein Kennwort zum Öffnen festzulegen:

Führe die folgenden Schritte aus, um eine Vereinbarung mit dem Status AUTHORING über die API zu erstellen:

Gehe zu POST /agreements und erstelle ein Zugriffstoken mit den erforderlichen Geltungsbereichen.

Verwende den folgenden Anfragecode:

Die Version 6 verfügt über eine Reihe von Authoring-APIs zur Erstellung einer Vereinbarung. In Version 5 werden die Formularfelder direkt in der API POST /agreements verbraucht. In Version 6 kann der Benutzer jedoch eine Vereinbarung im AUTHORING-Status (state = AUTHORING) über v6 POST /agreements erstellen und zu einem späteren Zeitpunkt PUT /agreements/ID/formFields verwenden, um den Dokumenten dieser Vereinbarung Formularfelder hinzuzufügen.

Im Folgenden sind die Schritte aufgeführt:

Verwende POST /agreements, um eine Vereinbarung zu erstellen. Sendet sie zur Unterschrift und gibt die agreementID in der Antwort an den Kunden zurück. Im Folgenden findest du das JSON-Format zum Senden einer Vereinbarung mithilfe der Telefonauthentifizierungsmethode.

Mithilfe der folgenden Methoden kannst du Daten direkt in Formularfeldern zusammenführen.

• Verwenden einer Bibliotheksvorlage:
  
  Wenn du die ID einer Bibliotheksvorlage unter dem FileInfo-Parameter verwendest, stelle sicher, dass der genaue Feldname und die dazugehörigen Daten unter dem folgenden Abschnitt angegeben werden.

• Verwenden von Text-Tags in einem temporären Dokument:
  
  Wenn du ein Dokument mit Text-Tags als temporäres Dokument hochlädst, stelle sicher, dass der genaue Feldname und die dazugehörigen Daten unter dem folgenden Abschnitt angegeben werden. 

Wie kann eine Vereinbarung über die API gesendet werden, die vorab ausgefüllte Werte für die spezifischen Formularfelder (mergefield) enthält?

Voraussetzung für diesen Aufruf ist das vollständige Hochladen eines temporären Dokuments und die Ermittlung der transientDocumentId (mit: secure.na1.echosign.com/public/docs/restapi/v5#!/transientDocuments/createTransientDocument), die hier verwendet werden soll.

• Dieser Aufruf enthält den Abschnitt mergeFieldInfo, in dem Standardwerte für bestimmte Formularfelder angegeben werden.
• Dadurch werden die Daten aus einem anderen System im API-Aufruf vorab ausgefüllt.
• Diese Felder in der Vereinbarung sind entweder bearbeitbar oder schreibgeschützt.

Voraussetzungen:

1. Temporäre Dokument-ID
2. Feldnamen und deren Werte

Beispiel für einen Anruf:

Beim Ausführen der Methode post /megaSigns/{megaSignId}/views wird der Fehler „Angeforderte Ansicht ist für die Ressource im aktuellen Status nicht verfügbar.“

Der Fehler wird angezeigt, wenn der Wert für den Namensparameter im folgenden Anfragecode ungültig ist:

{
  "name": " "
}

Beispiel: Wenn sich eine MegaSign-Vereinbarung im Status WIRD_VERARBEITET befindet, wird bei Angabe des Werts AUTHORING ein Fehler ausgegeben. Stelle sicher, dass der angegebene Wert dem aktuellen Status der Vereinbarung entspricht.

Beim Ausführen der Methode put /megaSigns/{megaSignId}/state wird der Fehler „Es wurde kein Wert für die MegaSign-Abbruch-Info angegeben.“

Dieser Fehler wird ausgelöst, wenn dem Anfragecode folgender Parameter fehlt: 

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

Verwende anstelle von „Minimales Schema“ die Option „Vollständiges Modellschema“ und gib den vollständigen Anfragecode an, um den API-Aufruf auszuführen. 

Um den Status der MegaSign-Vereinbarung zu ändern, verwende PUT /megaSigns/{megaSignId}/status und führe die folgenden Schritte aus:

1. Öffne die REST-API-Dokumentation für Version 6 und wähle die Methode
   PUT /megaSigns/{megaSignId}/state.
2. Gib den Autorisierungswert sowie If-Match und megasignID an.
   • Um megasignID abzurufen, verwende GET /megaSigns.
   • Um If-Match abzurufen, verwende GET /megaSigns/{megaSignId} und suche unter der Kopfzeile nach "Etag“
3. {
     "state": "CANCELED",
     "megaSignCancellationInfo": {
      "comment": "cancel",
      "notifyOthers": false
     }
   } 

Bei der erfolgreichen Registrierung eines Webhooks reagiert die Webhook-URL auf diese Überprüfungsanfrage mit einem 2XX-Antwortcode. Zusätzlich kann der gleiche Client-ID-Wert auf eine der folgenden Weisen zurückgesendet werden:

1. in einer Antwortkopfzeile X-AdobeSign-ClientId. Dies ist die gleiche Kopfzeile, die in der Anfrage übergeben wurde und in der Antwort als Echo ausgegeben wird.
2. Im JSON-Antwortkörper mit dem Schlüssel X-AdobeSign-ClientId und einer Client-ID, die dem Wert in der Anfrage entspricht.

Acrobat Sign empfängt die 2XX-Antwort mit X-AdobeSign-ClientId. Benutzende können prüfen, ob die Konfiguration im Webhook richtig ist.

Die Webhook-URL reagiert nicht wie erwartet. Für jede POST-Benachrichtigung, die Acrobat Sign gesendet hat, antwortet die URL mit dem Statuscode 2XX und die Client-ID, die in Anfragekopfzeilen (X-AdobeSign-ClientId) gesendet wurde, wird in den Antwortkopfzeilen wieder ausgegeben. 

Vollständige Informationen findest du unter dem folgenden Link:
https://developer.adobe.com/acrobat-sign/docs/overview/developer_guide/#!adobedocs/adobe-sign/master/webhooks/webhook_events.md

Wenn die URL dieses Protokoll nicht befolgt, geht Acrobat Sign davon aus, dass die Anfrage nicht bestätigt wurde, und versucht es gemäß der geltenden Richtlinie erneut.

Wenn der Webhook nicht reagiert und entweder die maximale Wiederholungszeit oder das maximale Wiederholungsintervall überschritten wird, wird der Webhook deaktiviert.

  Twitter™ und Facebook-Beiträge werden von den Bedingungen von Creative Co nicht abgedeckt.

Um das bereits zur Unterschrift gesendete Dokument zu ändern, verwende die Methode PUT /agreements/{agreementId}, mit der du eine vorhandene Vereinbarung aktualisieren kannst. Gib die ID des temporären Dokuments zusammen mit der ID der Vereinbarung im folgenden Anfragecode an:

Im Folgenden findest du die Anweisungen zum Aktualisieren des Status von AUTHORING auf WIRD_VERARBEITET mit PUT /agreements/{agreementId}/state:

Nein.

In der aktuellen REST-API gibt es keine Methode zum Hochladen einer signierten Kopie.

Der Absender muss die signierte Kopie von der Seite Verwalten hochladen.

DELETE /Agreements/ID, wird verwendet, damit eine Vereinbarung auf der Seite „Verwalten“ ausgeblendet werden kann.

Adobe verfügt über eine neue API PUT /Agreements/ID/me/visibility , um die Sichtbarkeit einer Vereinbarung auf der Seite „Verwalten“ zu steuern (in GET /Agreements). Zusätzlich zu den Funktionen von DELETE /agreements/ID ermöglicht der neue Sichtbarkeitsendpunkt dem Benutzer auch, den Vorgang „Ausblenden“ rückgängig zu machen, d. h. die Vereinbarung wieder einzublenden. 

Führe die folgenden Schritte aus:

1. Wähle die Methode GET /agreements aus und rufe die Vereinbarungs-ID ab.
2. Klicke auf PUT /agreements/{agreementId}/me/visibility und gib die folgende Anfrage als Beispiel an:
   {
     "visibility": "HIDE"
   }
   Die Vereinbarungs-ID wird nur in GET /libraryDocuments ausgeblendet. Sie ist weiterhin auf der Registerkarte „Verwalten“ der Benutzeroberfläche sichtbar.

Du erhältst die folgende Antwort, wenn DELETE /agreements nicht aktiviert ist:

 "code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED",

  "message": „Für den Vorgang müssen einige Kontoeinstellungen aktiviert sein. Wende dich an das Acrobat Sign-Team, um die Einstellungen zu aktivieren.“

Mit der folgenden Methode kannst du ein signiertes Dokument zusammen mit einem Audit-Bericht und einem Begleitdokument über die Acrobat Sign REST API herunterladen, anstatt einen separaten Aufruf zum Herunterladen des Audit-Berichts durchzuführen.

GET /agreements/{agreementId}/auditTrail

Zum Herunterladen von Dokumenten in großen Mengen steht nur das Tool für den Dokumentexport zur Verfügung. Mit der API kannst du Dokumente nur einzeln herunterladen. Die folgende API-Methode ist dafür anzuwenden:

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

Adobe verfügt über die neue API PUT /libraryDocuments/ID/me/Visibility, um die Sichtbarkeit einer Vereinbarung (in GET /agreements) zu steuern. Zusätzlich zu den Funktionen von DELETE /agreements/ID ermöglicht der neue Sichtbarkeitsendpunkt Benutzenden auch, den Vorgang „Ausblenden“ rückgängig zu machen, d. h. die Vereinbarung wieder einzublenden.

Du kannst den unten stehenden detaillierten Schritten folgen:

1. Wähle die Methode GET /libraryDocuments aus und rufe die Vereinbarungs-ID ab.
2. Klicke auf PUT /libraryDocuments/{libraryDocumentId}/me/visibility und gib die folgende Anfrage als Beispiel an:
   {
     "visibility": "HIDE"
   }
   Die Bibliotheks-ID wird nur in GET /libraryDocuments ausgeblendet. Sie ist aber weiterhin auf der Registerkarte „Verwalten“ der Benutzeroberfläche sichtbar.

LibraryDocumentID generieren

Bibliotheksvorlagen löschen