Zum Inhalt

Setup

Diese Anleitung beschreibt, wie Sie Zugang zur xTool-API erhalten und erste Requests ausführen.

Voraussetzungen

  • Zugang zur xTool-Webanwendung (URL von Ihrem Administrator).
  • Eine Organisation in xTool. Dokumente und API-Schlüssel gehören zu einer Organisation. Siehe Organisation und Benutzer.
  • Rechte zum Anlegen und Verwalten von API-Schlüsseln (oder einen bestehenden Schlüssel mit passenden Rechten).

API-Schlüssel anlegen

  1. In der xTool-Web-App anmelden.
  2. Die Organisation auswählen, für die Sie die API nutzen wollen.
  3. API öffnen (im Organisationsmenü oder in der Sidebar).
  4. Neuen Schlüssel anlegen: Name angeben (z. B. „Backend-Integration“), Rechte wählen (Dokumente, Formate, Transaktionen, Organisationen, Auth me, Peppol Lookup, PDF, Integrationen nach Bedarf).
  5. Geheimnis direkt nach der Erstellung kopieren — es wird nur einmal angezeigt. Sicher aufbewahren (z. B. in einem Secrets-Manager).

Geheimnis nur einmal sichtbar

Geht das Geheimnis verloren, müssen Sie einen neuen Schlüssel anlegen und den alten widerrufen.

Siehe API-Schlüssel und Logs und Organisation-UI.

Requests ausführen

  • Basis-URL — API-Basis-URL Ihrer Umgebung verwenden (z. B. https://xtool.invoice-portal.de/api/v2).
  • Authentifizierung — API-Schlüssel im Request-Header mitsenden:
1
x-api-key: YOUR_API_KEY
  • Content-Type — für JSON: Content-Type: application/json; für XML: Content-Type: application/xml oder application/xml; charset=utf-8.

Beispiel — Dokumente auflisten:

1
2
curl -X GET "https://xtool.invoice-portal.de/api/v2/documents" \
  -H "x-api-key: YOUR_API_KEY"

Vollständige Endpoint-Liste: API-Referenz.