Entwickler-API & Schnittstellen

Die LizardPro API ermöglicht den programmatischen Zugriff auf deine Daten. Sie folgt REST-Prinzipien und verwendet Standard-HTTP-Methoden sowie JSON für den Datenaustausch.

Diese Dokumentation richtet sich an Entwickler und IT-Administratoren, die LizardPro in ihre eigene Softwarelandschaft integrieren möchten.

Authentifizierung

Alle Anfragen an die API müssen authentifiziert werden. Wir verwenden Bearer Tokens. Füge deinen API-Token in den Authorization Header jeder Anfrage ein:

Authorization: Bearer YOUR_API_TOKEN

Dein API-Token gewährt vollen Zugriff auf dein Benutzerkonto. Teile ihn niemals und veröffentliche ihn nicht in client-seitigem Code (z.B. JavaScript im Browser).

Token erstellen

Gehe zu deinem Benutzer-Profil.
Navigiere zu API-Tokens.
Klicke auf Token erstellen.
Gib dem Token einen Namen (z.B. “Webshop Integration”).
Kopiere den Token. Er wird nie wieder vollständig angezeigt.

Items

Verwalte deine Inventargegenstände (Items).

Items auflisten

Rufe eine paginierte Liste aller Items ab.

string

Sortierung der Ergebnisse. Beispiele: name, -created_at, updated_at.

string

Filtert nach Status (z.B. active, archived).

string

Filtert nach Unternehmens-ID.

string

Filtert nach Item-Nummer.

string

Komma-separierte Liste von Relationen, die in der Antwort enthalten sein sollen. Siehe Relationen einbinden.

GET /api/items

Einzelnes Item abrufen

string

required

Die UUID des Items.

string

Komma-separierte Liste von Relationen. Siehe Relationen einbinden.

GET /api/items/{item}

Relationen einbinden

Über den include-Query-Parameter kannst du gezielt Relationen eines Items laden. So reduzierst du die Antwortgröße auf das, was du tatsächlich benötigst. Verfügbare Relationen:

Relation	Beschreibung
`compliances`	Zugeordnete Compliance-Regelwerke.
`category`	Kategorie des Items.
`inspectionCategory`	Prüfkategorie des Items.
`location`	Standort des Items.
`user`	Zuständiger Benutzer.
`dyntags`	Verknüpfte DynTags.
`dataAttributes`	Alle Eigenschaften mit Felddefinitionen.
`searchableAttributes`	Nur durchsuchbare Eigenschaften.

Mehrere Relationen werden komma-separiert übergeben, z. B. ?include=category,location,dyntags.

GET /api/items?include=category,location,dataAttributes
GET /api/items/{item}?include=compliances,inspectionCategory,dyntags

Item erstellen

Erstellt ein neues Item.

string

required

Der Name des Items. Max. 255 Zeichen.

string

Eine eindeutige Nummer für das Item.

string

required

Die UUID der Kategorie.

string

Die UUID des Standorts.

POST /api/items

Wenn du dataAttributes übergibst, müssen die Schlüssel gültige Attribut-UUIDs sein. Ungültige IDs führen zu einem 422-Fehler mit Hinweis auf die betroffene ID.

DynTag mit Item verknüpfen

Verknüpft einen physischen DynTag (oder externen Code/NFC) mit einem bestehenden Item.

string

required

Die UUID des Items.

string

required

Die Short-ID des DynTags (z.B. kP1IMzcH5z oder die ganze URL).

POST /api/items/link-dyntag

Diese API-Route übernimmt automatisch die externe Validierung und Verknüpfung mit dem DynTag-Dienst. Archivierte Items können nicht verknüpft werden (422 Unprocessable Entity).

Item aktualisieren

string

required

Die UUID des Items.

string

Der neue Name des Items.

string

Der neue Status.

PUT /api/items/{item}

Wenn du dataAttributes übergibst, müssen die Schlüssel gültige Attribut-UUIDs sein. Ungültige IDs führen zu einem 422-Fehler mit Hinweis auf die betroffene ID.

Item Eigenschaften (Attribute)

Verwalte die dynamischen Attribute eines Items.

Attribute auflisten

Gibt alle Attribute eines Items zurück.

string

required

Die UUID des Items.

GET /api/items/{item}/attributes

Attribut aktualisieren

Setzt den Wert eines spezifischen Attributs.

string

required

Die UUID des Items.

string

required

Die UUID des Attributs (nicht des Feldes).

string

required

Der neue Wert. Bei Datei-Uploads muss dies ein Multipart-Request sein.

PUT /api/items/{item}/attributes/{attribute}

Änderungen an Eigenschaften, die über die API vorgenommen werden (z. B. Seriennummern oder Baujahre), werden im Verlauf des Betriebsmittels erfasst. So kannst du jederzeit nachvollziehen, wann welche Werte angepasst wurden – auch wenn die Änderungen aus angebundenen Systemen stammen.

Prüfungen & Ergebnisse

Dokumentiere Prüfergebnisse für Items.

Ergebnisse auflisten

string

required

Die UUID des Items.

string

Filter z.B. nach passed, failed.

GET /api/items/{item}/inspection-results

Ergebnisse erstellen

Fügt einem Item ein neues Prüfergebnis hinzu.

string

required

Die UUID des Items.

string

required

Titel der Prüfung (z.B. “Jahresprüfung 2024”).

string

required

Status des Ergebnisses: passed, failed, visual_defect, oder andere definierte Status.

string

required

Datum und Uhrzeit der Prüfung (ISO 8601).

integer

required

Das Intervall bis zur nächsten Prüfung in Monaten.

