API-Referenz

Schnellreferenztabelle für alle SDK-Methoden.

Methodenreferenz

Methode	HTTP	Pfad	Gibt zurück
`sdk.documents.list(params?)`	`GET`	`/api/sdk/v1/documents`	`ListDocumentsResponse`
`sdk.documents.get(id)`	`GET`	`/api/sdk/v1/documents/:id`	`Document`
`sdk.documents.download(id)`	`GET`	`/api/sdk/v1/documents/:id/download`	`DownloadResponse`
`sdk.documents.getDownloadUrl(id, params?)`	`GET`	`/api/sdk/v1/documents/:id/download-url`	`DownloadUrlResponse`
`sdk.documents.upload(params)`	`POST`	`/api/sdk/v1/documents/upload`	`Document`
`sdk.documents.delete(id)`	`DELETE`	`/api/sdk/v1/documents/:id`	`DeleteDocumentResponse`
`sdk.documents.batchDelete(params)`	`POST`	`/api/sdk/v1/documents/delete`	`BatchDeleteResponse`
`sdk.documents.export(params)`	`POST`	`/api/sdk/v1/documents/export`	`DownloadResponse`
`sdk.documents.getSignatureChain(id)`	`GET`	`/api/sdk/v1/documents/:id/signature-chain`	`SignatureChain`
`sdk.scopes.getAllowed()`	`GET`	`/api/sdk/v1/scopes-allowed`	`AllowedScopesResponse`
`sdk.scopes.getAll()`	`GET`	`/api/sdk/v1/scopes-allowed/all`	`ScopeCategory[]`

Basispfad

Alle Ressourcen-Endpunkte befinden sich unter /api/sdk/v1/:

Ressource	Basispfad
Dokumente	`/api/sdk/v1/documents`
Bereiche	`/api/sdk/v1/scopes-allowed`

Antwort-Umschlag

Die Sonar API umhüllt erfolgreiche Antworten in einem Standard-Umschlag:

{
  "success": true,
  "data": { ... },
  "message": "Optionale Nachricht"
}

Das SDK entpackt diesen Umschlag automatisch — Sie erhalten immer direkt die data-Nutzlast. Bei binären Antworten (Downloads, Exporte) wird der rohe ArrayBuffer unverändert zurückgegeben.

Datumsverarbeitung

Wenn die Parameter fromDate oder toDate ein Date-Objekt erhalten, konvertiert das SDK es automatisch in einen ISO 8601-String über .toISOString(). String-Werte werden unverändert weitergegeben.