Lesende Schnittstelle Portal

Die öffentliche Read-Only API des Betriebsmittelportals ermöglicht Kunden den automatisierten Zugriff auf sämtliche im Portal verfügbaren Daten. Damit entfällt das manuelle Exportieren, Kopieren oder Pflegen von Informationen in Drittsystemen.

Die API bietet strukturierte, standardisierte Daten – ideal für Integrationen in ERP-Systeme, BI-Lösungen, Dashboards oder individuelle Anwendungen.

Beispiele:

Betriebsmitteldaten (Equipment) ins ERP übernehmen
Prüfungsdaten (Inspections) im BI-Dashboard anzeigen
Standortdaten (Locations) in eigene Übersichten einbinden

Hinweis:
Die API ist fest definiert, standardisiert und reiner Lesezugriff.
Individuelle Erweiterungen oder Schreibzugriff sind nicht vorgesehen.

Vorteile unserer Schnittstelle 

Automatisierung: Kein manuelles Exportieren oder Kopieren mehr nötig. 
Einfache Integration in eigene Tools (z. B. ERP, BI, Reporting)
Standardisiertes Format – sofort einsatzbereit
Aktuelle Daten: Immer auf dem tagesaktuellen Stand – direkt aus dem Portal. 
Schneller Start: Klare Dokumentation mit allen Feldoptionen, Erklärungen und Versionierung
Sicher & performant: Zugriff über HTTPS und API-Key. Token-Generierung benutzerbasiert und inkl. Monitoring und Versionierung.

Typische Fragen rund um die Schnittstelle

Frage	Antwort
Kann ich eigene Felder hinzufügen?	Die Schnittstelle ist standardisiert und kann nicht angepasst werden. Dennoch gibt es die Möglichkeit, die bestehenden Felder für individuelle Bedarfe zu verwenden. Es werden alle Felder aus dem Portal exportiert am Equipment, technischen Platz und an der Prüfung. Nutzen Sie die Felder gern für Ihre individuellen Bedarfe und mappen Sie beim Übermitteln in Ihr System mit dem gewünschten Feld. z.B. das offene Feld „Beschreibung“ am Equipment.
Kann ich Daten ins Portal schreiben?	Nein, die API ist aktuell nur lesend. Die Daten können also nur abgerufen werden
Wie erhalte ich Zugang?	Kontaktieren Sie gern Ihren Carl Stahl Ansprechpartner, um ein Erstgespräch zu vereinbaren und im Anschluss vollständige Dokumentation und Zugriff auf die Generierung eines Tokens für Ihre Organisation zu erhalten.
Wie sieht die Authentifizierung aus?	Sie erhalten über Ihren Carl Stahl Ansprechpartner im Rahmen der Projektierung einen personalisierten Zugang zum Backend, wo Sie eigenständig einen Token für die API generieren können, der nur für Sie zugänglich ist. So wird ein Zugriff von anderen Personen komplett ausgeschlossen. Zugriff ist dann nur in Ihrer Organisation (Mandant) möglich.
Gibt es ein Monitoring?	Interne Monitoring-Prozesse, eine Versionierung der API sowie kontinuierliche Tests sichern die durchgehende Verfügbarkeit der API.
Wie werden Updates gehandhabt? Gibt es eine Versionierung?	Die API ist versioniert. Bei neuen Updates wird mit proaktiver Ankündigung auf die jeweils neue Version umgestellt, sodass bestehende Integrationen weiterhin stabil funktionieren. Die Versionierung ist Teil der URL und ermöglicht eine klare Trennung zwischen verschiedenen Entwicklungsständen der API. Kunden werden proaktiv über neue Versionen der API informiert.
Wie sieht das Thema Datenschutz und Datensicherheit aus?	Wir stellen sicher, dass keine unbefugten Zugriffe im Rahmen der API erfolgen: siehe unten.
Gibt es einen Notfallprozess, falls ein Token kompromittiert wird?	Der Zugriff über den Token kann vom Kunden eigenständig innerhalb weniger Minuten gesperrt werden oder ein neuer Token generiert werden. Dies kann ebenso über den Carl Stahl Ansprechpartner direkt erfolgen.
Ist die Schnittstelle nur auf deutsch verfügbar?	Nein, in allen Sprachen. Im Token ist die Sprache der API wählbar.

