Einführung

@sonar/sdk ist das offizielle TypeScript SDK für die Sonar Document Migration API. Es bietet eine typsichere, ergonomische Schnittstelle zur Verwaltung von Dokumenten und Berechtigungen.

Was Sie tun können

• Dokumente — Auflisten, hochladen, herunterladen, löschen (einzeln & batch), als ZIP exportieren und vorsignierte Download-URLs generieren
• Signaturketten — Verfolgen Sie die vollständige Signaturhistorie von Dokumenten
• Bereiche & Berechtigungen — API-Schlüssel-Berechtigungen und verfügbare Bereiche abfragen

Hauptmerkmale

• Vollständige TypeScript-Unterstützung mit kompletten Typdefinitionen
• ESM- und CommonJS-Modulformate
• Automatische Authentifizierung, Fehlerbehandlung und Antwort-Entpackung
• Client-seitige Validierung vor Netzwerkanfragen
• Unterstützung für Buffer, Blob und ReadableStream Datei-Uploads

Voraussetzungen

• Node.js >= 18.0.0
• Paket: @sonar/sdk (v0.1.0)
• Lizenz: MIT

API-Basis-URL

https://session.sonar.de/{instanceName}/api/sdk/v1/

Nächste Schritte

• Erste Schritte — Installieren Sie das SDK und führen Sie Ihren ersten API-Aufruf durch
• Konfiguration — Erfahren Sie mehr über alle Konfigurationsoptionen
• Dokumente — Vollständige Referenz der Dokumentenoperationen