API v2 — Referenz¶
calServer API v2 ist eine REST-API auf Basis von Laravel 13 mit Bearer-Token-Authentifizierung.
Aktiv weiterentwickelt
API v2 deckt die Kernmodule vollständig ab: Inventar (inkl. Gerätetypen, Status, Kategorien), Kalibrierung inkl. Prüfprozeduren, Prüfschritte und Prüfnormen, Kunden/Kontakte/Standorte inkl. Reservierungs-/Leihkalender, Wartung & Reparaturen, Aufträge (Buchungen) inkl. Preise, Dokumentenverwaltung (DMS) und Notizbuch sowie Support-Tickets & Projekte. Wird laufend erweitert. Rein interne Verwaltungsfunktionen (Benutzer-/Rechteverwaltung, Systemkonfiguration) sind bewusst nicht Teil dieser Kunden-API.
Interaktive Dokumentation¶
Die vollständige API-Referenz ist als interaktive Scalar-Dokumentation verfügbar:
API interaktiv öffnen (Scalar)
OpenAPI Spezifikation¶
| Ressource | Beschreibung |
|---|---|
| openapi-v2.yaml | OpenAPI 3.0 Spezifikation (Download) |
Basis-URL¶
Authentifizierung¶
Siehe Authentifizierung für Token-Erstellung und Berechtigungskonzept.
Feldnamen (API-Name)¶
Unter welchem API-Namen ein Feld ausgegeben wird, ist pro Installation
konfigurierbar. Standard ist der V1-Code (Metrologie-/MetTrack-Code, z.B.
I4206), damit die Integrationen von Bestandskunden weiterlaufen; er lässt sich
in der Feldverwaltung auf den lesbaren DB-Spaltennamen (serial_number)
umstellen. Details und der copy-api-name-Endpunkt:
Feldmapping.
Verfügbare Endpunkte (Übersicht)¶
Die Tabelle zeigt die wichtigsten Ressourcen mit ihrem Basis-Pfad. Die meisten Ressourcen bieten zusätzlich Unterressourcen und Aktionen (Bulk-Operationen, Exporte, PDF-Berichte, Status-/Workflow-Übergänge etc.). Die vollständige Liste mit allen Pfaden, Parametern, Request-Bodies und Response-Schemas ist in der interaktiven Dokumentation verfügbar.
| Ressource | Methoden | Beschreibung |
|---|---|---|
/api/v2/auth/token |
POST | Bearer Token erstellen |
/api/v2/inventories |
GET, POST, PUT, DELETE | Inventar- und Geräteverwaltung |
/api/v2/device-types |
GET, POST, PUT, DELETE | Gerätetypen inkl. Blueprint-Vorlagen |
/api/v2/statuses |
GET, POST, PUT, DELETE | Statuswerte und Status-Übergangsregeln |
/api/v2/categories |
GET, POST, PUT, DELETE | Kategorien für Inventar, Kalibrierung, Reparatur, Buchung |
/api/v2/calibrations |
GET, POST, PUT, DELETE | Kalibrierungen inkl. Messergebnisse und Kalibrierstandards |
/api/v2/calibrations/{ctag}/reports |
GET | Kalibrierzertifikate/Berichte (Erzeugen, Freigeben, Versenden über Unteraktionen) |
/api/v2/procedures |
GET, POST, PUT, DELETE | Prüfprozeduren und Spezifikationen |
/api/v2/calibrations/{ctag}/test-steps |
GET, POST, PUT | Prüfschritte und geführte Messwertaufnahme |
/api/v2/test-standards |
GET, POST, PUT, DELETE | Prüfnormen |
/api/v2/customers |
GET, POST, PUT, DELETE | Kundenverwaltung |
/api/v2/contacts |
GET, POST, PUT, DELETE | Ansprechpartner/Kontakte |
/api/v2/locations |
GET, POST, PUT, DELETE | Standorte |
/api/v2/reservations/calendar |
GET | Reservierungs-/Leihkalender für Leihmessmittel |
/api/v2/repairs |
GET, POST, PUT, DELETE | Wartung und Reparaturen |
/api/v2/bookings |
GET, POST, PUT, DELETE | Aufträge (Buchungen) inkl. Artikelpositionen |
/api/v2/prices |
GET, POST, PUT, DELETE | Preise und Preisgruppen |
/api/v2/documents |
GET, POST, DELETE | Dokumentenverwaltung (DMS) |
/api/v2/signatures |
GET, POST, DELETE | Elektronische Signaturen |
/api/v2/notepads |
GET, POST, PUT, DELETE | Notizbuch-Einträge (Termine, Erinnerungen) |
/api/v2/tickets |
GET, POST, PUT, DELETE | Support-Ticketsystem inkl. Kommentare und Anhänge |
/api/v2/projects |
GET, POST, PUT, DELETE | Support-Projekte (Ticket-Gruppierung) |
/api/v2/audits |
GET | Audit-Trail (Änderungsverlauf, nur lesend) |
/api/v2/search |
GET | Globale Schnellsuche über Inventar, Kunden, Aufträge, Kalibrierungen |
/api/v2/health |
GET | Health Check |
Die vollständige Liste aller Endpunkte mit Parametern, Request-Bodies und Response-Schemas ist in der interaktiven Dokumentation verfügbar.