Diese Seite listet die REST-Routen des LoRaWAN-Netzwerkservers von Hermetry an einer Stelle auf. Jedes Thema hat eine Seite im Abschnitt LoRaWAN mit den vollständigen Feldbedeutungen; diese Seite verlinkt darauf. Pfade liegen unter https://<your host>/tenant/<tenantId>. Jede Antwort dieser Routen wird mit Cache-Control: no-store gesendet.
Berechtigungen
| Berechtigung | Standardrolle | Erlaubt |
|---|---|---|
iot_lorawan.gateways.read | Benutzer | Gateways und die Adresse des Netzwerkservers lesen |
iot_lorawan.gateways.manage | Administrator | Gateways hinzufügen, bearbeiten, deaktivieren und löschen, ihre Token rotieren |
iot_lorawan.devices.read | Benutzer | LoRaWAN-Geräte, Profileinstellungen und Pairing lesen |
iot_lorawan.devices.manage | Administrator | Geräte hinzufügen, bearbeiten und löschen, Schlüssel setzen, Sitzungen beenden, Pairing |
iot_lorawan.keys.read | Administrator | AppKey eines Geräts anzeigen |
iot_lorawan.frames.read | Benutzer | Das Live-Frame-Protokoll lesen |
Einrichtung
GET /api/iot/lorawan/setup (Gateways lesen) liefert die Adresse des Netzwerkservers und die Discovery-Adresse, die ein Basics-Station-Gateway benötigt, ob eine tc.trust-Datei angeboten wird, und die Region. Nichts Geheimes. Siehe Ihre Adresse des Netzwerkservers.
Gateways
| Methode | Pfad | Berechtigung | Funktion |
|---|---|---|---|
| GET | /api/iot/lorawan/gateways | Gateways lesen | Liste: { data, total, canManage } |
| POST | /api/iot/lorawan/gateways | Gateways verwalten | Ein Basics-Station-Gateway hinzufügen: { gateway, token, stationConfig } |
| GET | /api/iot/lorawan/gateways/{gatewayId} | Gateways lesen | { gateway, live, devicesHeard } |
| PATCH | /api/iot/lorawan/gateways/{gatewayId} | Gateways verwalten | name, status (ACTIVE oder DISABLED), latitude, longitude, altitude |
| DELETE | /api/iot/lorawan/gateways/{gatewayId} | Gateways verwalten | Seine Verbindung schließen, seine EUI freigeben, es entfernen |
| POST | /api/iot/lorawan/gateways/{gatewayId}/credentials | Gateways verwalten | Neues Token: { gateway, token, stationConfig } |
Die Liste nimmt page (ab 0), pageSize, search, sort (name, eui, protocol, mode, status, region, lastSeen, createdAt; Standard name:asc) sowie die Filter protocol, mode, status, region, deviceId, online.
Anfragetext zum Anlegen:
{ "eui": "AA555A0000000101", "name": "Roof gateway", "latitude": 41.0151, "longitude": 28.9795, "altitude": 45 }
eui ist erforderlich (16 hexadezimale Zeichen; Bindestriche, Doppelpunkte und Leerzeichen werden ignoriert), name 1 bis 128 Zeichen. Das Protokoll ist standardmäßig Basics Station, der Modus cloud. Das Token steht nur in dieser Antwort. Lizenzierte Router werden hier nicht hinzugefügt: Sie wechseln im eigenen Bedienfeld selbstständig in den Cloud-Modus, siehe Lizenzierte Router als LoRaWAN-Gateways. Das Rotieren des Tokens eines Gateways ohne Token wird abgelehnt: „This gateway does not use a token.“ Siehe Gateway hinzufügen und Gateway-Zugangsdaten, deaktivieren und löschen.
Geräte
| Methode | Pfad | Berechtigung | Funktion |
|---|---|---|---|
| GET | /api/iot/lorawan/devices | Geräte lesen | Liste: { data, total, canManage } |
| POST | /api/iot/lorawan/devices | Geräte verwalten | Ein OTAA- oder ABP-Gerät hinzufügen (201 { device }) |
| GET | /api/iot/lorawan/devices/{deviceId} | Geräte lesen | { device }: der Datensatz und seine aktive Sitzung, niemals ein Schlüssel |
| PATCH | /api/iot/lorawan/devices/{deviceId} | Geräte verwalten | name, joinEui, appKey, macVersion, class, anyJoinEui, codecId; für ABP devAddr, nwkSKey, appSKey gemeinsam |
| DELETE | /api/iot/lorawan/devices/{deviceId} | Geräte verwalten | Das Gerät, seine Sitzungen und seinen DevEUI-Anspruch entfernen |
| POST | /api/iot/lorawan/devices/{deviceId}/key | Schlüssel lesen | AppKey anzeigen: { appKey }; jeder Aufruf wird protokolliert |
| DELETE | /api/iot/lorawan/devices/{deviceId}/session | Geräte verwalten | Die Sitzung beenden; das Gerät muss sich erneut verbinden (Join) |
| DELETE | /api/iot/lorawan/devices/{deviceId}/counters | Geräte verwalten | Die Frame-Zähler eines ABP-Geräts zurücksetzen |
| POST | /api/iot/lorawan/devices/{deviceId}/approve | Geräte verwalten | Ein Gerät genehmigen, das der Pairing-Modus hinzugefügt hat |
Die Liste nimmt page (ab 0), pageSize, search, sort (name, devEui, macVersion, class, createdAt; Standard createdAt:desc) sowie die Filter macVersion, class und joinState (joined, refused, never).
Ein OTAA-Gerät hinzufügen
{
"name": "Cold room 3",
"devEui": "1122334455667701",
"appKey": "2B7E151628AED2A6ABF7158809CF4F3C",
"joinEui": "0000000000000000",
"macVersion": "1.0.3",
"class": "A",
"codecId": "auto",
"anyJoinEui": false
}
Nur name, devEui und appKey sind erforderlich; der Rest zeigt die Standardwerte. macVersion ist 1.0.2, 1.0.3 oder 1.0.4; class ist A oder C. Die Antwort enthält nie den AppKey, sondern nur hasAppKey: true. Ein neuer AppKey setzt den Join-Nonce-Verlauf des Geräts zurück. Siehe OTAA-Gerät hinzufügen.
Ein ABP-Gerät hinzufügen
{
"name": "Water meter 12",
"activation": "ABP",
"devEui": "1122334455667712",
"devAddr": "26011F3A",
"nwkSKey": "…32 hexadecimal characters…",
"appSKey": "…32 hexadecimal characters…"
}
Ein ABP-Anfragetext mit einem appKey oder ein OTAA-Anfragetext mit Sitzungsschlüsseln wird abgelehnt. Siehe ABP-Gerät hinzufügen.
Profileinstellungen und Pairing
| Methode | Pfad | Berechtigung | Funktion |
|---|---|---|---|
| GET | /api/iot/lorawan/profiles/{profileId}/settings | Geräte lesen | { settings } des LoRaWAN-Tabs des Profils |
| PUT | /api/iot/lorawan/profiles/{profileId}/settings | Geräte verwalten | Einstellungen ändern; sharedAppKey ist nur schreibbar |
| GET | /api/iot/lorawan/profiles/{profileId}/pairing | Geräte lesen | { pairing }: das Fenster und die Geräte, die es hinzugefügt hat |
| POST | /api/iot/lorawan/profiles/{profileId}/pairing | Geräte verwalten | { "minutes": 1–120 } öffnet das Fenster oder verschiebt sein Ende |
| DELETE | /api/iot/lorawan/profiles/{profileId}/pairing | Geräte verwalten | Das Fenster sofort schließen |
Die Felder der Profileinstellungen, auch jene, die nur die API setzt, sind unter LoRaWAN-Geräteprofile aufgelistet. Das Pairing wird unter Pairing-Modus und Paired Geräte genehmigen erklärt.
Frame-Protokoll
GET /api/iot/lorawan/frames?deviceId={deviceId}&gatewayId={gatewayId}&limit=200
{ frames }: Ihre letzten Frames, neueste zuerst, aus einem kurzen Live-Protokoll, das nicht gespeichert wird. Ein verworfener Frame eines Geräts einer anderen Organisation zeigt nur seinen Grund. Siehe Das Frame-Protokoll.
Downlinks und Codecs
- Anwendungs-Downlinks sind Befehle mit der Methode
lora.downlink:{ "fPort": 1–223, "data": "<hex or base64>", "confirmed": false }, gesendet über die Commands API. Siehe Downlinks. - Codecs haben eigene Routen: Codec API.
Ablehnungen
LoRaWAN-Ablehnungen enthalten einfache Meldungen, zum Beispiel „A Basics Station gateway always runs in cloud mode.“, „This gateway does not use a token.“ oder einen Schlüssel, der nicht 32 hexadezimale Zeichen hat. Fehlgeschlagene Feldregeln sind ein 400 mit issues. Siehe Fehler und Ratenbegrenzungen.

