API-Schlüssel und Logs

Wofür API-Schlüssel da sind

API-Schlüssel ermöglichen den Zugriff auf die REST API ohne bei jeder Anfrage einen Benutzer-Login. Jeder Schlüssel ist an eine Organisation (die Quellorganisation) gebunden. Sie werden für Integrationen, Skripte und jeden automatisierten Zugriff genutzt.

Anfragen werden im Kontext der aktiven Organisation ausgeführt — der gleichen Quellorganisation oder einer ihrer Tochterorganisationen. Wie das funktioniert: Organisation und Benutzer. Erste Schritte und Endpunkte: Einrichtung und API-Referenz.

Schlüssel in Anfragen verwenden

Senden Sie den API-Schlüssel in jeder Anfrage an die API. Üblich ist ein Header:

Header: x-api-key: YOUR_API_KEY

Details zu Authentifizierung und ggf. Header für die aktive Organisation: API-Referenz.

API-Basis-URL

Für das Testsystem verwenden Sie https://xtool-test.invoice-portal.de/api; für Produktiv https://xtool.invoice-portal.de/api. Schlüssel werden in der Webanwendung unter API innerhalb der Organisation erstellt.

Schlüssel anlegen und verwalten

Wo — In der Webanwendung den Bereich API (innerhalb der Organisation) öffnen. Dort können Sie einen neuen Schlüssel anlegen und bestehende löschen.
Beim Anlegen — Nach dem Anlegen wird das Geheimnis einmal angezeigt. Kopieren und an einem sicheren Ort aufbewahren — es wird später nicht mehr angezeigt.
Bereich — Schlüssel sind an eine Organisation gebunden. Sie können mehrere Schlüssel anlegen (z. B. für verschiedene Integrationen oder Umgebungen). In der Liste werden bestehende Schlüssel nur teilweise angezeigt (z. B. nur die letzten Zeichen).

Geheimnis sicher aufbewahren

Kopieren und bewahren Sie das API-Schlüssel-Geheimnis beim ersten Anzeigen auf. Später ist es nicht mehr abrufbar. Nicht in die Versionskontrolle legen und nicht im Client-Code verwenden.

API-Logs

Jeder API-Aufruf wird protokolliert (welcher Schlüssel, welche Methode, Zeit) für Prüfung und Fehlersuche. In der Webanwendung können Sie die Logs unter Nutzung oder API-Logs einsehen. Siehe Nutzung.