ABSign REST API-Referenz: v2 Endpunkte, Authentifizierung und Integrationshandbuch

Einführung in die ABSign API v2

Die ABSign REST API v2 ist die offizielle programmgesteuerte Schnittstelle zur Integration von elektronischen Signaturfunktionen der Enterprise-Klasse in Ihre Geschäftssysteme, Handelsplattformen und Dokumentenverwaltungs-Workflows. Die API basiert auf REST-Prinzipien mit JSON-Anforderungs- und Antwortnutzlasten und lässt sich nahtlos mit jedem Technologie-Stack verbinden, der HTTPS-Aufrufe durchführen kann – von Python- und Node.js-Anwendungen bis hin zu Java Spring Boot-Diensten, PHP-Laravel-Systemen und .NET Core-Anwendungen. Der Basisendpunkt für alle v2-API-Aufrufe ist https://www.abroadsign.com/api/v2/, das den alten v1-Endpunkt ersetzt und verbesserte Sicherheit, erweiterte Webhook-Ereignisabdeckung und verbesserte Ratenbegrenzung für Unternehmensintegrationen mit hohem Volumen einführt.

Organisationen in über 180 Ländern verlassen sich auf die AbroadSign-API, um Arbeitsabläufe zur Dokumentensignierung zu automatisieren, die Speditionsverträge, Handelsfinanzierungsakkreditive, Zollerklärungen, Lieferkettenvereinbarungen mit mehreren Parteien und Unternehmensbeschaffungsdokumente umfassen. Die v2-Version bietet native Unterstützung für Massendokumentvorgänge, erweiterte Vorlagenzusammenführung, Blockchain-Zeitstempelverankerung und Funktionen für die Zusammenarbeit in Echtzeit, die gleichzeitige Zeremonien mit mehreren Unterzeichnern von jedem Browser oder Mobilgerät aus ermöglichen, ohne dass die Teilnehmer spezielle Software installieren oder AbroadSign-Konten erstellen müssen. Ganz gleich, ob Sie ein Startup sind, das seinen ersten Kunden-Onboarding-Prozess aufbaut, oder ein Unternehmen, das eine komplette papierbasierte Vertragsinfrastruktur ersetzt, die AbroadSign-API stellt die Bausteine ​​für eine vollständig automatisierte, gesetzeskonforme digitale Signatur auf globaler Ebene bereit.

Authentifizierungs- und Sicherheitskonfiguration

Beim Umgang mit rechtsverbindlichen digitalen Signaturen ist die Sicherung des API-Zugriffs von größter Bedeutung. Die ABSign API v2 verwendet eine auf API-Schlüsseln basierende Authentifizierung in Kombination mit der TLS 1.3-Transportverschlüsselung und stellt so sicher, dass jede Anfrage und Antwort während der Übertragung verschlüsselt und immun gegen Abfangen oder Man-in-the-Middle-Angriffe ist. Alle API-Schlüssel werden über das AbroadSign-Dashboard unter „Einstellungen“ generiert, mit detaillierten Berechtigungsbereichen, die dem Prinzip der geringsten Berechtigung folgen – jede Integration erhält genau die Berechtigungen, die sie benötigt, nicht mehr. Schlüssel werden niemals in URLs, sondern nur in HTTP-Headern übertragen, und Ihre Systeme sollten sie in Umgebungsvariablen oder dedizierten Secrets-Management-Plattformen wie AWS Secrets Manager, HashiCorp Vault oder Azure Key Vault speichern, anstatt sie in Quellcode-Repositorys oder Konfigurationsdateien einzubetten, die an Versionskontrollsysteme übergeben werden.

