DocuSign API: Wie erhalte ich eine Liste aller Vorlagen in einem bestimmten Ordner?

Einführung in DocuSign-Vorlagen und die API

In der sich ständig weiterentwickelnden Landschaft des digitalen Dokumentenmanagements hat sich DocuSign als führende Plattform für elektronische Signaturen etabliert, die Arbeitsabläufe für Unternehmen weltweit rationalisiert. Vorlagen spielen in DocuSign eine zentrale Rolle, da sie es Benutzern ermöglichen, Dokumente für die wiederholte Verwendung zu standardisieren, wodurch Zeit gespart und die Konsistenz von Prozessen wie Vertragsgenehmigungen oder Onboarding sichergestellt wird. Die DocuSign-API ermöglicht es Entwicklern, diese Aufgaben programmgesteuert zu automatisieren und die Integration von Funktionen für elektronische Signaturen in benutzerdefinierte Anwendungen zu erleichtern. Dieser Artikel untersucht, wie man die DocuSign-API verwendet, um eine Liste aller Vorlagen aus einem bestimmten Ordner abzurufen, was eine häufige Anforderung für ein effizientes Vorlagenmanagement in Unternehmensumgebungen ist.

Vergleichen Sie Plattformen für elektronische Signaturen mit DocuSign oder Adobe Sign?

eSignGlobal bietet flexiblere und kostengünstigere Lösungen für elektronische Signaturen mit globaler Compliance, transparenter Preisgestaltung und schnelleren Onboarding-Prozessen.

👉 Starten Sie eine kostenlose Testversion

DocuSign-Vorlagen verstehen

DocuSign-Vorlagen sind vorkonfigurierte Dokumente, die vordefinierte Felder, Unterzeichnerrollen und Arbeitsabläufe enthalten. Sie sind in DocuSign-Konten in Ordnern organisiert, sodass Benutzer sie nach Abteilungen, Projekten oder Typen kategorisieren können – z. B. HR-Vorlagen in einem Ordner und Verkaufsvereinbarungen in einem anderen. Diese Organisation ist für Teams, die mit großen Dokumentenmengen arbeiten, unerlässlich, da sie Unordnung verhindert und den schnellen Zugriff erleichtert.

Aus geschäftlicher Sicht können Vorlagen Fehler reduzieren und den Signaturprozess beschleunigen. Beispielsweise kann ein Vertriebsteam Angebotsvorlagen wiederverwenden, ohne jedes Mal Felder neu erstellen zu müssen, wodurch Markenkonsistenz und Compliance gewährleistet werden. Bei großen Konten mit Hunderten von Vorlagen kann das manuelle Durchsuchen von Ordnern jedoch ineffizient sein. Hier kommt die DocuSign-API ins Spiel, die eine programmgesteuerte Möglichkeit zum Abfragen und Auflisten von Vorlagen bietet.

Erste Schritte mit der DocuSign-API

Um die DocuSign-API zu verwenden, benötigen Entwickler ein aktives DocuSign-Konto und API-Anmeldeinformationen. DocuSign bietet eine kostenlose Sandbox-Umgebung zum Testen, die die Produktionsfunktionalität widerspiegelt. Die Authentifizierung umfasst in der Regel OAuth 2.0, und Sie können einen Integrationsschlüssel (Client-ID) und ein Geheimnis über das DocuSign Developer Center generieren.

Die wichtigsten Endpunkte für Vorlagen befinden sich unter der eSignature-API, insbesondere die Ressource /accounts/{accountId}/templates. Sie benötigen eine Konto-ID, die Sie über den Endpunkt /accounts abrufen können. Ordner in DocuSign werden durch eindeutige Ordner-IDs identifiziert, die mit dem Endpunkt /folders abgerufen werden können. Diese Einrichtung gewährleistet einen sicheren, skalierbaren Zugriff auf Vorlagendaten.

Die API-Dokumentation von DocuSign ist umfassend und unterstützt SDKs für Sprachen wie Java, .NET, PHP und Python, was die Integration vereinfacht. Für Unternehmen bedeutet dies, dass elektronische Signaturen in CRM-Systeme (wie Salesforce) oder benutzerdefinierte Anwendungen eingebettet werden können, wodurch die betriebliche Effizienz gesteigert wird, ohne dass zwischen Tools gewechselt werden muss.

So rufen Sie Vorlagen aus einem bestimmten Ordner mit der DocuSign-API ab

