Zum Hauptinhalt springen

Memida REST-API

Die Memida-API folgt dem REST-Architekturstil und bietet eine standardisierte Schnittstelle zur Plattform. Über HTTP-Methoden wie GET, POST, PUT und DELETE sowie JSON als Datenformat greifen Sie direkt auf Memida-Daten zu.

Typische API-Szenarien:

  • Synchronisation von Stammdaten mit ERP-, MES- oder CMMS-Systemen
  • Anlegen und Aktualisieren von Prüfmitteln aus Fremdsystemen
  • Automatisiertes Reporting in BI-Tools
  • Integration in eigene Portale und interne Anwendungen

API-Zugang einrichten​

Bevor Sie die API nutzen können, benötigen Sie einen API-Token:

  1. Öffnen Sie Ihr Benutzerprofil in Memida.
  2. Navigieren Sie zu den API-Einstellungen.
  3. Erzeugen Sie einen Token und speichern Sie ihn sicher.

Der Token wird bei jedem Request im Header Auth mitgesendet.

Basis-URL​

Alle API-Anfragen erfolgen über:

https://api.memida.de/api/v1

Die vollständige API-Referenz finden Sie unter API-Dokumentation.

Authentifizierung und Standard-Header​

-H "Auth: live IHR_API_TOKEN"
-H "Accept: application/json"

Bei POST- und PUT-Requests kommt zusätzlich hinzu:

-H "Content-Type: application/json"

Praktische Beispiele​

Ersetzen Sie IHR_API_TOKEN durch Ihren Token. Alle UUIDs in den Beispielen sind Platzhalter; verwenden Sie die IDs der passenden Datensätze in Ihrem Memida-Bestand. Falls für Prüfmittel oder Prüfberichte zusätzliche Pflichtfelder konfiguriert sind, ergänzen Sie deren Werte unter customFields gemäß der jeweiligen API-Referenz.

Prüfmittel abrufen​

curl -X GET "https://api.memida.de/api/v1/apparatuses" \
-H "Auth: live IHR_API_TOKEN" \
-H "Accept: application/json"

Mit Suche nach PS-13N, aufsteigender Sortierung nach Ident.Nr. und 50 Einträgen pro Seite:

curl -X GET "https://api.memida.de/api/v1/apparatuses?search=PS-13N&limit=50&page=1&sort=identno&direction=asc" \
-H "Auth: live IHR_API_TOKEN" \
-H "Accept: application/json"

Neues Prüfmittel anlegen​

Für ein neues Prüfmittel sind identno, costcenter_id und apparatus_basedata_id erforderlich. Das folgende Beispiel aktiviert mit checkup: true die Kalibrierpflicht und setzt das Prüfintervall mit check_interval und interval_unit auf zwölf Monate. Verwenden Sie eine bestehende Kostenstelle und passende Geräte-Stammdaten.

curl -X POST "https://api.memida.de/api/v1/apparatuses" \
-H "Auth: live IHR_API_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"identno": "PS-13N-01",
"serial_number": "DM-2024-001",
"costcenter_id": "8b8a2528-c1a4-4bc2-8d57-9ce45b033f65",
"apparatus_basedata_id": "346dbd74-b81d-5e1b-87a1-1a86f4b9e881",
"checkup": true,
"check_interval": 12,
"interval_unit": "months"
}'

Die vollständigen Felder finden Sie in der API-Referenz zum Anlegen eines Prüfmittels.

Prüfung anlegen​

Für einen Prüfbericht sind apparatus_id, checked_at und inspection_result erforderlich. Verwenden Sie für apparatus_id die ID eines vorhandenen Prüfmittels oder die beim Anlegen zurückgegebene ID. checked_at enthält Datum und Uhrzeit; das Beispiel gibt zusätzlich den Zeitzonenoffset an. Das technische Feld inspection_result enthält die Einsatzentscheidung; der Wert operational bedeutet einsatzfähig. Der Typ calibration kennzeichnet eine Kalibrierung und wird für die Berechnung des nächsten Prüfdatums berücksichtigt.

curl -X POST "https://api.memida.de/api/v1/inspections" \
-H "Auth: live IHR_API_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"apparatus_id": "91c2feba-37b0-5f0b-9e98-98c79baa4e41",
"checked_at": "2026-01-29T10:00:00+01:00",
"type": "calibration",
"inspection_result": "operational"
}'

Weitere Werte der Einsatzentscheidung, optionale Felder und Datei-Uploads beschreibt die API-Referenz zum Anlegen eines Prüfberichts.

Stammdaten abfragen​

curl -X GET "https://api.memida.de/api/v1/manufacturers" \
-H "Auth: live IHR_API_TOKEN" \
-H "Accept: application/json"

Prüfintervalle und digitale Kalibrierscheine​

In der Prüfmittelliste enthält checkinterval_number das Prüfintervall als Zeichenfolge aus Zahl und Einheit, beispielsweise "4 months". Fehlt die Zahl oder die Einheit, ist der Wert null. Verwenden Sie für die Weiterverarbeitung die getrennten Felder check_interval und interval_unit.

Unveränderliche DCC-Prüfberichte

Abgeschlossene DCC-Prüfberichte sind auch über die REST-API vor nachträglichem Bearbeiten und Löschen geschützt. Das gilt für in Memida erstellte DCCs und bestätigte DCC-Importe. Prüfen und korrigieren Sie die Angaben daher im Erstellungsablauf beziehungsweise beim Import, bevor Sie den Prüfbericht anlegen.

Die zum abgeschlossenen DCC gehörenden XML- und PDF-Dateien sowie importierte Quelldateien lassen sich nicht separat löschen oder über öffentliche Dateilinks ohne Anmeldung freigeben. Für den Download müssen Sie sich authentifizieren und die erforderlichen Prüfmittel- und Prüfberichtsrechte besitzen. Das elektronische Siegel eines DCC bezieht sich auf die XML-Datei. Die zugehörige PDF-Ansicht ist eine Darstellung ihres Inhalts; ein zusätzlich hochgeladener PDF-Anhang gehört nicht zu diesem Siegel.

Offene Aufgaben am Prüfmittel​

Prüfmittelabfragen in Liste und Detail liefern mit required_actions die offenen Aufgaben am Prüfmittel. Das Feld ist immer ein Array; ohne offene Aufgabe ist es leer. Es kann beispielsweise eine noch zu bearbeitende Mangelmeldung aus einer Ausleihe beschreiben.

Jeder Eintrag enthält id, die stabilen Schlüssel reason und action, einen optionalen Text in note, den Erstellungszeitpunkt created und die optionale Herkunft source. Die Herkunft nennt den Typ inspection oder loan, die UUID des Ursprungs und gegebenenfalls dessen Datum. Verwenden Sie die Schlüssel für die Verarbeitung; frei formulierte Notizen sind keine Statuscodes.

Integrationen mit strikt definierten Antwortmodellen müssen das zusätzliche Feld berücksichtigen. Die Erweiterung liefert Handlungsbedarf am Prüfmittel; sie führt keine öffentliche REST-API zur Anlage oder Bearbeitung von Ausleihvorgängen ein.

Weiterführende Dokumentation​