• Inhaber-Token-Header: Jede API-Anfrage muss Folgendes enthalten: Authorization: Bearer YOUR_API_KEY Kopfzeile. Kodieren Sie API-Schlüssel niemals fest im Quellcode der Anwendung. Verwenden Sie Umgebungsvariablen oder Secrets-Management-Systeme, um Anmeldeinformationen zur Laufzeit einzufügen.
• Durchsetzung von TLS 1.3: Alle API-Verbindungen müssen TLS 1.3 verwenden. Verbindungen, die versuchen, ältere TLS-Versionen zu verwenden, werden mit der Antwort „400 Bad Request“ abgelehnt. Dadurch wird sichergestellt, dass Dokumentinhalte und Signaturdaten niemals über unverschlüsselte Kanäle offengelegt werden.
• Berechtigungsbereiche: API-Schlüssel sind auf bestimmte Vorgänge beschränkt – „documents.read“, „documents.write“, „templates.read“, „templates.write“, „signers.manage“, „webhooks.admin“ und „organization.read“. Weisen Sie für jeden Integrationsanwendungsfall nur die Bereiche zu, die erforderlich sind, um den Explosionsradius zu begrenzen, wenn ein Schlüssel kompromittiert wird.
• Richtlinie zur Schlüsselrotation: Implementieren Sie eine automatisierte Schlüsselrotation nach einem 90-Tage-Zeitplan. Das AbroadSign-Dashboard unterstützt die Schlüsselrotation ohne Ausfallzeiten durch das Konzept von Primär- und Sekundärschlüsseln, sodass Sie Anmeldeinformationen rollen können, ohne die Unterzeichnungsabläufe während der Übertragung zu unterbrechen.
• IP-Zulassungsliste: Unternehmenskonten können den API-Zugriff auf bestimmte IP-Adressen oder CIDR-Bereiche beschränken. Aktivieren Sie die IP-Zulassungsliste auf der Seite „Sicherheitseinstellungen“ für Server-zu-Server-Integrationen, bei denen die aufrufenden IPs bekannt und stabil sind.

„Durch die Implementierung von TLS 1.3 und der Festlegung des API-Schlüsselumfangs konnten die Ergebnisse unserer Sicherheitsüberprüfung auf Null reduziert werden. Die AbroadSign-API wurde unter Berücksichtigung der Sicherheitsanforderungen von Unternehmen entwickelt – sie zeigte sich in jedem Detail des Integrationsprozesses.“

— Leiter Informationssicherheit, globales Rohstoffhandelsunternehmen

Referenz zum Kern-API-Endpunkt

Die v2-API organisiert Funktionen rund um ressourcenorientierte Endpunkte, die auf natürliche Weise den Entitäten in einem digitalen Signatur-Workflow zugeordnet werden: Dokumente, Vorlagen, Unterzeichner, Signaturen, Webhooks und Organisationen. Jede Ressource unterstützt Standard-CRUD-Vorgänge sowie ressourcenspezifische Aktionen wie das Senden von Dokumenten zum Signieren, das Erinnern ausstehender Unterzeichner oder das Herunterladen abgeschlossener Dokumentpakete mit eingebetteten Signaturen und kryptografischen Integritätszertifikaten. Die folgende Tabelle enthält die vollständige Endpunktgruppenreferenz für eine schnelle Integrationsentwicklung.

Endpunktgruppe	Basispfad	Schlüsseloperationen	Häufiger Anwendungsfall
Unterlagen	/documents	Erstellen, Lesen, Auflisten, Aktualisieren, Herunterladen, Archivieren, Löschen	Signieren einleiten, fertige Dokumente abrufen
Vorlagen	/templates	Erstellen, Lesen, Aktualisieren, Löschen, Klonen, Auflisten	Standardisierte Dokumenten-Workflows
Unterzeichner	/signers	Einladen, Einladung erneut senden, abbrechen, Identität überprüfen	Unterzeichnerparteien verwalten
Unterschriften	/signatures	Anwenden, Überprüfen, Statusprüfung, Audit-Trail abrufen	Signaturen ausfüllen und validieren
Webhooks	/webhooks	Erstellen, Auflisten, Löschen, Testen, Aktivieren/Deaktivieren	Ereignisbenachrichtigungen in Echtzeit
Organisationen	/organizations	Lesen, Aktualisieren, Einstellungen, Teammitglieder	Admin- und Compliance-Konfiguration
Audit-Protokolle	/audit-logs	Auflisten, filtern, exportieren, PDF herunterladen	Compliance-Reporting und Forensik
Massenoperationen	/bulk	Stapel erstellen, Status, Stapel abbrechen	Verarbeitung großer Dokumentenmengen

