Benutzerhandbuch Abbrechen

Adobe Acrobat Sign-API – Häufig gestellte Fragen

 

Adobe Acrobat Sign-Handbuch

Neue Funktionen

  1. Vorabversionshinweise
  2. Versionshinweise
  3. Wichtige Benachrichtigungen

Erste Schritte

  1. Kurzanleitung für Administrierende
  2. Kurzanleitung für Benutzende
  3. Für Entwicklerinnen und Entwickler
  4. Video-Tutorial-Bibliothek
  5. Häufig gestellte Fragen

Verwaltung

  1. Übersicht über die Admin Console
  2. Benutzendenverwaltung
    1. Benutzer hinzufügen
      1. Benutzende hinzufügen
      2. Hinzufügen von mehreren Benutzenden
      3. Hinzufügen von Benutzenden aus deinem Verzeichnis
      4. Hinzufügen von Benutzenden aus MS Azure Active Directory
    2. Erstellen von funktionsorientierten Benutzenden
      1. Technikkonten – API-gesteuert
      2. Dienstkonten – Manuell gesteuert
    3. Suche nach Nutzenden mit Bereitstellungsfehlern
    4. Ändern des Namens/der E-Mail-Adresse
    5. Gruppenmitgliedschaft von Benutzenden bearbeiten
    6. Bearbeiten der Gruppenmitgliedschaft von Benutzenden über die Gruppenoberfläche
    7. Hochstufen von Benutzenden zu einer Administrationsrolle
    8. Benutzeridentitätstypen und SSO
    9. Wechseln der Benutzeridentität
    10. Authentifizieren von Benutzenden mit MS Azure
    11. Authentifizieren von Benutzenden mit Google Federation
    12. Produktprofile
    13. Anmeldung 
  3. Konto-/Gruppeneinstellungen
    1. Einstellungsübersicht
    2. Globale Einstellungen
      1. Kontoebene und ID
      2. Neues Empfangserlebnis
      3. Workflows zum Selbstsignieren
      4. Massenversand
      5. Webformulare
      6. Benutzerdefinierte Sende-Workflows
      7. Power Automate-Workflows
      8. Bibliotheksdokumente
      9. Formulardaten mit Vereinbarungen erfassen
      10. Eingeschränkte Dokumentsichtbarkeit
      11. Anhängen einer PDF-Kopie der signierten Vereinbarung 
      12. Einfügen eines Links in eine E-Mail
      13. Einfügen eines Bilds in eine E-Mail
      14. An E-Mails angehängte Dateien werden folgendermaßen benannt:
      15. Anhängen von Audit-Berichten an Dokumente
      16. Zusammenführen mehrerer Dokumente zu einem Dokument
      17. Einzelne Dokumente herunterladen
      18. Signiertes Dokument hochladen
      19. Delegation für Benutzende in meinem Konto
      20. Externen Empfangenden das Delegieren erlauben
      21. Signaturberechtigung
      22. Sendeberechtigung
      23. Berechtigung zum Hinzufügen elektronischer Siegel
      24. Festlegen einer Standardzeitzone
      25. Festlegen eines Standarddatumsformats
      26. Benutzende in mehreren Gruppen (UMG)
        1. Upgrade zur Verwendung von UMG
      27. Berechtigungen für Gruppenadministrierende
      28. Empfangende ersetzen
      29. Audit-Bericht
        1. Überblick
        2. Nicht authentifizierten Zugriff auf der Transaktionsbestätigungsseite zulassen
        3. Aufnehmen von Erinnerungen
        4. Aufnehmen von Anzeigeereignissen
        5. Aufnehmen der Seiten-/Anhangsanzahl der Vereinbarung
      30. In Produktbotschaften und Anleitungen
      31. Barrierefreie PDF-Dateien
      32. Neues Authoring-Erlebnis
      33. Kundinnen und Kunden im Gesundheitswesen
    3. Kontoeinrichtung
      1. Logo hinzufügen
      2. Anpassen des Hostnamens/der URL des Unternehmens
      3. Firmenname hinzufügen
      4. URL-Umleitung nach Abschluss der Vereinbarung
    4. Signaturvorgaben
      1. Korrekt formatierte Signaturen
      2. Empfangenden das Signieren erlauben durch
      3. Unterzeichnende können ihren Namen ändern
      4. Empfangenden erlauben, ihre gespeicherte Signatur zu verwenden
      5. Selbstdefinierte Nutzungsbedingungen und Hinweis für Kundinnen und Kunden
      6. Empfangende durch Formularfelder leiten
      7. Signieren ablehnen
      8. Stempel-Workflows erlauben
      9. Unterzeichnende auffordern, ihre Stellenbezeichnung oder ihr Unternehmen anzugeben
      10. Unterzeichnenden das Drucken und Einfügen von handschriftlichen Signaturen erlauben
      11. Anzeigen von Nachrichten beim elektronischen Signieren
      12. Unterzeichnende müssen ein Mobilgerät verwenden, um ihre Signatur zu erstellen
      13. IP-Adresse von Unterzeichnenden anfordern
      14. Firmenname und Stellenbezeichnung sollen nicht aus dem Teilnahmestempel ersichtlich sein
    5. Digitale Signaturen
      1. Überblick
      2. Herunterladen und Signieren mit Acrobat
      3. Signieren mit Cloud-Signaturen
      4. Metadaten für Identitätsanbieter einschließen
      5. Anbieter eingeschränkter Cloud-Signaturen
    6. Elektronische Siegel
    7. Digital Identity
      1. Digital Identity Gateway
      2. Richtlinie zu Identitätsprüfung
    8. Berichteinstellungen
      1. Neues Berichtserlebnis
      2. Einstellungen für den klassischen Bericht
    9. Sicherheitseinstellungen
      1. Einstellungen für Single Sign-on
      2. Einstellungen zum Merken der Anmeldedaten
      3. Richtlinien für Anmeldekennwort
      4. Stärke für Anmeldekennwort
      5. Dauer der Internet-Sitzung
      6. Art der PDF-Verschlüsselung
      7. API
      8. Zugriff auf Benutzenden- und Gruppeninformationen
      9. Erlaubte IP-Bereiche
      10. Kontofreigabe
      11. Berechtigungen zur Kontofreigabe
      12. Steuerelemente für das Freigeben von Vereinbarungen
      13. Bestätigung der Unterzeichnendenidentität
      14. Kennwort für das Signieren einer Vereinbarung
      15. Dokumentkennwortstärke
      16. Unterzeichnende anhand des geografischen Standorts sperren
      17. Telefonauthentifizierung
      18. Wissensbasierte Authentifizierung (KBA)
      19. Zulassen der Seitenextraktion
      20. Ablauf des Dokumentlinks
      21. Hochladen eines Clientzertifikats für Webhooks/Rückrufe
      22. Zeitstempel
    10. Sendeeinstellungen
      1. Anzeigen der Seite „Senden“ nach der Anmeldung
      2. Name der Empfangspartei beim Senden erforderlich
      3. Sperren der Namenswerte für bekannte Benutzende
      4. Zulässige Empfangsrollen
      5. E-Witnesses zulassen
      6. Gruppen empfangender Personen
      7. Erforderliche Felder
      8. Anhängen von Dokumenten
      9. Feldreduzierung
      10. Vereinbarungen bearbeiten
      11. Vereinbarungsname
      12. Sprachen
      13. Private Nachrichten
      14. Erlaubte Signaturarten
      15. Erinnerungen
      16. Kennwortschutz für signierte Dokumente
      17. Vereinbarungsbenachrichtigung absenden
      18. Identifikationsoptionen für Unterzeichnende
        1. Überblick
        2. Signierkennwort
        3. Einmalpasswort per E-Mail
        4. Acrobat Sign-Authentifizierung
        5. Telefonauthentifizierung
        6. Cloud-basierte digitale Signatur
        7. Wissensbasierte Authentifizierung
        8. Amtl. Lichtbildausweis
        9. Identitätsberichte der Unterzeichnenden
      19. Inhaltsschutz
      20. Aktivieren von Beglaubigungs-Transaktionen
      21. Dokumentablauf
      22. Anzeigen der Vorschau, Positionieren von Signaturen und Hinzufügen von Formularfeldern
      23. Signierreihenfolge
      24. Liquid Mode
      25. Optionen für selbstdefinierte Workflows
      26. Upload-Optionen auf der E-Sign-Seite
      27. Bestätigungs-URL-Umleitung nach der Signatur
    11. Nachrichtenvorlagen
    12. Bio-Pharma-Einstellungen
      1. Überblick
      2. Authentifizierung der Identität verlangen
      3. Gründe für das Unterzeichnen
    13. Workflow-Integration
    14. Beglaubigungs-Einstellungen
    15. Zahlungsintegration
    16. Nachrichten für Unterzeichnende
    17. SAML-Einstellungen
      1. SAML-Konfiguration
      2. Installieren des Active Directory Federation Service
      3. Installieren von Okta
      4. Installieren von OneLogin
      5. Installieren von Oracle Identity Federation
    18. Datennutzungsrechte
    19. Zeitstempel-Einstellungen
    20. Externes Archiv
    21. Kontosprachen
    22. E-Mail-Einstellungen
      1. Bilder für E-Mail-Kopf- oder Fußzeile
      2. Zulassen von E-Mail-Fußzeilen für einzelne Benutzende
      3. Anpassen der „Signatur angefordert“-E-Mail
      4. Anpassen der Felder „An“ und „CC“
      5. Benachrichtigungen ohne Links aktivieren
      6. E-Mail-Vorlagen anpassen
    23. Migration von echosign.com zu adobesign.com
    24. Konfigurieren von Optionen für Empfangende
  4. Leitfaden für regulatorische Anforderungen
    1. Barrierefreiheit
      1. Einhaltung der Barrierefreiheitsrichtlinien
      2. Erstellen barrierefreier Formulare mit Acrobat für den Desktop
      3. Erstellen barrierefreier AcroForms
    2. HIPAA
    3. DSGVO
      1. Überblick über die DSGVO
      2. Benutzende schwärzen
      3. Vereinbarungen Benutzender schwärzen
    4. 21 CFR Part 11 und EudraLex Annex 11
      1. 21 CRF Part 11 Validierungspaket
      2. Handbuch für 21 CFR und EudraLex Annex 11
      3. Analyse der gemeinsamen Verantwortung
    5. Kundinnen und Kunden im Gesundheitswesen
    6. IVES-Unterstützung
    7. Archivieren von Vereinbarungen
    8. Überlegungen zur EU/dem Vereinigten Königreich
      1. Grenzüberschreitende Transaktionen zwischen der EU und dem Vereinigten Königreich und eIDAS
      2. HMLR-Anforderungen für elektronisch signierte Urkunden
      3. Die Auswirkungen des Brexit auf die Gesetze zu elektronischen Signaturen im Vereinigten Königreich
  5. Gleichzeitiges Herunterladen von mehreren Vereinbarungen
  6. Anfordern deiner Domäne 
  7. Links „Missbrauch melden“

