Zum Inhalt springen
Sonar SDK

Erste Schritte

Installieren Sie das SDK und führen Sie Ihren ersten API-Aufruf in wenigen Minuten durch.

Installation

Terminal-Fenster
# npm
npm install @sonar/sdk


# yarn
yarn add @sonar/sdk


# pnpm
pnpm add @sonar/sdk

Peer-Abhängigkeiten: Keine Laufzeit-Abhängigkeit: axios ^1.13.4 (gebündelt)

Schnellstart

import { SonarSDK } from '@sonar/sdk';


// Client initialisieren
const sdk = new SonarSDK({
  apiKey: 'sk_your_api_key_here',
  instanceName: 'your-instance',
});


// Dokumente auflisten
const { docs, totalDocs, totalPages } = await sdk.documents.list({ limit: 20 });
console.log(`${totalDocs} Dokumente auf ${totalPages} Seiten gefunden`);


// Ein Dokument herunterladen
const { data, filename, contentType } = await sdk.documents.download('doc_123');


// Ein Dokument hochladen
import { readFileSync } from 'fs';
const file = readFileSync('./contract.pdf');
const uploaded = await sdk.documents.upload({
  file,
  filename: 'contract.pdf',
  contentType: 'application/pdf',
  classification: 'uploaded',
  uploadFrom: 'user-documents',
});
console.log(`Hochgeladen: ${uploaded.id}`);


// Ein Dokument löschen
const { documentId } = await sdk.documents.delete('doc_456');
console.log(`Gelöscht: ${documentId}`);


// Eine vorsignierte Download-URL abrufen
const { url } = await sdk.documents.getDownloadUrl('doc_123', { expiresIn: 600 });
console.log(`Download-URL: ${url}`);


// Berechtigungen prüfen
const { scopes } = await sdk.scopes.getAllowed();
console.log('Erlaubte Bereiche:', scopes);

SDK-Ressourcen

Das SDK stellt zwei Ressourcen-Namensräume bereit:

RessourceZugriffBeschreibung
Dokumentesdk.documentsDokumente verwalten — auflisten, abrufen, hochladen, herunterladen, vorsignierte URLs, löschen, Batch-Löschung, exportieren, Signaturketten
Bereichesdk.scopesAPI-Schlüssel-Berechtigungen und verfügbare Bereiche abfragen

Nächste Schritte