Automatisierung per API

Anwendungsfall für Entwickler und Systeme, die xTool über die REST-API anbinden: Dokumente erstellen, versenden, validieren, konvertieren, auflisten und Status abfragen — programmatisch.

Was Sie tun: API-Schlüssel mit passenden Rechten anlegen → Dokument-API (und optional Format- und Transaktions-APIs) für Upload, Versand, Validierung usw. aufrufen.

Schritte

1. API-Schlüssel anlegen

In der Web-App: API (unter Ihrer Organisation) → Schlüssel anlegen → erlaubte Methoden vergeben (Dokumente: Liste, Upload, Versand; Formate: Validierung, Transform; Transaktionen, Organisationen, Auth me, Peppol Lookup, PDF nach Bedarf) → Geheimnis einmal kopieren. Siehe Setup und API-Schlüssel und Logs.

2. Authentifizierung

API-Schlüssel bei jedem Request mitsenden, z. B. im Header:

1	`x-api-key: YOUR_API_KEY`

Siehe API-Referenz.

3. API nutzen

Aktion	Wie
Dokument hochladen	POST Upload Modell oder Upload XML mit Dokument-Body. Siehe Dokumente erstellen.
Dokument versenden	POST Versand mit `transaction_type` (`send.peppol` oder `send.email`); bei E-Mail zusätzlich `email` und optional `lang`. Siehe Per Peppol versenden, Per E-Mail versenden.
Dokumente auflisten und abrufen	GET Liste (Filter: Richtung, Status usw.) und GET nach ID für Details.
Validieren und konvertieren	Format-API vor oder nach dem Upload nach Bedarf. Siehe Validieren und konvertieren.

Vollständige Endpoint-Liste: API-Referenz (Scalar oder Swagger).

← Anwendungsfälle