Edge-API-Referenz

Diese Referenz trennt Cloud-Gateway und lokale SPS-Schnittstellen. Nutze die Adressen deiner Bereitstellung. Lokale SPS-Aufrufe und Cloud-Aufrufe haben unterschiedliche Ziele.

Cloud-Gateway

Basispfad: /api/edge am API-Ursprung deiner Bereitstellung. Registrierung nutzt ein einmaliges Token. Authentifizierung tauscht apiKey und hardwareId gegen Zugriff- und Erneuerungstokens. Zugriffstokens gelten 15 Minuten, Erneuerungstokens sieben Tage und unterliegen weiterhin aktuellen Connector- und Dienstrechten.

Authorization: Bearer <access-token>
Content-Type: application/json

Methode	Pfad	Zweck / Rechte
POST	/register	Mit registrationToken, hardwareId und optionalen Laufzeitangaben registrieren; wartender Connector und API-Schlüssel.
POST	/auth	Genehmigten Connector mit Schlüssel und Hardware-ID authentifizieren.
POST	/auth/refresh	Mit refreshToken erneuern.
POST	/heartbeat	Status, Konfiguration, offene Aktionen; Integrationsleserecht.
GET	/config	Konfiguration; Integrationsleserecht.
GET	/sync/workcenters	Zuweisungen und Zuordnungen; Arbeitsplatzleserecht.
GET	/sync/orders	Freigegebene/laufende Aufträge; Auftragsleserecht.
POST	/events/production	Fortschritt; entsprechende Meldeberechtigung.
POST	/events/status	Arbeitsplatzstatus; Störungsmeldeberechtigung.
POST	/events/malfunction	Störungsmeldung; entsprechende Berechtigung.
POST	/print-jobs/:id/status	Druckergebnis; Etikettendruckberechtigung.

Das Token bindet Mandant, Standort und Umgebung. Zuweisung und aktuelle Dienstrechte werden weiter geprüft. Übergebene Bereiche können diese Bindung nicht ersetzen.

Auftragssynchronisierung akzeptiert since in Unix-Millisekunden, limit (Standard 100) und gegebenenfalls zugewiesene Arbeitsplatzcodes. Die Antwort enthält orders, syncTimestamp und hasMore. Diese Werte allein liefern keinen verlustfreien Seitenabruf für große veränderliche Bestände. Prüfe die bereitgestellte Synchronisierungsstrategie.

Produktionsmeldung

Das Gateway erwartet ein events-Array. quantityProduced ist im aktuellen Handler der neue Gesamtstand, keine zusätzliche Menge:

{
  "events": [{
    "eventId": "example-event-001",
    "orderNumber": "PO-DEMO-001",
    "workCenterId": "<zugewiesene-arbeitsplatzreferenz>",
    "quantityProduced": 12,
    "timestamp": "2026-10-13T08:00:00Z"
  }]
}

Nutze die vom jeweiligen Handler erwartete Identität. Die aktuelle Zuweisungsprüfung verwendet Datenbankreferenzen, während die Auftragssynchronisierung fachliche Arbeitsplatzcodes liefert. Beides ist nicht austauschbar. Prüfe die Zuordnung zum Zielauftrag.

Eine 200-Antwort enthält success und Fehler je Ereignis. Prüfe jedes Ergebnis. Meldungen können Auftragsstatuswechsel auslösen. quantityScrap wird im aktuellen Produktionshandler bestätigt, ohne ein Ausschussbuch zu führen. Nutze für operative Nachweise den Ausschussablauf. Die separate lokale Methode ReportScrap puffert ein Ausschussereignis. Der aktuelle Uplink markiert diesen Typ jedoch als erfolgreich, ohne ihn an einen Cloud-Ausschusshandler zu übertragen. Lokale Annahme ist deshalb kein operativer Ausschussnachweis. Ereigniskennungen garantieren keine genau einmalige Anwendung.

Statusereignisse akzeptieren operational, idle oder malfunctioning. Störungen verwenden workCenterId und action: "start" oder action: "end" sowie optional reasonId, details und timestamp. Eine Endmeldung benötigt die malfunctionId der zugehörigen Startmeldung. Prüfe Einzelantworten.

Druckergebnis

Melde printed oder failed mit passender Nachricht an den erlaubten Druckauftrag. Ein erfolgreicher TCP-Schreibvorgang bedeutet Datenversand an den Drucker, keine bestätigte physische Ausgabe. preview-json kann nach lokaler Vorschau als gedruckt markiert werden, ohne Papier auszugeben.

Lokale REST-API

Standardmäßig deaktiviert. Nach Einrichtung https://<edge-host>:3005 und auf jeder Route ein eigenes Maschinen-Bearer-Token verwenden. Lokale Arbeitsplatz-/Aktionsrechte gelten zusätzlich. Jede Schreibanfrage benötigt eine eindeutige requestId und einen aktuellen timestamp in Unix-Millisekunden. TLS, Einrichtung, Wiederholungsschutz und Grenzwerte stehen unter Sicherheit.

Methode	Pfad	Zweck
GET	/health	Lokale Prozessantwort und Zeit.
GET	/work-centers	Zwischengespeicherte Arbeitsplätze.
GET	/work-centers/:id	Arbeitsplatz nach fachlichem Code.
GET	/orders	Cache-Aufträge; optional workCenterId und status.
GET	/orders/:orderNumber	Cache-Auftrag.
GET	/orders/:orderNumber/recipe	Cache-Rezept; optional stationRole.
POST	/report/production	Arbeitsplatz, Auftrag und Menge puffern.
POST	/report/station-progress	Arbeitsplatz, Auftrag, Station, Rolle, Reihenfolge und Mengen puffern.

Lokales success: true bestätigt Annahme, keine Cloud-Speicherung. Der oben aufgeführte Cloud-Router bietet keinen Stationsfortschrittsendpunkt. Prüfe den bereitgestellten Adapterweg vor Verwendung. Rezeptwege liefern nur zwischengespeicherte Rezeptinhalte; die aktuelle normale Cloud-Auftragsprojektion liefert kein Rezept mit. Ein leeres Rezeptobjekt beweist nicht, dass in Ennea kein Rezept zum Auftrag existiert.

Lokale OPC-UA-Methoden

Der Listener ist standardmäßig deaktiviert. Nach Einrichtung gelten Zertifikatsvertrauen, SignAndEncrypt/Basic256Sha256 und Maschinen-Benutzername/Token. Meldemethoden hängen requestId: String und timestamp: Double an die bisherigen Argumente an.

Standard: opc.tcp://<edge-host>:4841/UA/EnneaEdge. Im Ordner EnneaMES findest du GetNextOrder, GetRecipe, ReportProduction, ReportScrap und ReportStatus. Prüfe Methodenstatus und Ergebnistext. Auch ein erfolgreicher Aufruf kann NO_ORDER oder ORDER_NOT_FOUND melden.

Fehler und Wiederholung

400: Eingaben prüfen. 401: Zugangsdaten und Ablauf prüfen. 403: wartender/widerrufener Connector, IP-Einschränkung, Bereich oder Dienstrechte. 404: Kennung und Zuweisung prüfen. Bewahre Ereignisidentität und gleiche Cloud-Zustand vor Wiederholung ab. Leite keine festen Rate Limits aus älteren Beispielen ab; nutze Betriebsgrenzen und Serverrückmeldung.

Siehe Installation, OPC UA und Fehlerbehebung.