Senden, Signieren und Verwalten von Vereinbarungen

  1. Empfangsoptionen
    1. Stornieren von E-Mail-Erinnerungen
    2. Optionen auf der E-Signatur-Seite
      1. Überblick über die E-Signatur-Seite
      2. Öffnen der Vereinbarung, um sie ohne Felder zu lesen
      3. Signieren einer Vereinbarung ablehnen
      4. Delegieren der Signaturberechtigung
      5. Neustarten der Vereinbarung
      6. Herunterladen einer PDF-Datei der Vereinbarung
      7. Anzeigen des Vereinbarungsverlaufs
      8. Anzeigen der Vereinbarungsnachrichten
      9. Umwandlung von elektronischer zu handschriftlicher Signatur
      10. Umwandlung von handschriftlicher zu elektronischer Signatur 
      11. Navigation der Formularfelder
      12. Löschen der Daten aus den Formularfeldern
      13. Seitenvergrößerung und Navigation der E-Signatur-Seite
      14. Ändern der in den Vereinbarungswerkzeugen und -informationen verwendeten Sprache
      15. Rechtliche Hinweise lesen
      16. Anpassen der Acrobat Sign-Cookie-Voreinstellungen
  2. Vereinbarungen senden  
    1. Übersicht der Seite „Senden“
    2. Senden einer Vereinbarung nur an sich selbst
    3. Senden einer Vereinbarung an andere
    4. Handschriftliche Signaturen
    5. Signierreihenfolge der Empfangenden
    6. Massenversand
      1. Überblick über die Massenversand-Funktion
      2. Massenversand – übergeordnete Vorlage konfigurieren
      3. Massenversand – CSV-Datei konfigurieren
      4. Massenversand-Transaktion abbrechen
      5. Erinnerungen zum Massenversand hinzufügen
      6. Berichterstattung für den Massenversand
  3. Erstellen von Feldern in Dokumenten
    1. In-App-Authoring-Umgebung
      1. Automatische Felderkennung
      2. Ziehen und Ablegen von Feldern in der Authoring-Umgebung
      3. Formularfelder zu Empfangenden zuweisen
      4. Die Rolle „Vorausfüllen“
      5. Anwenden von Feldern mit einer wiederverwendbaren Feldvorlage
      6. Felder in eine neue Bibliotheksvorlage übertragen
      7. Aktualisierte Authoring-Umgebung beim Senden von Vereinbarungen
    2. Erstellen von Formularen mit Text-Tags
    3. Erstellen von Formularen mit Acrobat (AcroForms)
      1. AcroForm-Erstellung
      2. Barrierefreie PDF-Dokumente erstellen
    4. Felder
      1. Feldtypen
        1. Häufige Feldtypen
        2. Inline-Bilder
        3. Stempelbilder
      2. Erscheinungsbild des Feldinhalts
      3. Feldüberprüfungen
      4. Werte für maskierte Felder
      5. Festlegen von Bedingungen für das Ein-/Ausblenden
      6. Berechnete Felder
    5. Authoring-FAQ
  4. Signieren von Vereinbarungen
    1. Signieren von an sich selbst gesendeten Vereinbarungen
    2. Ausfüllen & Signieren
    3. Selbstsignieren
  5. Vereinbarungen verwalten
    1. Übersicht über die Seite „Verwalten“
    2. Delegieren von Vereinbarungen
    3. Ersetzen von Empfangenden
    4. Eingeschränkte Dokumentsichtbarkeit 
    5. Abbrechen einer Vereinbarung
    6. Erstellen von neuen Erinnerungen
    7. Überprüfen von Erinnerungen
    8. Stornieren von Erinnerungen
    9. Zugriff auf Power Automate-Flows
    10. Weitere Aktionen...
      1. Funktionsweise der Suche
      2. Anzeigen einer Vereinbarung
      3. Vorlage aus einer Vereinbarung erstellen
      4. Aus-/Einblenden von Vereinbarungen
      5. Hochladen einer signierten Vereinbarung
      6. Ändern von Dateien und Feldern einer gesendeten Vereinbarung
      7. Bearbeiten der Authentifizierungsmethode einer Empfangspartei
      8. Hinzufügen oder Ändern eines Ablaufdatums
      9. Hinzufügen einer Notiz zu einer Vereinbarung
      10. Freigabe einer einzelnen Vereinbarung
      11. Aufheben der Freigabe einer Vereinbarung
      12. Herunterladen einer einzelnen Vereinbarung
      13. Herunterladen einzelner Dateien einer Vereinbarung
      14. Herunterladen des Audit-Berichts einer Vereinbarung
      15. Herunterladen des Feldinhalts einer Vereinbarung
  6. Audit-Bericht
  7. Berichte und Datenexporte
    1. Überblick
    2. Zugriffserteilung auf Berichte für Benutzende
    3. Berichtsdiagramme
      1. Erstellen eines neuen Berichts
      2. Vereinbarungsberichte
      3. Transaktionsberichte
      4. Einstellungsaktivitätsbericht
      5. Bearbeiten eines Berichts
    4. Datenexporte 
      1. Erstellen eines neuen Datenexports
      2. Bearbeiten eines Datenexports
      3. Aktualisieren des Datenexportinhalts
      4. Herunterladen des Datenexports
    5. Umbenennen eines Berichts/Exports
    6. Duplizieren eines Berichts/Exports
    7. Planen eines Berichts/Exports
    8. Löschen eines Berichts/Exports
    9. Überprüfen des Transaktionsverbrauchs