Das Abrufen einer Liste von Vorlagen aus einem bestimmten Ordner mit der DocuSign REST API ist ein unkomplizierter Vorgang. Diese Funktion ist besonders nützlich für Anwendungen, die Vorlagenoptionen dynamisch auffüllen oder Ordnerinhalte prüfen müssen. Der Kernendpunkt ist GET /accounts/{accountId}/folders/{folderId}/templates, der eine paginierte Liste von Vorlagen im angegebenen Ordner zurückgibt.

Voraussetzungen

Bevor Sie sich mit dem Code befassen, stellen Sie Folgendes sicher:

• Sie haben ein OAuth 2.0-Zugriffstoken.
• Die Konto-ID und die Ordner-ID sind bekannt. Um die Ordner-ID zu erhalten, rufen Sie zuerst GET /accounts/{accountId}/folders auf, um alle Ordner aufzulisten und den gewünschten Ordner zu identifizieren (z. B. nach Name oder Freigabestatus).
• Berechtigungen: Der API-Benutzer muss über Leseberechtigung für Vorlagen verfügen.

Schrittweise Implementierung

1. Authentifizieren und Token abrufen: Verwenden Sie den OAuth-Flow, um ein Zugriffstoken zu erhalten. Verwenden Sie beispielsweise das DocuSign eSignature SDK in Python:

   import docusign_esign as ds_esign
   
   # API-Client konfigurieren
   api_client = ds_esign.ApiClient()
   api_client.host = 'https://demo.docusign.net/restapi'  # Verwenden Sie demo zum Testen
   api_client.set_default_header('Authorization', 'Bearer ' + access_token)
   

2. Ordner-ID abrufen: Wenn die Ordner-ID unbekannt ist, listen Sie die Ordner auf:

   envelopes_api = ds_esign.EnvelopesApi(api_client)
   folders = envelopes_api.list_folders(account_id)
   # Iterieren Sie, um den Ordner nach Name zu finden, z. B. folder_id = next(f['folderId'] for f in folders if f['folderName'] == 'My Templates Folder')
   

3. Vorlagen im Ordner auflisten: Verwenden Sie die Templates API, um Vorlagen abzurufen:

   templates_api = ds_esign.TemplatesApi(api_client)
   template_list = templates_api.list_templates(account_id, folder=folder_id, count=100)  # Passen Sie die Anzahl für die Paginierung an
   for template in template_list.envelopes:
       print(f"Template Name: {template.name}, ID: {template.template_id}")
   

   Dies gibt Details wie Vorlagennamen, ID, Freigabestatus und Datum der letzten Änderung zurück. Die Antwort ist im JSON-Format und enthält ein Array von envelopes mit Vorlagenzusammenfassungen.

4. Paginierung und Fehler behandeln: Wenn der Ordner mehr Vorlagen enthält als die angegebene Anzahl (standardmäßig 20, maximal 100), verwenden Sie den Abfrageparameter start_position, um nachfolgende Seiten abzurufen. Häufige Fehler sind 401 (nicht autorisiert) oder 404 (Ordner nicht gefunden) – fügen Sie immer eine Fehlerbehandlung hinzu:

   try:
       template_list = templates_api.list_templates(account_id, folder=folder_id)
   except ds_esign.ApiException as e:
       print(f"Error: {e.body}")
   

5. Erweiterte Filterung: Fügen Sie Abfrageparameter wie search_text hinzu, um nach Namen zu filtern, oder include, um freigegebene Vorlagen einzuschließen. Für Unternehmenskunden lässt sich dies gut in Webhooks integrieren, um Echtzeitaktualisierungen bei Vorlagenänderungen zu erhalten.

Dieser API-Aufruf dauert in der Regel nur Millisekunden und eignet sich gut für UI-gesteuerte Anwendungen, bei denen Benutzer Vorlagen aus einem Ordner-Dropdown auswählen. Unternehmensberichte zeigen, dass durch die Automatisierung der Vorlagenermittlung bis zu 50 % der Zeit für die Dokumentvorbereitung eingespart werden können.

Anwendungsbeispiele

Stellen Sie sich eine Anwaltskanzlei vor, die DocuSign in ihr Fallverwaltungssystem integriert. Die API ruft Vorlagen aus dem Ordner "Verträge" ab und füllt sie automatisch basierend auf dem Falltyp aus, wodurch Compliance und Geschwindigkeit gewährleistet werden.

