Authentifizierung

Echte Validierungsläufe erfordern ein Bearer Token. Dry Runs rufen die API nicht auf und benötigen kein Token.

Token Erstellen

Die CLI verwendet dieselben Personal Access Tokens wie die Integration API.

In der Optimus Web-App:

Öffnen Sie Settings.
Wählen Sie den Tab API Interface.
Klicken Sie in API Tokens auf Create Token.
Geben Sie einen beschreibenden Token Name ein, zum Beispiel Nightly customer VAT check.
Fügen Sie optional Allowed IP ranges für die Maschine oder das Netzwerk hinzu, auf dem die CLI laufen wird.
Klicken Sie auf Create Token.
Kopieren Sie das Token sofort.

Das Token-Secret wird nur einmal angezeigt. Nach der Erstellung zeigt Optimus das Token-Präfix und maskierte Zeichen, aber nicht das vollständige Secret.

Erlaubte IP-Bereiche akzeptieren exakte IPv4-Adressen und IPv4-CIDR-Bereiche. Lassen Sie das Feld nur leer, wenn das Token von jeder IP-Adresse aus verwendet werden darf.

Token Konfigurieren

Setzen Sie das Token mit OPTIMUS_TOKEN:

export OPTIMUS_TOKEN="<token>"

Oder übergeben Sie es direkt:

optimus check customers.csv --map mapping.yml --standard --token "<token>"

Die Umgebungsvariable ist vorzuziehen, weil sie verhindert, dass das Token direkt in der Befehlshistorie landet.

Fügen Sie echte tok_optimus_-Tokenwerte nicht in Skripte ein, die in Source Control committet werden, und nicht in Screenshots, Support-Tickets oder Dokumentationsbeispiele.

API-Ziel

Die CLI löst das API-Ziel in dieser Reihenfolge auf:

--base-url
OPTIMUS_BASE_URL
--env oder OPTIMUS_ENV
Produktions-URL

Produktions-API verwenden:

optimus check customers.csv --map mapping.yml --standard --env prod

Produktion verwendet:

https://app.optimussoftware.de/

Test-API verwenden:

optimus check customers.csv --map mapping.yml --standard --env test

Test verwendet:

https://dev.app.optimussoftware.de/

Vollständige Base URL überschreiben:

optimus check customers.csv --map mapping.yml --standard --base-url "https://example.test/"

--base-url muss eine absolute URL sein.