Skip to main content

​
Entwickler-API & Schnittstellen

Die LizardPro API ermöglicht den programmatischen Zugriff auf Ihre 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ügen Sie Ihren API-Token in den Authorization Header jeder Anfrage ein: 
Authorization: Bearer YOUR_API_TOKEN
Ihr API-Token gewährt vollen Zugriff auf Ihr Benutzerkonto. Teilen Sie ihn niemals und veröffentlichen Sie ihn nicht in client-seitigem Code (z.B. JavaScript im Browser).

​
Token erstellen

  1. Gehen Sie zu Ihrem Benutzer-Profil.
  2. Navigieren Sie zu API-Tokens.
  3. Klicken Sie auf Token erstellen.
  4. Geben Sie dem Token einen Namen (z.B. “Webshop Integration”).
  5. Kopieren Sie den Token. Er wird nie wieder vollständig angezeigt.

​
Items

Verwalten Sie Ihre Inventargegenstände (Items).

​
Items auflisten

Rufen Sie eine paginierte Liste aller Items ab.
​
sort
string
Sortierung der Ergebnisse. Beispiele: name, -created_at, updated_at.
​
filter[status]
string
Filtert nach Status (z.B. active, archived).
​
filter[company_id]
string
Filtert nach Unternehmens-ID.
​
filter[number]
string
Filtert nach Item-Nummer.
GET /api/items

​
Einzelnes Item abrufen

​
item
string
required
Die UUID des Items.
GET /api/items/{item}

​
Item erstellen

Erstellt ein neues Item.
​
name
string
required
Der Name des Items. Max. 255 Zeichen.
​
number
string
Eine eindeutige Nummer für das Item.
​
category_id
string
required
Die UUID der Kategorie.
​
location_id
string
Die UUID des Standorts.
POST /api/items
Wenn Sie dataAttributes übergeben, 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.
​
item_id
string
required
Die UUID des Items.
​
dyntag_short_id
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

​
item
string
required
Die UUID des Items.
​
name
string
Der neue Name des Items.
​
status
string
Der neue Status.
PUT /api/items/{item}
Wenn Sie dataAttributes übergeben, 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)

Verwalten Sie die dynamischen Attribute eines Items.

​
Attribute auflisten

Gibt alle Attribute eines Items zurück.
​
item
string
required
Die UUID des Items.
GET /api/items/{item}/attributes

​
Attribut aktualisieren

Setzt den Wert eines spezifischen Attributs.
​
item
string
required
Die UUID des Items.
​
attribute
string
required
Die UUID des Attributs (nicht des Feldes).
​
value
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 können Sie jederzeit nachvollziehen, wann welche Werte angepasst wurden – auch wenn die Änderungen aus angebundenen Systemen stammen.

​
Prüfungen & Ergebnisse

Dokumentieren Sie Prüfergebnisse für Items.

​
Ergebnisse auflisten

​
item
string
required
Die UUID des Items.
​
filter[status]
string
Filter z.B. nach passed, failed.
GET /api/items/{item}/inspection-results

​
Ergebnisse erstellen

Fügt einem Item ein neues Prüfergebnis hinzu.
​
item
string
required
Die UUID des Items.
​
title
string
required
Titel der Prüfung (z.B. “Jahresprüfung 2024”).
​
status
string
required
Status des Ergebnisses: passed, failed, visual_defect, oder andere definierte Status.
​
last_inspection_at
string
required
Datum und Uhrzeit der Prüfung (ISO 8601).
​
inspection_interval
integer
required
Das Intervall bis zur nächsten Prüfung in Monaten.
​
inspector_name
string
Name des Prüfers.
​
file
binary
Optional: Prüfbericht als Datei (Multipart-Upload).
POST /api/items/{item}/inspection-results

​
Stammdaten

Hilfreiche Endpunkte für Dropdowns und Validierungen.

​
Kategorien (Categories)

​
filter[name]
string
Suche nach Kategorienamen.
GET /api/categories

​
Standorte (Locations)

​
filter[name]
string
Suche nach Standortnamen.
GET /api/locations
Standort erstellen
​
name
string
required
Name des Standorts.
POST /api/locations

​
Collaborations (Zusammenarbeiten)

Verwalten Sie Firmen-Zusammenarbeiten und Freigaben. Collaborations auflisten Gibt eine Liste aller bestehenden Zusammenarbeiten inklusive der Partner zurück.
​
filter[company_id]
string
Suche nach spezifischer Company ID.
​
filter[name]
string
Suche im Namen der Collaboration.
GET /api/collaborations

​
Partner

Verwalten Sie Kunden oder Partnerfirmen. 
GET /api/partners
Partner erstellen
​
company
string
required
Name der Firma.
​
customer_number
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

​
Benutzer

​
Eigenes Profil

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