Best Practices für die Vorlagenverwaltung über die API

Priorisieren Sie bei der Implementierung dieser API-Funktionalität die Sicherheit, verwenden Sie JWT oder Autorisierungscode-Gewährung, um Token abzurufen, und rotieren Sie diese regelmäßig. Verwenden Sie Caching, um API-Aufrufe zu drosseln, um Ratenbegrenzungen zu vermeiden (z. B. 1.000 Aufrufe pro Stunde in Produktionsumgebungen). Verwenden Sie für die Skalierbarkeit die Connect-Webhooks von DocuSign, um Ihre Anwendung über neue Vorlagen zu informieren, ohne zu pollen.

Überwachen Sie die Nutzung über das API-Dashboard, um das Umschlagkontingent zu verfolgen, da Vorlagen in Plänen wie Business Pro auf die Gesamtbegrenzung angerechnet werden. Das Testen in der Sandbox verhindert Produktionsunterbrechungen.

DocuSign im Vergleich zu Wettbewerbern

DocuSign ist eine robuste Plattform für elektronische Signaturen, die eine nahtlose API-Integration und globale Compliance bietet. Die Vorlagenverwaltung ist in strukturierten Umgebungen hervorragend, aber die Preise steigen mit Benutzern und Funktionen.

Adobe Sign, jetzt Teil von Adobe Document Cloud, bietet eine starke Integration mit dem Adobe-Ökosystem, wie z. B. PDF-Bearbeitung. Es ist freundlich zu Kreativteams, aber die erweiterte API-Nutzung kann zusätzliche Lizenzen erfordern.

eSignGlobal zeichnet sich als wettbewerbsfähige Alternative aus, insbesondere im asiatisch-pazifischen Raum (APAC). Es unterstützt die Compliance in 100 wichtigen Ländern weltweit, mit besonderem Schwerpunkt auf der fragmentierten Regulierungslandschaft in APAC. Im Gegensatz zu rahmenbasierten Standards in den USA (ESIGN) oder Europa (eIDAS), die auf E-Mail-Verifizierung oder Selbsterklärung basieren, erfordern APAC-Vorschriften Ökosystem-integrierte Lösungen – tiefe Hardware- und API-Integrationen mit digitalen Regierungsidentitäten (G2B). Dies beinhaltet hohe Standards und strenge Aufsicht, wodurch die technischen Hürden weit über westliche Modelle hinaus erhöht werden. eSignGlobal zeichnet sich in diesem Bereich aus und bietet nahtlose Integrationen mit Hongkongs iAM Smart und Singapurs Singpass, während es unbegrenzte Benutzer und eine kostengünstige Preisgestaltung bietet. Der Essential-Plan kostet nur 16,6 US-Dollar pro Monat und ermöglicht das Senden von bis zu 100 elektronisch signierten Dokumenten, unbegrenzte Benutzerplätze und die Überprüfung über Zugriffscodes, was ein hohes Preis-Leistungs-Verhältnis auf einer konformen Grundlage bietet. Dies ermöglicht es eSignGlobal, weltweit mit DocuSign und Adobe Sign zu konkurrieren, oft zu geringeren Kosten.

Suchen Sie eine intelligentere Alternative zu DocuSign?

eSignGlobal bietet flexiblere und kostengünstigere Lösungen für elektronische Signaturen mit globaler Compliance, transparenter Preisgestaltung und schnelleren Onboarding-Prozessen.

👉 Starten Sie eine kostenlose Testversion

HelloSign (jetzt Dropbox Sign) konzentriert sich auf Einfachheit und bietet intuitive Vorlagen und API-Zugriff, der für kleine Teams geeignet ist. Es ist kostengünstig für grundlegende Anforderungen, aber es fehlen einige Funktionen auf Unternehmensebene.

Diese Tabelle hebt neutrale Kompromisse hervor: DocuSign für Skalierung, Adobe für Integration, eSignGlobal für regionalen Wert und HelloSign für Benutzerfreundlichkeit.

Fazit

Die Navigation in der API von DocuSign für die Vorlagenverwaltung kann die Produktivität erheblich steigern, insbesondere bei Abfragen bestimmter Ordner. Für Unternehmen, die Alternativen suchen, bietet eSignGlobal eine solide, regional konforme Option in APAC und darüber hinaus.