Erweiterte Vereinbarungsfunktionen und Workflows

  1. Webformulare 
    1. Erstellen eines Webformulars
    2. Bearbeiten eines Webformulars
    3. Deaktivieren/Aktivieren eines Webformulars
    4. Ein-/Ausblenden eines Webformulars
    5. Abrufen der URL oder des Skriptcodes 
    6. Vorausfüllen von Webformularfeldern mithilfe von URL-Parametern
    7. Speichern eines Webformulars, um es später auszufüllen
    8. Ändern der Größe eines Webformulars
  2. Wiederverwendbare Vorlagen (Bibliotheksvorlagen) 
    1. US-Behördenformulare in der Acrobat Sign-Bibliothek
    2. Erstellen einer Bibliotheksvorlage
    3. Ändern des Namens einer Bibliotheksvorlage
    4. Ändern des Typs einer Bibliotheksvorlage
    5. Ändern der Berechtigungsebene einer Bibliotheksvorlage
    6. Kopieren, Bearbeiten und Speichern einer freigegebenen Vorlage
    7. Herunterladen der aggregierten Felddaten für eine Bibliotheksvorlage
  3. Übertragen des Eigentums an Webformularen und Bibliotheksvorlagen
  4. Power Automate-Workflows
    1. Überblick über die Power Automate-Integration und die enthaltenen Berechtigungen
    2. Aktivieren der Power Automate-Integration
    3. Kontextbasierte Aktionen auf der Seite „Verwalten“
    4. Verfolgen der Nutzung von Power Automate
    5. Erstellen eines neuen Flows (Beispiele)
    6. Auslöser für Flows
    7. Importieren von Flows von außerhalb von Acrobat Sign
    8. Verwalten von Flows
    9. Bearbeiten von Flows
    10. Freigeben von Flows
    11. Deaktivieren oder Aktivieren von Flows
    12. Löschen von Flows
    13. Nützliche Vorlagen
      1. Nur Administration
        1. Speichern aller abgeschlossenen Dokumente in SharePoint
        2. Speichern aller abgeschlossenen Dokumente in OneDrive for Business
        3. Speichern aller abgeschlossenen Dokumente in Google Drive
        4. Speichern aller abgeschlossenen Dokumente in Dropbox
        5. Speichern aller abgeschlossenen Dokumente in Box
      2. Archivierung von Vereinbarungen
        1. Speichern deiner abgeschlossenen Dokumente in SharePoint
        2. Speichern deiner abgeschlossenen Dokumente in OneDrive for Business
        3. Speichern deiner abgeschlossenen Dokumente in Google Drive
        4. Speichern deiner abgeschlossenen Dokumente in Dropbox
        5. Speichern deiner abgeschlossenen Dokumente in Box
      3. Archivierung von Webformularvereinbarungen
        1. Speichern abgeschlossener Webformulardokumente in der SharePoint-Bibliothek
        2. Speichern abgeschlossener Dokumente in OneDrive for Business
        3. Speichern abgeschlossener Dokumente in Google Drive
        4. Speichern abgeschlossener Webformulardokumente in Box
      4. Extraktion von Vereinbarungsdaten
        1. Extrahieren von Formularfelddaten aus einem signierten Dokument und Aktualisieren eines Excel-Arbeitsblatts
      5. Vereinbarungsbenachrichtigungen
        1. Senden selbstdefinierter E-Mail-Benachrichtigungen mit dem Vereinbarungsinhalt und der signierten Vereinbarung
        2. Abrufen von Adobe Acrobat Sign-Benachrichtigungen in einem Teams-Kanal
        3. Abrufen von Adobe Acrobat Sign-Benachrichtigungen in Slack
        4. Abrufen von Adobe Acrobat Sign-Benachrichtigungen in Webex
      6. Vereinbarungsgenerierung
        1. Erstellen eines Dokuments aus einem Power Apps-Formular und einer Word-Vorlage sowie Senden zum Signieren
        2. Generieren einer Vereinbarung aus einer Word-Vorlage in OneDrive und Einholen der Signatur
        3. Generieren einer Vereinbarung für ausgewählte Excel-Zeile und Senden zur Überprüfung und Signatur
  5. Selbstdefinierte Sende-Workflows
    1. Übersicht über selbstdefinierte Sende-Workflows
    2. Erstellen eines neuen Sende-Workflows
    3. Bearbeiten eines Sende-Workflows
    4. Aktivieren oder Deaktivieren eines Sende-Workflows
    5. Senden einer Vereinbarung mit einem Sende-Workflow
  6. Freigeben von Benutzenden und Vereinbarungen
    1. Freigeben von Benutzenden
    2. Freigeben von Vereinbarungen

Integration in andere Produkte

  1.  Übersicht über Acrobat Sign-Integrationen 
  2. Acrobat Sign für Salesforce
  3. Acrobat Sign für Microsoft
    1. Acrobat Sign für Microsoft 365
    2. Acrobat Sign für Outlook
    3. Acrobat Sign für Word/PowerPoint
    4. Acrobat Sign für Teams
    5. Acrobat Sign für Microsoft PowerApps und Power Automate
    6. Acrobat Sign Connector für Microsoft Search
    7. Acrobat Sign für Microsoft Dynamics
    8. Acrobat Sign für Microsoft SharePoint 
  4. Weitere Integrationen
    1. Acrobat Sign für ServiceNow
    2. Acrobat Sign für HR ServiceNow
    3. Acrobat Sign für SAP SuccessFactors
    4. Acrobat Sign für Workday
    5. Acrobat Sign für NetSuite
    6. Acrobat Sign für VeevaVault
    7. Acrobat Sign für Coupa BSM Suite
  5. Von Partnern verwaltete Integrationen
  6. Erstellen eines Integrationsschlüssels

Acrobat Sign-Entwickler

  1. REST-APIs 
    1. Methodendokumentation
    2. SDK/Entwicklungshandbuch
    3. Häufige Fragen zu APIs
  2. Webhooks 
    1. Übersicht über Webhooks
    2. Konfigurieren eines neuen Webhooks
    3. Anzeigen oder Bearbeiten eines Webhooks
    4. Deaktivieren oder erneutes Aktivieren eines Webhooks
    5. Löschen eines Webhooks
    6. Zwei-Wege-SSL-Zertifikate
    7. Webhooks in der API

Support und Fehlerbehebung

  1. Kunden-Support-Ressourcen
  2. Ressourcen für den Erfolg von Unternehmenskundschaft 

Der API-Zugriff ist ausschließlich für Enterprise- und Entwickler-Konten reserviert.

Links zur Kerndokumentation

Hinweis:

Ältere SOAP-APIs werden seit Mai 2021 nicht mehr unterstützt.

Alle Kunden, die die SOAP-API verwenden, sollten so schnell wie möglich zur REST-API migrieren.

Navigiere nach der Anmeldung zu Konto > Acrobat Sign-API > API-Informationen > REST-APIs und Dokumentation
.


Allgemeine Konzepte

Du kannst das Dokument nicht erstellen, indem du die Seite auf der Web-UI anzeigst, per Drag & Drop verschiebst oder Unterzeichnerrollen mit transientDocumentId über die API zuweist.

Der transientDocuments-Aufruf gibt die transientDocumentID zurück, die sieben Tage lang gültig ist.  Du kannst sie nur für weitere API-Aufrufe verwenden. Die Datei wird mit dieser ID auf dem API-Server gespeichert. Lade eine Datei hoch und verweise dann in den weiteren API-Aufrufen auf ihre ID.

Du kannst ein Dokument nicht direkt über die REST-API in eine Methode „Agreement“ hochladen.

Erstelle gemäß der REST-Anforderung zuerst ein temporäres Dokument und verwende dann diese ID in den Methoden „Agreement“, „Widget“ oder „Library“ als Dateiquelle.

Das temporäre Dokument ist eine Quelldatei im Rohformat wie PDF, doc, docx, die auf die Adobe-Server hochgeladen wurde. Es ist also eine bequeme Möglichkeit, dein Basisdokument an die API-Server und ein temporäres Dokument im Internet zu übertragen.

Ja, du kannst Vereinbarungen über Workflows in v6 mit dem API-Aufruf POST /agreements veröffentlichen. Übergib den Parameter „workflowId“ im API-Aufruf.

Du kannst den workflowId-Parameter eines Workflows mit dem Aufruf GET /workflows abrufen.

  1. Melde dich bei Adobe Sign als Administrator an.

  2. Navigiere zu Konto > Adobe Sign-API > API-Anfrageprotokoll.

    API-Protokolle

  1.  Melde dich bei einem Adobe Sign-Konto als Administrator an.

  2. Navigiere zu Konto > Adobe Sign-API > API-Informationen.

  3. Klicke auf den Link REST-API-Beispiele.

    Hinweis:

    Informationen zum Herunterladen des JavaScript-SDK findest du unter https://github.com/adobe-sign/AdobeSignJsSdk.

Ab v6 ist die Option sendThroughWeb nicht mehr verfügbar. Sie wurde durch Status ersetzt. Es ist der Status der veröffentlichten Vereinbarung. Das Feld „Status“ wird nur in POST-Aufrufen angegeben. Es wird nie in GET /agreements/{ID} zurückgegeben und wird ignoriert, wenn es im Aufruf PUT /agreements/{ID} enthalten ist. Der endgültige Status der Vereinbarung kann über GET /agreements/ID abgerufen werden.

state(Zeichenfolge) = ['AUTHORING', 'ENTWURF' oder 'WIRD_VERARBEITET'].