Integrationsmuster für den Dokumentlebenszyklus

Das gängigste API-Integrationsmuster folgt dem Dokumentlebenszyklus von der Erstellung über die Signatursammlung bis zur Archivierung. Dieser End-to-End-Workflow zeigt, wie Ihre Systeme in jeder Phase mit der AbroadSign-API interagieren und so vollständig automatisierte Signierungsprozesse ohne manuelle Eingriffe oder Verwaltungsaufwand ermöglichen. Das Verständnis dieses Lebenszyklus ist für den Aufbau zuverlässiger Integrationen, die Fehlerszenarien reibungslos bewältigen und die Datenkonsistenz über verteilte Systeme hinweg gewährleisten, von entscheidender Bedeutung.

Schritt 1: Dokumenterstellung und Vorlagenfüllung

Beginnen Sie mit der Erstellung eines Dokuments entweder aus einer vorkonfigurierten Vorlage oder aus rohen HTML- oder PDF-Inhalten, die direkt an die API übermittelt werden. Übergeben Sie bei der vorlagenbasierten Erstellung Vorlagenvariablenwerte im Anforderungstext, um den Dokumentinhalt für jeden spezifischen Unterzeichnungsanlass anzupassen und gleichzeitig die Markenkonsistenz und die Standardisierung von Rechtsklauseln aufrechtzuerhalten. Die API antwortet sofort mit einer Dokument-ID, die Ihr System für alle nachfolgenden Vorgänge an diesem Dokument speichert. Die Dokumentenerstellung unterstützt den Batch-Modus, in dem Sie bis zu 500 Dokumente in einem einzigen API-Aufruf an Verarbeitungswarteschlangen übermitteln können, die in Spitzenzeiten des Handels Dutzende oder Hunderte von Signatur-Workflows gleichzeitig initiieren müssen.

• Verwenden Sie POST /documents mit template_id Und template_data zum Erstellen aus einer Vorlage oder zum Senden content_html oder content_pdf_base64 für Rohinhalte.
• Legen Sie das signing_sequence fest Zu sequential für geordnete Mehrparteienunterzeichnung oder parallel wenn alle Parteien gleichzeitig unterschreiben können, um die Wartezeit zu minimieren.
• Angeben expiry_days um zu steuern, wie lange die Signatureinladung aktiv bleibt, bevor das Dokument automatisch abläuft und erneuert werden muss.
• Aktivieren block_download_until_completed um einen vorzeitigen Zugriff auf das Dokument zu verhindern, während eine eventuell erforderliche Unterschrift noch aussteht.

Schritt 2: Unterzeichnerkonfiguration und Workflow-Versand

Fügen Sie nach dem Erstellen eines Dokuments die erforderlichen Unterzeichner hinzu und geben Sie dabei ihre E-Mail-Adressen, Anzeigenamen und ihre Position in der Signaturreihenfolge an. Für Integrationen, die eine verbesserte Identitätssicherung erfordern – wie etwa hochwertige Handelsfinanzierungstransaktionen oder regulierte Import-Export-Dokumentation – aktivieren Sie die identity_verification_required Flag, um eine biometrische oder amtliche ID-Überprüfung vorzuschreiben, bevor die Unterschrift akzeptiert wird. Versenden Sie das Dokument mit einem einzigen API-Aufruf an alle Unterzeichner, und die AbroadSign-Plattform generiert automatisch professionell formatierte E-Mail-Einladungen mit personalisierten Dokumentlinks, Ablaufhinweisen und klaren Unterzeichnungsanweisungen in der bevorzugten Sprache des Empfängers.