string

Name des Prüfers.

binary

Optional: Prüfbericht als Datei (Multipart-Upload).

POST /api/items/{item}/inspection-results

Stammdaten

Hilfreiche Endpunkte für Dropdowns und Validierungen.

Kategorien (Categories)

string

Suche nach Kategorienamen.

GET /api/categories

Standorte (Locations)

string

Suche nach Standortnamen.

GET /api/locations

Standort erstellen

string

required

Name des Standorts.

POST /api/locations

Collaborations (Zusammenarbeiten)

Verwalte Firmen-Zusammenarbeiten und Freigaben. Collaborations auflisten Gibt eine Liste aller bestehenden Zusammenarbeiten inklusive der Partner zurück.

string

Suche nach spezifischer Company ID.

string

Suche im Namen der Collaboration.

GET /api/collaborations

Partner

Verwalte Kunden oder Partnerfirmen.

GET /api/partners

Partner erstellen

string

required

Name der Firma.

string

Kundennummer.

POST /api/partners

Qualifikationen

Liste aller verfügbaren Qualifikationen.

GET /api/qualifications

Produkte & Services

Liste von Produkten und Dienstleistungen.

GET /api/product-services

Felder & Metadaten

Attribut-Felder

Definitionen der dynamischen Felder.

GET /api/attribute-fields

Inspektions-Kategorien

Kategorien für Prüfungen.

GET /api/inspection-categories

Compliance

Verfügbare Compliance-Regelwerke.

GET /api/compliances

Öffentliche Item-Daten

Dieser Endpunkt gibt öffentlich freigegebene Informationen eines Items zurück – ohne Authentifizierung. Er eignet sich für QR-Code-Landingpages, öffentliche Statusseiten oder die Integration in externe Systeme.

GET /i/{item}/json

Die {item} ID entspricht der UUID oder Short-ID des Items, wie sie z. B. auf einem DynTag hinterlegt ist.

Antwortstruktur:

string

Die UUID des Items.

string

Aktueller Status (z. B. active).

string

Bezeichnung des Items.

string

Betriebsmittel-Nummer.

string

Name des zuständigen Benutzers. Wird nur ausgegeben, wenn der anfragende Nutzer angemeldet und dem Betriebsmittel zugehörig ist (gleiches Unternehmen oder über eine Kollaboration verbunden). Für Gäste und fremde Nutzer ist das Feld null.

array

Nicht-archivierte Prüfergebnisse, sortiert nach Prüfdatum (neueste zuerst). Jeder Eintrag enthält title, inspector_name, last_inspection_at, next_inspection_at, status und status_label.

object

Öffentlich sichtbare Eigenschaften des Items als Schlüssel-Wert-Paare (z. B. "Gewicht": "150 kg").

array

Öffentlich freigegebene Dokumente und Dokumente aus öffentlichen Dokumentenordnern. Jeder Eintrag enthält name und url.

Beispielantwort

{
  "id": "a1b2c3d4-...",
  "status": "active",
  "name": "Kran A-12",
  "number": "BM-00123",
  "user": "Max Mustermann",
  "inspections": [
    {
      "title": "Jahresprüfung 2026",
      "inspector_name": "Anna Schmidt",
      "last_inspection_at": "2026-03-15",
      "next_inspection_at": "2027-03-15",
      "status": "passed",
      "status_label": "Bestanden"
    }
  ],
  "public_properties": {
    "Tragfähigkeit": "5000 kg",
    "Baujahr": "2019"
  },
  "public_documents": [
    {
      "name": "Sicherheitsdatenblatt",
      "url": "https://..."
    }
  ]
}

Dieser Endpunkt ist öffentlich zugänglich. Es werden ausschließlich Daten zurückgegeben, die als „öffentlich” markiert sind (öffentliche Eigenschaften, öffentliche Dokumente und Dokumentenordner).

Benutzer

Eigenes Profil

Gibt Informationen über den aktuell authentifizierten Benutzer zurück, einschließlich seiner company_id.

GET /api/user

​Entwickler-API & Schnittstellen

​Authentifizierung

​Token erstellen

​Items

​Items auflisten

​Einzelnes Item abrufen

​Relationen einbinden

​Item erstellen

​DynTag mit Item verknüpfen

​Item aktualisieren

​Item Eigenschaften (Attribute)

​Attribute auflisten

​Attribut aktualisieren

​Prüfungen & Ergebnisse

​Ergebnisse auflisten

​Ergebnisse erstellen

​Stammdaten

​Kategorien (Categories)

​Standorte (Locations)

​Collaborations (Zusammenarbeiten)

​Partner

​Qualifikationen

​Produkte & Services

​Felder & Metadaten

​Attribut-Felder

​Inspektions-Kategorien

​Compliance

​Öffentliche Item-Daten

​Benutzer

​Eigenes Profil

Entwickler-API & Schnittstellen

Authentifizierung

Token erstellen

Items

Items auflisten

Einzelnes Item abrufen

Relationen einbinden

Item erstellen

DynTag mit Item verknüpfen

Item aktualisieren

Item Eigenschaften (Attribute)

Attribute auflisten

Attribut aktualisieren

Prüfungen & Ergebnisse

Ergebnisse auflisten

Ergebnisse erstellen

Stammdaten

Kategorien (Categories)

Standorte (Locations)

Collaborations (Zusammenarbeiten)

Partner

Qualifikationen

Produkte & Services

Felder & Metadaten

Attribut-Felder

Inspektions-Kategorien

Compliance

Öffentliche Item-Daten

Benutzer

Eigenes Profil