AUTHORING ermöglicht es Benutzern, die Dokumente einer Vereinbarung zu verfassen, bevor sie versendet werden. Der Authoring-Vorgang bezieht sich hier auf das Erstellen, Bearbeiten oder Platzieren von Formularfeldern zusammen mit ihren Konfigurationen (Bevollmächtigte, Bedingungen, Datentyp usw.) in den Vereinbarungsdokumenten. Nachdem das Dokument im Status „Authoring“ veröffentlicht wurde, wird es im Abschnitt „Entwurf“ der Registerkarte „Verwalten“ in Adobe Sign angezeigt.

Ein ENTWURF ist eine temporäre oder einfache Version der endgültigen vorgesehenen Ressource, die in Schritten aktualisiert werden kann, um die endgültige Ressource zu erstellen. Dokumente mit diesem Status sind im Abschnitt „Entwurf“ der Registerkarte „Verwalten“ in Adobe Sign nicht sichtbar. Im Status „Draft“ sind keine Teilnehmerinformationen erforderlich. Sie können später zugewiesen werden, wenn der Entwurf mit dem Aufruf PUT /agreements/agreementId abgeschlossen wird. Dieser Schritt kann mehrmals wiederholt werden, bis du alle erforderlichen Daten zur Erstellung der Vereinbarung hast.

WIRD_VERARBEITET ändert den Vereinbarungsstatus in „Zur Signatur versandt“. Dokumente mit diesem Status werden im Abschnitt „Zur Signatur versandt“ der Registerkarte „Verwalten“ in Adobe Sign angezeigt.

Mit sendThroughWeb kannst du die Vereinbarung interaktiv versenden. Die verschiedenen Parameter im Feld „Optionen“ in der v5-Anfrage POST /agreements ermöglichen es dem Benutzer, diese interaktive Ansicht (Sendeseite) zu konfigurieren. Alle diese Seitenkonfigurationsparameter, wie fileUploadOptions, werden zur API POST agreements/ID/views verschoben.

Du kannst also sendThroughWeb erreichen, indem du eine Vereinbarung im AUTHORING-Status über die API POST /agreements erstellst. Um dann die URL der nächsten Seite in der gewünschten Konfiguration zu erhalten, rufe die API POST agreements/ID/views auf.

Führe die folgenden Schritte aus:

1. Rufe die Dokumentation der REST-API V6 auf und wähle die Methode POST/agreements aus.
2. Verwende den folgenden Anfragecode:

{

  "fileInfos": [

    {

      "transientDocumentId": "***************************"

    }

  ],

  "name": "test",

  "participantSetsInfo": [

    {

      "memberInfos": [

        {

          "email": "abc@gmail.com"

        }

      ],

      "order": 1,

      "role": "UNTERZEICHNER"

    }

  ],

  "signatureType": "E-SIGNATUR",

  "state": "AUTHORING"

}

 

3. Verwende jetzt die Methode POST /agreements/{agreementId}/views mit dem folgenden Anfragecode:

 

{

  "name": "AUTHORING"

}

Der Antwortcode stellt die URL für Authoring-Felder bereit.

Die Rückruf-URL kann wie folgt definiert werden:

  • Verwende den folgenden Parameter, um die Rückruf-URL nach Bedarf zu definieren:

    "callbackInfo": "",
  • Wende dich an den Adobe Sign-Support, um die Standard-Rückruf-URL für das gesamte Konto festzulegen.

Auf der SOAP-Benutzeroberfläche (SmartBear) wird bei einem API-Aufruf ein SSL-Verbindungsfehler ähnlich dem folgenden ausgegeben. Dieser Fehler tritt im Allgemeinen auf, wenn du ein veraltetes SSL- oder TLS-Protokoll verwendest (niedriger als TLS 1.2).

Fehler: Ausnahme in Anfrage: javax.net.ssl.SSLException: Schwerwiegende Warnung empfangen: protocol_version
Fehler: Ein Fehler ist aufgetreten [Schwerwiegende Warnung empfangen: protocol_version]. Weitere Informationen findest du im Fehlerprotokoll.

  1. Füge (-Dsoapui.https.protocols=SSLv3,TLSv1.2) dem Ordner „bin“ in der Datei VMOPTIONS hinzu.

  2. Gehe zu C:\Programme\SmartBear\SoapUI-5.2.1\bin (Speicherort hängt davon ab, wo du die SOAP-Benutzeroberfläche installiert hast. Sie kann sich unter C:\Programme (x86) befinden.)

  3. Aktiviere in der Datei VMOPTIONS die vollständige Lese-/Schreibberechtigung für Dateien.

    VMOPTIONS

  4. Klicke mit der rechten Maustaste auf die Datei VMPTIONS. Wähle „Eigenschaften“, die Registerkarte „Sicherheit“, den gewünschten Benutzer und dann „Bearbeiten“. (Das Symbol für die Benutzerzugriffssteuerung wird auf der Schaltfläche „Bearbeiten“ angezeigt.) Aktiviere alle Kontrollkästchen und klicke auf OK.

  5. Wiederhole diesen Vorgang für Administratoren, Systeme und alle Anwendungspakete.

  6. Öffne die Datei in einem Texteditor.

  7. Füge das Protokoll „-Dsoapui.https.protocols=SSLv3,TLSv1.2“ am Ende der Datei ein und speichere die Änderungen.

  8. Schließe die SOAP-Benutzeroberfläche und starte sie neu. Wenn du jetzt einen API-Aufruf durchführst, sollte kein SSL-Fehler ausgegeben werden. (Führe zur Überprüfung einen Test-Ping-Aufruf durch.)