• Unterzeichner hinzufügen über POST /documents/{document_id}/signers mit E-Mail, Name und Rolle (signer, witness, oder 抄送 für cc).
• Konfigurieren reminder_schedule um automatisch im 24-Stunden- und 72-Stunden-Intervall Erinnerungs-E-Mails an Unterzeichner zu senden, die noch nicht gehandelt haben.
• Satz redirect_url_after_signed um Unterzeichner nach Abschluss der Unterzeichnung zu einer benutzerdefinierten Vervollständigungsseite in Ihrem System zu führen.
• Aktivieren signer_authentication Als zusätzliche Ebene zur Bestätigung der Unterzeichneridentität ist eine E-Mail-OTP- oder SMS-Verifizierung erforderlich.

Schritt 3: Webhook-gesteuerte Vervollständigung und nachgelagerte Verarbeitung

Das AbroadSign-Webhook-System liefert Echtzeit-Ereignisbenachrichtigungen an Ihren konfigurierten HTTPS-Endpunkt, wenn ein Unterzeichner Maßnahmen ergreift oder sich der Status des Dokumentlebenszyklus ändert. Anstatt die API wiederholt abzufragen, um den Dokumentstatus zu überprüfen – was Ihr Ratenlimit-Kontingent verbraucht und die Latenz erhöht – konfigurieren Sie Webhooks so, dass sie Push-Benachrichtigungen empfangen, die nachgelagerte Prozesse automatisch auslösen. Nach Erhalt der document.completed In diesem Fall ruft Ihr System das vollständige Dokumentpaket ab, einschließlich der signierten PDF-Datei, des kryptografischen Hash-Zertifikats, des Blockchain-Zeitstempelankers und des vollständigen Audit-Trail-Dokuments, das als Hauptbeweis bei Rechtsstreitigkeiten oder Compliance-Prüfungen dient.

---

Referenz zu Webhook-Ereignissen und Echtzeitbenachrichtigungen

Webhooks sind das Rückgrat automatisierter Integrationsarchitekturen. Die ABSign API v2 unterstützt eine umfassende Ereignisabdeckung über den gesamten Dokumentlebenszyklus hinweg, sodass Ihre Systeme sofort reagieren können, wenn Statusänderungen auftreten, anstatt sich auf Abfrageintervalle zu verlassen, die API-Kontingente verschwenden und unnötige Latenz in Ihre Arbeitsabläufe einführen. Jede Webhook-Bereitstellung umfasst eine JSON-Nutzlast mit ereignisspezifischen Daten und einen HMAC-SHA256-Signaturheader, den Ihr Endpunkt vor der Verarbeitung der Benachrichtigung überprüfen muss, um zu verhindern, dass gefälschte Ereignisse nicht autorisierte Aktionen in Ihren Systemen auslösen.

Ereignistyp	Auslösebedingung	Wichtige Payload-Felder	Integrationsantwort
document.created	Neues Dokument zur Plattform hinzugefügt	document_id, Titel, erstellt_at, erstellt_von	Registrieren Sie sich im internen Trackingsystem
document.sent	Dokument an die Unterzeichner versandt	Dokument_ID, Unterzeichner[], Ablaufdatum, Betreff	Status des Workflow-Dashboards aktualisieren
signer.viewed	Der Unterzeichner öffnet den Dokumentlink	document_id, signer_id, view_at, ip_address	Protokollieren Sie Engagement und Trigger-Timer
signer.completed	Der Unterzeichner reicht seine Unterschrift ein	document_id, signer_id, signiert_at, Signatur_hash	Abschluss prüfen, nachgeschaltete Instanz benachrichtigen
document.completed	Alle erforderlichen Unterschriften erhalten	document_id, abgeschlossen_at, download_url, audit_trail_url	Nächsten Workflow-Schritt auslösen
document.expired	Unterzeichnungsfrist überschritten	document_id, Expired_at, signers_pending[]	Erneuerung einleiten oder Einsatzteam benachrichtigen
document.declined	Der Unterzeichner lehnt die Unterschrift ausdrücklich ab	Dokument-ID, Unterzeichner-ID, abgelehntes Datum, Grund	Vorgänge alarmieren und eskalieren
document Voided	Dokument vom Ersteller storniert	document_id, voided_by, voided_at, Grund	Interne Aufzeichnungen schließen und benachrichtigen

Ratenbegrenzungen, Kontingente und Leistungsoptimierung

