Optimus Integration API
Verwenden Sie die Optimus Integration API, wenn Ihre Anwendung JSON-Anfragen direkt über HTTPS senden kann.
Die API validiert USt-IdNrn., vergleicht Unternehmensstammdaten, gibt korrigierte Werte zurück, sofern verfügbar, und kann PDF-Berichtsmetadaten für Validierungsläufe erstellen.
Basis-URLs
| Umgebung | Basis-URL |
|---|---|
| Produktion | https://app.optimussoftware.de |
| Test | https://dev.app.optimussoftware.de |
Authentifizierung
Erstellen Sie ein Personal Access Token in der Optimus-Web-App unter Settings > API Interface > API Tokens.
Authentifizieren Sie jede Anfrage, indem Sie das Token im Header Authorization mit dem Bearer-Schema senden:
Authorization: Bearer <token>
Das Token-Secret wird nur einmal bei der Erstellung angezeigt. Speichern Sie echte tok_optimus_-Werte nicht in Quellcode, Logs, Issue-Trackern, Screenshots oder Dokumentationsbeispielen.
Welchen Endpoint soll ich verwenden?
| Ziel | Endpoint |
|---|---|
| Eine USt-IdNr. schnell auflösen | GET /api/v1/integration/vat/resolve |
| USt-IdNrn. anhand von Unternehmensdaten finden | POST /api/v1/integration/vat/lookup |
| Einen oder mehrere Datensätze validieren und auf das Ergebnis warten | POST /api/v1/integration/vat/validations |
| Einen längeren Validierungslauf starten und bis zum Abschluss abfragen | POST /api/v1/integration/vat/validations/async |
| Einen Validierungslauf später abrufen | GET /api/v1/integration/vat/validations/{operationId} |
Verwenden Sie die asynchrone Validierung für automatisierte Importe, größere Batches, retry-sichere Integrationen und Workflows, die PDFs erzeugen.
Authentication
- HTTP: Bearer Auth
Fügen Sie Ihr Personal Access Token ein. Anfragen werden mit Authorization: Bearer <token> gesendet.
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Bearer format: | PAT |