Im Folgenden werden die Schritte zum Erstellen der Client-ID und des geheimen Schlüssels in der Adobe Sign-Anwendung beschrieben:

  1. Melde dich bei deinem Adobe Sign-Konto an.

  2. Navigiere zu Konto > Adobe Sign-API > API-Anwendungen.

    Fnord.

  3. Um eine Anwendung zu erstellen, klicke auf das Pluszeichen (+).

    Fnord.

  4. Gib den Namen und den Anzeigenamen ein.

  5. Wähle unter Domäne „Kunde“ aus und klicke auf „Speichern“.

    Fnord.

  6. Markiere die Anwendung durch einen einfachen Klick.

  7. Klicke auf „OAuth für die Anwendung konfigurieren“.

    Fnord.

  8. Gib den URI für die Umleitung ein.

  9. Um die erforderlichen Geltungsbereiche zu aktivieren, aktiviere die entsprechenden Kontrollkästchen und klicke auf „Speichern“.

  1. Melde dich bei Adobe Sign als Kontoadministrator an.

  2. Navigiere zu Konto > Adobe Sign-API > API-Informationen.

  3. Klicke auf den Link Integrationsschlüssel.

    Zum Integrationsschlüssel navigieren

    Hinweis:

    Wenn der Link „Integrationsschlüssel“ nicht angezeigt wird, wende dich an deinen Success Manager, damit dieser dein Konto aktiviert.

    • Benenne den Schlüssel mit einem intuitiven Wert.
    • Wähle die verschiedenen Geltungsbereiche aus, die für deine Anwendungsfunktion erforderlich sind.
    • Klicke auf Speichern, wenn der Schlüssel vollständig konfiguriert ist.
    Benutzeroberfläche „Integrationsschlüssel“ erstellen

  4. Nach dem Speichern findest du den Schlüssel unter Konto > Persönliche Einstellungen > Zugriffstoken.

    Der Name des Schlüssels und alle aktivierten Geltungsbereiche werden aufgelistet.  

    Klicke einmal auf die Schlüsselbeschreibung, um die Aktionslinks anzuzeigen:

    • Integrationsschlüssel: Dieser Link stellt den literalen Schlüssel bereit.
    • Widerrufen: Diese Aktion hebt das Zugriffstoken auf und löscht es dauerhaft.
    Zugriffstoken – Integrationsschlüssel

  1. Melde dich bei deinem Adobe Sign-Konto an.

  2. Navigiere zu Konto > Adobe Sign-API > API-Anwendungen.

  3. Klicke auf das Pluszeichen (+), um eine Anwendung zu erstellen.

    Postman1

  4. Klicke auf „OAuth für die Anwendung konfigurieren“.

    Fnord.

  5. Erstelle den Autorisierungscode über den folgenden Link. Client-ID, URI für die Umleitung und Geltungsbereiche müssen mit der folgenden URL übereinstimmen, gemäß Auswahl in der Anwendung (vermeide Leerzeichen in der folgenden URL; Shard wie „NA1“ entspricht dem 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

  6. Wenn der Anruf erfolgreich war, wähle in der Adressleiste den Autorisierungscode aus.

    Fnord.

  7. Lade Postman über den Link https://www.getpostman.com/apps herunter und installiere das Programm.

  8. Klicke nach dem Herunterladen und Installieren auf „Neu“, um einen POST zu erstellen.

  9. Gib den Link https://secure.na1.echosign.com/oauth/token gemäß deinem Adobe Sign-Konto ein.

  10. Gib unter Headers den Content-Type als application/x-www-form-urlencoded ein.

  11. Stelle sicher, dass x-www-form-urlencoded unter „Body“ ausgewählt ist und gib die Parameter unten mit den entsprechenden Werten von der im Adobe Sign-Konto erstellten Anwendung ein. Klicke dann auf „Senden“.

    Fnord.

  12. Wenn alle Informationen korrekt sind, werden das Zugriffstoken und das Aktualisierungstoken in der Antwort zurückgegeben:

    Fnord.

Achte beim Ausführen des OAuth-Prozesses auf die folgenden Punkte:

1. Client-ID und URI für die Umleitung sind korrekt.
2. Die in der Autorisierungs-URL angegebenen Geltungsbereiche müssen genau mit den Geltungsbereichen in der Adobe Sign-Anwendung übereinstimmen.
3. Verwende den richtigen Shard (NA1, NA2, AU1, EU1, JP1) für das Konto, das konfiguriert wird.
4. Entferne alle Leerzeichen in der Autorisierungs-URL (falls vorhanden).
5. Prüfe die Syntax der Autorisierungs-URL:

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

Zugriffstoken sind nur 3600 Sekunden (eine Stunde) gültig. Danach laufen sie ab.

Der API-Anfrager kann Aktualisierungstoken verwenden, um bei Bedarf neue Zugriffstoken zu generieren.

Webhooks werden in der REST-API v6 und höher unterstützt.

Wenn ein Webhook-Empfänger nicht innerhalb von 72 Stunden antwortet, wird der Webhook deaktiviert und es wird keine Benachrichtigung gesendet.

Wenn die Ziel-URL für den Webhook aus irgendeinem Grund nicht funktioniert, fügt Adobe Sign die JSON-Datei einer Warteschlange hinzu und versucht die Übertragung in einen progressiven Zyklus für 72 Stunden.

Nicht zugestellte Ereignisse werden in einer Wiederholungswarteschlange gespeichert. Innerhalb der folgenden 72 Stunden wird nach besten Kräften versucht, die Benachrichtigungen in der Reihenfolge zu liefern, in der sie aufgetreten sind.

Die Strategie beim erneuten Zustellen von Benachrichtigungen ist eine Verdoppelung der Zeit zwischen Versuchen. Es wird mit einem Intervall von einer Minute begonnen bis zu einem Intervall von zwölf Stunden. Daraus ergeben sich 15 Versuche innerhalb von 72 Stunden.

 

Um Webhooks direkt von der Adobe Sign-Benutzeroberfläche aus zu erstellen, erstelle zunächst eine Webhook-URL über Funktionen-Apps von Azure AD, indem du die folgenden Schritte ausführst:

  1. Melde dich über dein Microsoft-Konto bei https://portal.azure.com/ an.

  2. Registriere sich unter dem AzureAD-Konto für Funktionen-Apps.

    Azure-Menü

  3. Gehe zu AzureAD und dann zu Funktionen-Apps. Klicke auf das Pluszeichen für Funktionen.

  4. Wähle „Webhook + API“ mit Javascript als Sprache aus und klicke auf „Funktion erstellen“.

    Azure-Benutzeroberfläche

  5. Ersetze die Index.js-Datei durch folgenden Code:

    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(); 
    };
  6. Klicke auf die Schaltfläche „Test“ in der rechten Ecke und gib die folgende Kopfzeile ein:

    X-AdobeSign-ClientId as ***********************

    API-Test

  7. Klicke auf „Speichern und ausführen“.

  8. Wenn du die 200 OK-Antwort mit der folgenden Kopfzeile erhalten hast, klicke auf „Funktions-URL abrufen“.

    200 OK-Antwort

  9. Kopiere die URL und gehe zur Adobe Sign-Benutzeroberfläche > Webhooks. Klicke auf das Pluszeichen, um den Webhook zu erstellen.

  10. Gib folgende Informationen ein:

    • Name: Ein intuitiver Name, den andere Administratoren sofort verstehen können, ist ratsam.
    • Geltungsbereich: Der Bereich, für den der Webhook gelten soll. Konto und Gruppe sind auf der Oberfläche verfügbar.
      Die API unterstützt die Bereiche Konto, Gruppe, Benutzer und Ressourcen.
    • Pro Webhook kann nur ein Bereich definiert werden.
    • URL: Die Ziel-URL, an die Adobe Sign die JSON-Payload überträgt.
    • Ereignisse: Der Auslöser, aufgrund dessen Adobe Sign die JSON-Datei erstellt und an die URL sendet.
      Jedes Ereignis erstellt eine andere Payload, die für das Auslöserereignis relevant ist.
      Mehrere Ereignisse können in einem Webhook enthalten sein.
    • Benachrichtigungsparameter: Die Benachrichtigungsparameter identifizieren die Abschnitte der Ereignis-JSON-Payload, sodass du nur die Abschnitte des Ereignisses auswählen kannst, die wichtig sind.
    Webhook-Benutzeroberfläche

  11. Wenn der Webhook vollständig definiert ist, klicke auf „Speichern“. Der neue Webhook reagiert sofort auf Auslöserereignisse.

Das Vereinbarungs-Asset bezieht sich auf ein Asset, über das du eine Vereinbarung erstellen kannst, z. B. ein Bibliotheksdokument, ein Widget oder eine Vereinbarung selbst.

Um nach Ereignissen bzgl. Vereinbarungs-Assets zu suchen, sende zunächst eine Anfrage an die API, die agreementAssetEvents mit entsprechenden Suchparametern erstellt.

Die Antwort ist die erste Ergebnisseite zusammen mit einem Such-ID-Parameter und einem Cursor für weitere Seiten. Du kannst damit weitere Seitenergebnisse abrufen, wenn sie über die API verfügbar sind, die agreementAssetEvents basierend auf der Such-ID abruft.

  1. Öffne die REST-API-Dokumentation für Version 5.

  2. Gehe zu post/search/agreementAssetEvents und generiere das Zugriffstoken mit den entsprechenden Geltungsbereichen.

  3. Definiere im Anfragecode das Start- und Enddatum gemäß der Anforderung:

    { 
      "endDate": "2018-05-22T22:33:33", 
      "startDate": "2017-12-22T22:33:33" 
    }
  4. Klicke auf die Schaltfläche „Testen“. Daraufhin werden die IDs von Vereinbarungs-Assets abgerufen, die auch als Vereinbarungs-IDs verwendet werden können.


Benutzer-/Kontoverwaltung

  1. Melde dich bei Adobe Sign an.
  2. Navigiere zu Konto > Adobe 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"
    } }

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

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

 

Gruppen-ID abrufen:

  1. Rufe https://secure.na1.echosign.com/public/docs/restapi/v5 auf.

  2. Klicke unter „Resources and Operations“ auf „groups“.

  3. Klicke auf GET /groups.

  4. Klicke auf die Schaltfläche OAUTH ACCESS-TOKEN.

  5. Generiere das Zugriffstoken.

  6. Klicke auf die Schaltfläche „Testen“.

    Du erhältst die folgende Antwort mit dem Gruppennamen und der Gruppen-ID:

    { 
      "groupInfoList": [ 
        { 
          "groupId": "3AAABLblqZhB4o9EnlvmGB_m8CrG5O6XClTBO7vmojOOexu5r3G95LtEV2Sp7BuhNvQYSvWB7PmmwVPXnhPIiYSuHV98Cerkp", 
          "groupName": "Default Group" 
        }, 
        { 
          "groupId": "3AAABLblqZhC3dPT6za5h7r1-BOEWivCe_OcAVONhcsKa57SL9_iCwGr5v_JED1No5jE20Pcjv0mYH2J-LoY1AcmqS69vRkO7", 
          "groupName": "test" 
        }, 
      ] 
    }

Gruppe löschen:

  1. Klicke auf DELETE /groups/{groupId}.

  2. Um ein Zugriffstoken zu generieren, klicke auf die Schaltfläche OAUTH ACCESS-TOKEN.

  3. Füge im groupId-Feld die zu löschende Gruppen-ID hinzu, die du in der Antwort des vorherigen Aufrufs erhalten hast.

  4. Klicke auf „Testen“.

    Nach dem Löschen der Gruppe erhältst du folgende Antwort: Kein Inhalt

Hinweis:

Du kannst keine Gruppe löschen, der ein Benutzer zugewiesen ist. Im Wesentlichen kannst du nur leere Gruppen löschen. Du erhältst eine Antwort wie folgt, wenn es einen Benutzer in der Gruppe gibt.


{

  "code": "GROUP_NOT_EMPTY",

  "message": "Die Gruppe kann nicht gelöscht werden, da sie nicht leer ist."

}


Initiieren/Senden von Vereinbarungen

Temporäres Dokument generieren

  1. Klicke auf transientDocuments und erweitere die Methode POST /transientDocuments.

  2. Klicke auf die Schaltfläche OAUTH ACCESS-TOKEN.

    API-Methode TransientDocument

    • Aktiviere die Geltungsbereiche für die Transaktion.
    • Klicke auf Autorisieren.
    OAuth-Geltungsbereiche

  3. Zugriff erlauben

    Wenn du dazu aufgefordert wirst, klicke auf Zugriff zulassen.

  4. Du wirst auf die Seite mit API-Methoden umgeleitet. Der Autorisierungswert ist nun ausgefüllt.

    • Gib den Dateinamen in das Feld File-Name ein.
    • Klicke auf die Schaltfläche Datei auswählen und lade das Dokument für die Vereinbarung hoch.
    • Klicke auf die Testen -Schaltfläche.
    Testen

  5. Die Antwort wird generiert.

    Die transientDocumentID befindet sich im Antworttext:

    ID für temporäres Dokument

Vereinbarung mithilfe des temporären Dokuments generieren

  1. Klicke auf agreements und erweitere die Methode POST /agreements.

    • Klicke auf die Schaltfläche OAUTH ACCESS-TOKEN.
    • Aktiviere den OAuth-Geltungsbereich.
    • Klicke auf Autorisieren.
      • Wenn du dazu aufgefordert wirst, klicke auf Zugriff zulassen.
  2. Du wirst auf die Seite mit API-Methoden umgeleitet. Der Autorisierungswert ist nun ausgefüllt.

    • Kopiere das folgende Skript in einen Texteditor (dieses Skript ist nur ein minimal konfiguriertes Beispiel; dein Produktionscode wird anders sein).
    •  Gib den Wert für „transientDocumentId“ an der angegebenen Stelle in den Code ein.
    { 
      "fileInfos": [ 
       {"transientDocumentId":"PASTE YOUR TRANSIENTDOCUMENTID HERE"} 
      ], 
      "name": "test doc", 
      "participantSetsInfo": [ 
        { 
          "memberInfos": [ 
            { 
              "email": "noreply@echosign.com" 
            } 
          ], 
          "order": 1, 
          "role": "SIGNER" 
        } 
      ], 
      "signatureType": "ESIGN", 
      "state": "DRAFT" 
    }

     

    • Kopiere dein benutzerdefiniertes Skript und füge es in das Feld AgreementInfo ein.
    • Klicke auf die Testen -Schaltfläche.
    Methode „POST agreement“

  3. Die Antwort wird generiert.

    Die agreementID befindet sich im Antworttext:

    Antwort der Methode POST /agreement

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

  1. Temporäre ID verwenden:

    Gehe zu POST /transientDocuments und lade das zu verwendende Dokument von deinem lokalen System hoch.
    Verwende die temporäre ID, die im Abschnitt Dateiinformationen in POST /agreements generiert wurde:

    "fileInfos": [ 
         { 
           "transientDocumentId": "" 
         } 
       ],
  2. Bibliotheksdokument-ID verwenden:

    Gehe zum Dashboard. Klicke auf „Dokument zur Bibliothek hinzufügen“ und speichere die Vorlage.
    Klicke unter REST-API-Dokumentation auf GET /libraryDocuments und rufe die Bibliotheks-ID für die zu erstellende Vorlage ab.
    Gib unter POST /agreements die Bibliotheksdokument-ID an:

    "libraryDocumentId": "", "libraryDocumentName": "",
  3. Öffentlich verfügbare URL verwenden:

    Gib die zu verwendende öffentlich verfügbare URL im Parameter FileInfo an:

    { 
          "documentURL": { 
            "mimeType": "", 
            "name": "", 
            "url": "" 
          },
  1. Wähle die Option agreements > POST /agreements. 

  2. Wähle die Option OAUTH ACCESS-TOKEN und gib die erforderlichen Geltungsbereiche an.

  3. Sobald das Zugriffstoken hinzugefügt wurde, kannst du den folgenden Anfragecode verwenden:

    { 
    "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*"} 
    ] 
    } 
    }

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.

Hier ist ein Beispiel für den 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"

  }

}

Hinweis:

Die Option „Senden im Namen von“ ist nur in REST-API V6 mit aktivierter erweiterter Freigabe verfügbar.

Wenn die Freigabe keine Berechtigung zum Senden umfasst oder Erweiterte Freigabe nicht aktiviert ist, erhältst du folgende Antwort:

 

{"code":"ERLAUBNIS_VERWEIGERT","message":"Benutzer im Header x-on-behalf-of-user verfügt nicht über die erforderliche Berechtigung für diesen Vorgang."}

 

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 erhältst du unter Aktivieren der erweiterten Kontofreigabe.

Sobald die Benutzerfreigabe aktiviert ist, führe die folgenden Schritte aus, um im Namen von anderen Benutzern zu senden:

Temporäres Dokument generieren:

  1. Klicke unter transientDocuments auf POST /transientDocuments.

  2. Um ein Token für die Autorisierung zu generieren, klicke auf die Schaltfläche OAUTH ACCESS-TOKEN.

  3. Gib in x-on-behalf-of-user die E-Mail-Adresse des Benutzers ein, in dessen Namen du senden möchtest, und zwar im folgenden Format: email:test@email.com

  4. Um eine Datei auszuwählen, klicke auf Datei auswählen und dann auf Testen.

    Du erhältst eine Antwort wie folgt mit transientDocumentId:

    {"transientDocumentId":"3AAABLblqZhB9Mjo0mrIu_pSgrf5VsMaKM68_Vmn80cimaqiUAD2OxrPp2e5H8GvjfiOxj4d5B8bCPkUfvaozW3KLisp_wseGVOL8A7oNZni1DWyFi4uNoxLQu4nUO44Wh63GQv9_HEJMePust0Pk94vJ_rbS96R7ic-vl7jbOkN0b4EB5-JMqlC-Fl_Vpyz8I1EQUrM5I4nB9ztMov4ad00yiOtDw0tB-Y2t5JdzM07P-mpJmwYEl8Fq2IeDuWjcR2tV7qY7TNGX2CNyh9jt0aMyduHeYa0GABr69z8Hm76eKdtaM_1E1ggWj205fSrNcwJsnpSO278*"}

Vereinbarung mithilfe des temporären Dokuments generieren:

  1. Klicke unter agreements auf POST /agreements.

  2. Um ein Token für die Autorisierung zu generieren, klicke auf die Schaltfläche OAUTH ACCESS-TOKEN.

  3. Gib in x-on-behalf-of-user wie beim Erstellen des temporären Dokuments die E-Mail-Adresse des Benutzers an.

  4. Füge in AgreementInfo den folgenden Code hinzu und klicke auf Testen.

    { 
      "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 erhältst eine Antwort wie folgt mit agreementId:

    { 
      
      "id": "CBJCHBCAABAAUlen3l_fzlj1Kbn_wGZAhYcIgN0J7Qtq" 
      
    }
  1. Melde dich bei Adobe Sign an.

  2. Navigiere zu Konto > Adobe Sign-API > API-Informationen und klicke auf „Dokumentation der REST-API-Methoden“.

    Webhook-Benutzeroberfläche

  3. Lade unter POST /transientDocuments eine Datei hoch und erstelle eine temporäre Dokument-ID.

  4. Kopiere die temporäre Dokument-ID und verwende sie in der Methode POST /agreements. Gib die folgende JSON-Anfrage im Feld ein:

    { 
        "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 
            }] 
        } 
    }
  5. Um die JSON-Anfrage auszuführen, klicke auf die Schaltfläche „Testen“.

    Webhook-Benutzeroberfläche

    Die korrekte Antwort der JSON-Anfrage enthält die Vereinbarungs-ID.

    Webhook-Benutzeroberfläche

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

 

{

    "documentCreationInfo":

    [{

        "signatureType": "E-SIGNATUR",

               "recipientSetInfos": [{

            "recipientSetMemberInfos": [{                      

                "email": "abc@xyz.com"                  

            }],

                   

            "recipientSetRole": "UNTERZEICHNER"

        }],

               "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED",

                   "fileInfos": [           {               

            "libraryDocumentId": "3AAABLblqZhBsm_vH7TVzU3hRdbtWuvzfTKDvBzaKZTiehjO2eGTk5Rlu02K-0BYn8HBJVFTWOmT_BQlrofPBlrCdjiJ_JI-V"        

        }       ],

               "name": "Kennwort zum Öffnen des Dokuments",

               "securityOptions": {        

            "openPassword": "1234",

                     "protectOpen": true   

        }

    }]

}

 

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:

 