Die ABSign API v2 erzwingt Ratenbegrenzungen, um Plattformstabilität und eine faire Ressourcenzuteilung für alle API-Konsumenten sicherzustellen. Konten der Standardstufe sind auf 1.000 Anfragen pro Minute und API-Schlüssel begrenzt, während Enterprise-Konten erhöhte Limits erhalten, die auf der Grundlage dokumentierter Integrationsanforderungen und erwarteter Transaktionsvolumina ausgehandelt werden. Der Status der Ratenbegrenzung wird in jeder API-Antwort über das kommuniziert X-RateLimit-Remaining Und X-RateLimit-Reset Antwortheader, sodass Ihre Integration eine proaktive Drosselung implementieren kann, anstatt darauf zu warten, dass 429 Antworten ein Backoff-Verhalten auslösen. Für großvolumige Stapelvorgänge, bei denen Tausende von Dokumenten verarbeitet werden, verwenden Sie die dedizierte /bulk Endpunkte, die speziell für den Massendurchsatz mit höheren Kontingenten pro Minute und geringerem Overhead pro Dokument konzipiert sind.

• Monitor X-RateLimit-Remaining Header für jede Antwort und pausieren Sie Anfragen, wenn sie sich Null nähern, um den Empfang von 429 Too Many Requests-Antworten zu vermeiden, die die Verarbeitung für das Rücksetzfenster anhalten.
• Benutzen Sie die Retry-After Header-Wert, um die genaue Dauer abzuwarten, bevor Anforderungen wieder aufgenommen werden, anstatt willkürliche Schlafintervalle zu implementieren, die möglicherweise zu kurz oder unnötig lang sind.
• Für die Massenverarbeitung von Dokumenten bevorzugen Sie POST /bulk Endpunkte über einzelne POST /documents Anrufe – Massenvorgänge bieten eine bis zu 10-fache Durchsatzverbesserung für Arbeitsabläufe mit hohem Volumen.
• Implementieren Sie einen exponentiellen Backoff mit Jitter für alle Wiederholungslogiken, um vorübergehende serverseitige Fehler zu verarbeiten, ohne die Plattform während der Wiederherstellungsperioden zu überlasten.
• Verwenden Sie Conditional Requests mit If-Modified-Since oder ETag Header beim Abrufen des Dokumentstatus, um unnötige Datenübertragungen zu vermeiden und die Latenz für Statusprüfungen zu reduzieren.

„Wir verarbeiten über 50.000 Frachtdokumente pro Monat über die AbroadSign-API. Der Endpunkt für Massenoperationen in Kombination mit der ordnungsgemäßen Webhook-Verwaltung bedeutet, dass unser gesamter Signatur-Workflow mit einer Latenzzeit von weniger als einer Minute ausgeführt wird – nach dem ersten API-Aufruf völlig unkompliziert.“

— Lead Platform Engineer, globales Speditionsnetzwerk

Offizielle SDK-Pakete und Schnellstart

ABSign unterhält offizielle SDK-Pakete für die am weitesten verbreiteten Programmiersprachen und Frameworks, die jeweils muttersprachliche Datenstrukturen, automatische Wiederholungslogik mit exponentiellem Backoff für vorübergehende Fehler, umfassende Typdefinitionen für Sicherheit bei der Kompilierung und vorkonfigurierte HTTP-Client-Einstellungen bieten, die den API-Sicherheitsanforderungen entsprechen. SDK-Pakete sind Open Source und auf GitHub verfügbar, wo Community-Beiträge für weitere Sprachen willkommen sind und vom AbroadSign-Engineering-Team überprüft werden. Alle offiziellen SDKs werden im Gleichschritt mit der API versioniert, um sicherzustellen, dass die Signaturen und das Verhalten der SDK-Methoden mit den zugrunde liegenden REST-Endpunkten konsistent bleiben.

