Skip to main content

​
Entwickler-API & Schnittstellen

Dieses Dokument beschreibt die verfügbaren API-Endpunkte von Lizard. Unsere API folgt REST-Prinzipien und ermöglicht die nahtlose Integration in Ihre IT-Landschaft.
Hinweis: Diese Dokumentation richtet sich an Entwickler und IT-Administratoren.

​
Authentifizierung & API-Token

Alle Anfragen müssen einen gültigen Bearer Token im Header enthalten. 
Authorization: Bearer your-token-here

​
Token erstellen

Sie können API-Tokens direkt in Ihrer Benutzerprofil-Steuerung erstellen:
  1. Navigieren Sie zu Ihrem Benutzer-Profil.
  2. Klicken Sie auf den Reiter oder Menüpunkt API-Tokens.
  3. Wählen Sie Token erstellen und vergeben Sie einen aussagekräftigen Namen (z.B. “Zapier Integration”).
  4. Kopieren Sie den Token sofort, da er nur einmal angezeigt wird.
Lizenzhinweis: Die Nutzung der API ist ein Premium-Feature und steht nicht in allen Lizenzen zur Verfügung. Sollte der Menüpunkt “API-Tokens” nicht sichtbar sein oder die Erstellung fehlschlagen, prüfen Sie bitte, ob Ihre aktuelle Lizenz das Feature ProductFeature::API beinhaltet.

​
Endpunkte

Nutzen Sie Webhooks, um externe Systeme über Ereignisse in Lizard zu informieren.Webhooks auflisten
GET /api/webhooks
Webhook erstellen Erstellt einen neuen Webhook. Die url muss eine gültige HTTPS-URL sein.
POST /api/webhooks
Content-Type: application/json

{
  "url": "https://ihre-domain.de/webhook-endpoint"
}
Webhook löschen
DELETE /api/webhooks/{webhook_id}
Verwaltung von Items und deren Attributen.Items auflisten
GET /api/items
Einzelnes Item abrufen
GET /api/items/{item_id}
Item Attribute abrufen
GET /api/items/{item_id}/attributes
Attribute aktualisieren
PUT /api/items/{item_id}/attributes/{attribute_id}
Content-Type: application/json

{
  "value": "Neuer Wert"
}
Hinweis: Dies unterstützt auch das Hochladen von Dateien für Datei-Attribute (als Multipart-Request).
Zugriff auf Prüfergebnisse und Import-Funktionen.Prüfergebnisse eines Items
GET /api/items/{item_id}/inspection-results
Prüfergebnis erstellen (extern)
POST /api/items/{item_id}/inspection-results
Content-Type: application/json

{
  "title": "Jährliche Prüfung",
  "status": "passed", // oder 'failed', 'visual_defect'
  "last_inspection_at": "2023-10-27",
  "inspection_interval": 12,
  "inspector_name": "Max Mustermann"
}
Massendaten-Import
  • POST /api/inspection_result_import
  • POST /api/item_import
Abruf von globalen Stammdaten für Dropdowns und Validierungen.
  • GET /api/locations: Standorte
  • GET /api/categories: Kategorien
  • GET /api/partners: Partnerfirmen
  • GET /api/qualifications: Qualifikationen
  • GET /api/compliances: Compliance-Vorgaben
  • GET /api/product-services: Produkte & Services
  • GET /api/inspection-categories: Inspektionskategorien
Benutzerverwaltung und Profil.
  • GET /api/user: Das eigene Profil abrufen
  • GET /api/users: Liste der Benutzer (Berechtigung vorausgesetzt)
  • POST /api/users/external: Externe Benutzer anlegen

​
Fehlerantworten

Bei Fehlern gibt die API Standard-HTTP-Statuscodes und eine JSON-Antwort zurück. Beispiel 401 Unauthorized 
{
    "message": "Nicht authentifiziert."
}
Beispiel 422 Validierungsfehler 
{
    "message": "Das Feld 'url' ist erforderlich.",
    "errors": {
        "url": [
            "Das Feld 'url' ist erforderlich."
        ]
    }
}