{

  "fileInfos": [

    {

      "transientDocumentId": "*********************"

    }

  ],

  "name": "A1",

  "participantSetsInfo": [

    {

      "memberInfos": [

        {

          "email": "abc@xyz.com"

        }

      ],

      "order": 1,

      "role": "UNTERZEICHNER"

    }

  ],

  "signatureType": "E-SIGNATUR",

  "state": "AUTHORING"

}

 

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:

  1. Rufe die Dokumentation der REST-API V6 auf und wähle die Methode POST /agreements aus.

  2. Verwende den folgenden Anfragecode:

    { 
      "fileInfos": [ 
        { 
          "transientDocumentId": "***************************" 
        } 
      ], 
      "name": "test", 
      "participantSetsInfo": [ 
        { 
          "memberInfos": [ 
            { 
              "email": "abc@gmail.com" 
            } 
          ], 
          "order": 1, 
          "role": "SIGNER" 
        } 
      ], 
      "signatureType": "ESIGN", 
      "state": "AUTHORING" 
    }
  3. Verwende die Methode PUT /agreements/{agreementId}/formFields mit der folgenden Anfrage als Beispiel:

    { 
      "fields": [ 
        { 
         "locations": [ 
              { 
                "height": 36, 
                "left": 75, 
                "pageNumber": "1", 
                "top": 200, 
                "width": 150 
              } 
            ], 
            "contentType": "SIGNATURE_BLOCK", 
            "name": "sigBlock1", 
            "inputType": "SIGNATURE", 
            "recipientIndex":1 
           } 
    ]}

     

    Sobald die Anfrage abgeschlossen ist, wird die Vereinbarung an den genannten Empfänger gesendet.

  1. Melde dich bei Adobe Sign an.

  2. Navigiere zu Konto > Adobe Sign-API > API-Informationen und klicke auf „Dokumentation der REST-API-Methoden“.

    Webhook-Benutzeroberfläche

  3. Lade unter POST /transientDocuments eine Datei hoch und erstelle eine temporäre Dokument-ID.

  4. Kopiere die temporäre Dokument-ID und verwende sie in der Methode POST /agreements. Gib die folgende JSON-Anfrage im Feld ein:

    { 
        "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 
      
                } 
            ] 
        } 
    }
  5. Um die JSON-Anfrage auszuführen, klicke auf die Schaltfläche „Testen“.

    Webhook-Benutzeroberfläche

    Die korrekte Antwort der JSON-Anfrage enthält die Vereinbarungs-ID.

    Webhook-Benutzeroberfläche

  1. Melde dich bei Adobe Sign an.

  2. Navigiere zu Konto > Adobe Sign-API > API-Informationen und klicke auf „Dokumentation der REST-API-Methoden“.

    Fnord.

  3. Lade unter POST /transientDocuments eine Datei hoch und erstelle eine temporäre Dokument-ID.

  4. Kopiere die temporäre Dokument-ID und verwende sie in der Methode POST /agreements. Gib die folgende JSON-Anfrage im Feld ein:

    { 
        "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" 
            }] 
        } 
    }
  5. Um die JSON-Anfrage auszuführen, klicke auf die Schaltfläche „Testen“.

    Fnord.

    Die korrekte Antwort der JSON-Anfrage enthält die Vereinbarungs-ID.

    Fnord.

  6. Um die Vereinbarung im Authoring-Modus zu öffnen, kopiere die URL und füge sie in die Adressleiste eines Browsers ein.

  7. Ziehe die Formularfelder per Drag & Drop an die gewünschte Position.

  8. Um die Vereinbarung zur Unterschrift zu senden, klicke auf „Senden“. 

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.

 

{

"documentCreationInfo": {

"mergeFieldInfo": null,

"recipientSetInfos": [{

"signingOrder": null,

"recipientSetRole": "UNTERZEICHNER",

"recipientSetMemberInfos": [{

"securityOptions": null,

"email": "Signer@email.com"

}],

 

"privateMessage": null,

"securityOptions": [{

"authenticationMethod": "PHONE",

"phoneInfos": [{

"phone": "1111111111",

"countryCode": "+1"

}]

}]

}],

 

"signatureType": "E-SIGNATUR",

"callbackInfo": null,

"message": "Bitte überprüfen und signiere dieses 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 Vereinbarung - Testen der Telefonauthentifizierung",

"formFields": null,

"fileInfos": [{

"libraryDocumentName": null,

"transientDocumentId": "3AAABLdeineTransactionID",

"documentURL": null,

"libraryDocumentId": null

}]

},

 

"options": {

"autoLoginUser": true,

"authoringRequested": false,

"noChrome": true,

"sendThroughWeb": null,

"sendThroughWebOptions": null,

"locale": "en_US"

}

}

 

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.

 

"mergeFieldInfo": [

     {

       "defaultValue": "",

       "fieldName": ""

     }

   ],

 

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

 

"mergeFieldInfo": [

     {

       "defaultValue": "",

       "fieldName": ""

     }

   ],

 

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).

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

 

Anfrage:

POST /api/rest/v5/agreements HTTP/1.1