Datenschutz und Datensicherheit

Wir stellen sicher, dass keine unbefugten Zugriffe im Rahmen der API erfolgen:

1) Zugriffsbeschränkung / Mandantenschutz

Jeder Kunde kann ausschließlich Daten der eigenen Organisation abrufen.
Mandantentrennung ist technisch erzwungen.
Authentifizierung und Berechtigungsprüfung durch Carl Stahl

2) Authentifizierung / API-Key

Zugriff erfolgt über einen kundenspezifischen API-Schlüssel (Token).
Token wird nur einmal bei Erstellung angezeigt, danach nicht wieder abrufbar.
Token-Erstellung ist nur möglich, wenn ein Carl Stahl Mitarbeiter Rechte freischaltet.

3) Sicherheit der Datenübertragung

Alle API-Endpunkte werden ausschließlich über HTTPS bereitgestellt.
Authentifizierungsdaten werden nicht unverschlüsselt übertragen.

4) Read-Only-Verarbeitung

API liefert ausschließlich Exportdaten (GET).
Keine Möglichkeit zur Änderung, Löschung oder Manipulation von Daten.

5) Art der übertragenen Daten

Nur technische Betriebsmitteldaten, Standorte und Prüfungsinformationen.
Keine personenbezogenen Kundendaten.

6) Datenschutz

Keine Speicherung oder Verarbeitung zusätzlicher Kundendaten durch die API.
Übertragung beschränkt auf Daten, die der Kunde bereits im Portal einsehen darf.
DSGVO-konform durch o.g. Maßnahmen u.a. eindeutiger Mandantentrennung und keine personenbezogenen Mitarbeiterdaten von Kunden

7) Schnelles Widerrufen des Tokens

Wenn ein Token kompromittiert wird, kann der Kunde innerhalb weniger Minuten den Token widerrufen und einen neuen unabhängigen Token generieren.
Dies kann ebenso über den Carl Stahl Support erfolgen.

Sie sind interessiert?

Kontaktieren Sie gern Ihren direkten Carl Stahl Ansprechpartner, um einen Termin zur Projektierung zu vereinbaren.

Technische Details, welche Daten abgerufen werden können

Eine ausführliche Dokumentation als Swagger File sowie eine umfassende Beschreibung der möglichen Felder und Eingabe-Optionen erhalten Sie mit Start der Projektierung.

Unsere Read-Only-API ist in 3 Bereiche untergliedert. Es können Technische Plätze und deren Details, Equipments und deren Details sowie Prüfungen und deren Details und Anhänge abgerufen werden. Technisch ist die API in folgende Aufrufe untergliedert:

Technischer Platz-API

CODE
```
Get all latest functional locations based on sent timestamp paged
```
- Hole alle neuen Technischen Plätze (IDs) seit dem Zeitstempel, der übermittelt wird.
CODE
```
Get one functional location details
```
- Hole alle Details zu diesen Technischen Plätzen

Equipments API

CODE
```
Get all latest equipments based on sent timestamp paged
```
- Hole alle neuen Equipments (IDs) seit dem Zeitstempel, der übermittelt wird.
CODE
```
Get equipment details
```
- Hole alle Details zu diesen Equipments

Prüfungs API

CODE
```
Get all latest equipments with inspections based on sent timestamp
```
- Hole alle neuen Prüfungen (IDs) seit übermitteltem Zeitstempel.
CODE
```
Get inspection details
```
- Hole alle Details zu diesen Prüfungen
CODE
```
Get inspection certificate
```
- Hole das Zertifikat zu diesen Prüfungen
CODE
```
Get inspection media
```
- Hole hinzugefügte Medien zu diesen Prüfungen (Bilder und Dokumente)