• Python-SDK: Installieren über pip install abroadsign-api. Vollständige Async/Wait-Unterstützung für moderne Python-Anwendungen mit automatischen Integrationshilfen für Django, FastAPI und Celery-basierte Hintergrundaufgabensysteme. Vollständige Typhinweise und IDE-Unterstützung für die automatische Vervollständigung sind enthalten.
• Node.js / TypeScript SDK: Installieren über npm install abroadsign-api. Vollständig typisiertes TypeScript-Paket mit vollständigen Typdefinitionen für alle Anforderungs- und Antwortobjekte. Beinhaltet native Middleware-Unterstützung für Express.js, Next.js-API-Routen und serverlose Funktionen auf AWS Lambda und Vercel.
• Java / Spring Boot SDK: Maven-Koordinaten sind auf Maven Central verfügbar. Kompatibel mit Spring Boot 2.x und 3.x, mit automatischer Konfigurationsunterstützung und umfassender Javadoc-Dokumentation für Java-Entwicklungsteams in Unternehmen.
• PHP-SDK: PSR-kompatibles Paket, kompatibel mit Laravel, Symfony und eigenständigen PHP 8.1+-Anwendungen. Beinhaltet den Laravel-Dienstanbieter für die nahtlose Konfiguration der Abhängigkeitsinjektion über den Laravel-Dienstcontainer.
• .NET / C# SDK: .NET Standard 2.0-Kompatibilität unterstützt .NET Framework, .NET Core und .NET 5+ unter Windows, Linux und macOS. Beinhaltet die Integration der ASP.NET Core-Abhängigkeitsinjektion mit dem HttpClientFactory-Muster.

---

Erste Schritte: Ihre erste API-Integration

Beginnen Sie Ihre Integration, indem Sie auf die ABSign API-Sandbox-Umgebung zugreifen, die einen voll funktionsfähigen API-Spiegel mit isolierten Testdaten bereitstellt, der sich nicht auf Produktionsdokument-Tresore auswirkt oder auf Produktionskontingente angerechnet wird. Generieren Sie Ihre Sandbox-API-Anmeldeinformationen über das Dashboard unter „Einstellungen“ und beginnen Sie sofort mit der Durchführung von API-Aufrufen, um die Dokumenterstellung, die Unterzeichnerkonfiguration und die Webhook-Bereitstellung in einer sicheren Umgebung zu erkunden. Die Sandbox simuliert automatisch Unterzeichnungszeremonien, sodass Sie vollständige End-to-End-Workflows testen können, ohne darauf warten zu müssen, dass echte menschliche Unterzeichner während der Entwicklungs- und Qualitätssicherungszyklen Maßnahmen ergreifen. Unser interaktives API-Dokumentationsportal bietet einen Live-API-Explorer, mit dem Sie Anfragen direkt im Browser ausführen, Anfrage- und Antwortnutzlasten prüfen und gebrauchsfertige Code-Snippets für jeden Endpunkt in jeder der unterstützten SDK-Sprachen generieren können.

Weitere Informationen zu erweiterten Integrationsmustern, einschließlich Stapelverarbeitung mit hohem Volumen, White-Label-Implementierungen mit mehreren Mandanten und benutzerdefinierten Webhook-Zuverlässigkeitsarchitekturen, finden Sie hier Leitfaden zur Automatisierung des Dokumenten-Workflows Dazu gehören Leistungsoptimierung, Fehlerbehandlungsstrategien und Best Practices für die Unternehmensbereitstellung. Unser Integrations-Engineering-Team bietet Unternehmenskunden außerdem kostenlose technische Architekturüberprüfungssitzungen an, um Ihr Integrationsdesign zu validieren, bevor Sie sich auf das Produktionsverkehrsvolumen festlegen.

Sind Sie bereit, Ihre Integration aufzubauen? Besuchen Sie das API-Dokumentationsportal für vollständige Endpunktreferenzen, SDK-Downloads und funktionierende Codebeispiele. Bei Fragen zu API-Anforderungen für Unternehmen, benutzerdefinierter Integrationsarchitektur oder Produktionsskalierung wenden Sie sich bitte an uns. Kontaktieren Sie unser technisches Integrationsteam um eine kostenlose Architekturüberprüfungssitzung mit einem unserer erfahrenen API-Ingenieure zu vereinbaren.