Host: api.na1.echosign.com (oder du kannst deinen Shard-Namen angeben, den du mit dem getbaseURis-Aufruf ermittelst: https://secure.na1.echosign.com/public/docs/restapi/v5#!/base_uris/getBaseUris

Zugriffstoken: 2AAABLblqZhA_D1mluNKQP7py5vXtt-1UHl9NR25e_C3LnKTUH14IblbrXODbXGRozyr7ChBkJNM*

X-user-email: sender@ihredomäne.com

Content-Type: application/json

Cache-Control: no-cache

 

{

   "documentCreationInfo": {

       "signatureType": "E-SIGNATUR",

       "recipientSetInfos": [

           {

               "recipientSetMemberInfos": [

                   {

                       "email": “UnterzeichnerEmail@domäne.com"

                   }

               ],

               "recipientSetRole": "UNTERZEICHNER"

           }

        ],

      

       "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED",

       "message": "Bitte signiere",

       "fileInfos": [

           {

               "transientDocumentId": "3AAABLblqZhD1uP3ZnkJximC0JV1S677PR5xmybSJ-SJn6OtEy2tVqFyMN4xUAbhKTSkLw2Zb6HEF4zAGsrUd2ycoB8fFHQJhrci0O6267VztmIL4nCicSqvAjO7HckATHAsovVmuYwI9_FDDgHg0ogyti62L13HQFZIQRe9iyQMvvzbmksM7ODNK_HEepEKRCeJTtis9FOlz6uRCcIMNlbX_2GU8utWT"

           }

       ],

       "name": "MSA bearbeitet”,

        "mergeFieldInfo": [

            {

                "fieldName": "Kontoname",

                "defaultValue": "Musterkonto"

            },

            {

                "fieldName": "Kontonummer",

                "defaultValue": "8756999"

            },

            {

                "fieldName": "PLZ",

                "defaultValue": "94501"

            },

            {

                "fieldName": "Stadt",

                "defaultValue": "Musterstadt"

            },

            {

                "fieldName": "Bundesland",

                "defaultValue": "NW"

            },

            {

                "fieldName": "Straße",

                "defaultValue": "123 Musterstraße"

            },

            {

                "fieldName": "Titel1",

                "defaultValue": "COO"

            },

            {

                "fieldName": "Beschreibung",

                "defaultValue": "Musterbeschreibung"

            }

        ]

   }

 

}

 

Die Antwort auf diesen Aufruf ist die agreementId, die du in deinem System für nachfolgende Aufrufe (signingUrl, status, formData usw.) speichern musst.

 

Antwort:

{

  "agreementId": "3AAABLblqZhCf_7xDcrOgKFwAabp1S-OFfvUdHf2wJsSMwlB95_x_WdUeab67jOkJi1IJzWuSJ0zdNNKugS1blZB4LT5vNVyJ"

}

 

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.

Adobe Sign empfängt die 2XX-Antwort mit X-AdobeSign-ClientId.Der Benutzer kann prüfen, ob die Konfiguration im Webhook richtig ist.

Die Webhook-URL reagiert nicht wie erwartet. Für jede POST-Benachrichtigung, die Adobe 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://www.adobe.io/apis/documentcloud/sign/docs.html#!adobedocs/adobe-sign/master/webhooks/webhook_events.md

Wenn die URL dieses Protokoll nicht befolgt, geht Adobe 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.

Dieses Werk unterliegt den Bedingungen der Creative Commons Namensnennung-Nicht kommerziell-Weitergabe unter gleichen Bedingungen 3.0-Lizenz (Unported).  Twitter™ und Facebook-Beiträge werden von den Bedingungen von Creative Co nicht abgedeckt.


Informationen zu Vereinbarungen verwalten/abrufen

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:

 

{

  "documentUpdateInfo": {

    "fileInfos": [

      {

        „agreementDocumentId“: "",

        "transientDocumentId": ""

      }

    ]

  }

}

 

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

  1. Rufe die Vereinbarungs-ID ab, die mit der Methode POST/ agreements abgerufen wurde.

  2. Verwende GET /agreements/{agreementId}, um das letzte ETag abzurufen.

  3. Gehe zu PUT /agreements/{agreementId}/state und gib die folgenden Informationen an: "state“: "WIRD_VERARBEITET“

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, um eine Vereinbarung auf der Seite „Verwalten“ auszublenden.

Adobe verfügt über die neue API PUT /Agreements/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 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.
Hinweis:

Die API-Aufbewahrungsfunktion ist standardmäßig nicht aktiviert.

Um DELETE/agreements zu aktivieren, wende dich an deinen Success Manager und bitte ihn, die API-Aufbewahrungsfunktion für das Konto zu aktivieren.

Weitere Informationen zum Aktivieren der Aufbewahrungsfunktionen für dein Konto findest du unter Adobe Sign – Dokumentaufbewahrung.

  1. Melde dich als Adobe Sign-Administrator an und navigiere zu:  https://secure.adobesign.com/public/docs/restapi/v6.

    • Klicke auf agreements und erweitere die Methode GET /agreements.
    • Klicke auf die Schaltfläche OAUTH ACCESS-TOKEN.
    • Aktiviere den Bereich agreement_read:self.
    • Klicke auf die Schaltfläche Autorisieren.
      • Wenn du dazu aufgefordert wirst, klicke auf Zugriff zulassen.
    • Klicke auf die Testen-Schaltfläche.
    Methode GET /agreement

  2. Die Antwort wird generiert.

    Die agreementId befindet sich im Antworttext:

    Antwort auf GET /agreements

  3. DELETE /agreements/{agreementId}/documents: Löscht alle Dokumente im Zusammenhang mit einer Vereinbarung. Die Vereinbarung selbst bleibt auf der Seite „Verwalten“ sichtbar.

    • Wähle die Methode DELETE/agreements, die ausgeführt werden soll.
    • Klicke auf die Schaltfläche OAUTH ACCESS-TOKEN und erstelle das Zugriffstoken mit dem Geltungsbereich agreement_retention.
    • Gib die Vereinbarungs-ID der Vereinbarung an, die du löschen möchtest.
    • Sobald die Vereinbarung gelöscht wurde, hat der Antworttext keinen Inhalt mehr.

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 Adobe 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 Adobe Sign REST API herunterladen, anstatt einen separaten Aufruf zum Herunterladen des Audit-Berichts durchzuführen.

GET /agreements/{agreementId}/auditTrail

  1. Klicke auf GET /agreements/{agreementId}/combinedDocument.

  2. Klicke auf die Schaltfläche OAUTH ACCESS-TOKEN.

  3. Das Zugriffstoken wird automatisch generiert, sobald die Autorisierung akzeptiert wurde.

  4. Gib die agreementId an.

  5. Wähle unter attachSupportingDocuments die Option „true“ aus der Dropdown-Liste aus

  6. Wähle unter auditReport die Option „true“ aus der Dropdown-Liste aus.

  7. Klicke auf die Testen- Schaltfläche.

    Kombinierte Dokumente abrufen

    Die kombinierte PDF-Datei mit signiertem Dokument, Begleitdokument und Audit-Bericht wird heruntergeladen.

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


Bibliotheksvorlagen und Webformulare

  1. Melde dich bei Adobe Sign als Administrator an und navigiere zu https://secure.na1.adobesign.com/public/docs/restapi/v6

    • Klicke auf libraryDocuments und erweitere die Methode GET /libraryDocuments.
    • Klicke auf die Schaltfläche OAUTH ACCESS-TOKEN.
    • Aktiviere den Bereich library_read:self.
    • Klicke auf die Schaltfläche Autorisieren.
      • Wenn du dazu aufgefordert wirst, klicke auf Zugriff zulassen.
    • Klicke auf die Testen-Schaltfläche.
    Methode GET LibraryDocument

  2. Die Antwort wird generiert.

    Die libraryDocumentId befindet sich im Antworttext:

    Antwort von GET LibraryDocument

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 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 /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.
Hinweis:
  • Leite eine Anforderung an das Support-Team weiter, um den Geltungsbereich für das Löschen von Bibliotheken zu aktivieren.
  • API löscht das Bibliotheksdokument. Die mit diesem Bibliotheksdokument erstellten Vereinbarungen sind jedoch nicht betroffen.


LibraryDocumentID generieren

  1. Rufe https://secure.echosign.com/public/docs/restapi/v5 auf.

  2. Klicke auf libraryDocuments.

  3. Klicke auf die Schaltfläche OAUTH ACCESS-TOKEN.

    Autorisiere ein Zugriffstoken für dich selbst, eine Gruppe oder ein Konto.

  4. Wähle Dokument oder Form_Field_Layer als libraryTemplateType aus.

  5. Klicke auf die Schaltfläche Testen.

    Du kannst für alle deine Vorlagen eine Antwort wie folgt erhalten. (Kopiere libraryDocumentId für die Bibliotheksvorlage, die du löschen möchtest.)

    { 
      "libraryDocumentList": [ 
        { 
          "name": "testing fields", 
          "modifiedDate": "2017-08-04T01:06:05-07:00", 
          "scope": "PERSONAL", 
          "libraryDocumentId": "3AAABLblqZhAK53Dvzq88Q1Ov0TEvMAySDPpIVjF1PWgUpy0H1uYggt4iwGiRSZYlWfl9ms_AcmgZ_uZMPPN2hNT9izwaspHc", 
          "libraryTemplateTypes": [ 
            "DOCUMENT" 
          ] 
        },


Bibliotheksvorlagen löschen

  1. Kopiere libraryDocumentID aus dem Antworttext.

  2. Gehe zu Delete libraryDocuments.

  3. Klicke auf die Schaltfläche OAUTH ACCESS-TOKEN. Autorisiere ein Zugriffstoken für dich selbst, eine Gruppe oder ein Konto.

  4. Füge die libraryDocumentId in das Wertfeld ein.

  5. Klicke auf Testen 
    . Die Vorlage wird gelöscht.

    Du erhältst den folgenden Antwortcode: 204

Hinweis:

Nur Webformulare mit dem Status Entwurf können aktualisiert werden.

  1. Erstelle das Widget mit der Methode POST /widgets.

  2. Rufe die Widget-ID mit GET /widgets ab.

  3. Rufe nach der Erstellung mit der Methode GET /widgets/{widgetId} das Etag aus der Antwortkopfzeile ab.

    Foo

  4. Verwende unter PUT /widgets/{widgetId} das Etag von GET /widgets/{widgetId}. Gib unter dem Parameter If-Match widgetId und widgetInfo ein.

    Foo

    { 
      "fileInfos": [ 
        { 
          "transientDocumentId": "******" 
        } 
      ], 
      "name": "Widht_Name", 
      "status": "DRAFT", 
      "widgetParticipantSetInfo": { 
        "memberInfos": [ 
          { 
            "email": "" 
          } 
        ], 
        "role": "SIGNER" 
      } 
    }


Anwendungsbeispiele

  1. Führe einen GET /agreements-Aufruf mit dem richtigen x-api-user durch.

  2. Suche im Antworttext nach der Vereinbarung, die zur Unterschrift gesendet wurde und deren Signatur-URL du suchst, und notiere dir die Vereinbarungs-ID.

  3. Führe einen GET /agreements/{agreementId}/signingUrls-Aufruf mit der Vereinbarungs-ID durch, die du vom GET /agreements-Aufruf erhalten hast.

     

    Ergebnis

    Die Ausgabe enthält die E-Mail-Adresse des/der Unterzeichner/s und die E-Signatur-URL.

    Methode GET /agreements

 Adobe

Schneller und einfacher Hilfe erhalten

Neuer Benutzer?

Adobe MAX 2024

Adobe MAX

The Creativity Conference

14. bis 16. Oktober in Miami Beach und online

Adobe MAX 2024

Adobe MAX

The Creativity Conference

14. bis 16. Oktober in Miami Beach und online