ND-GC-1S API Dokumentation

Was kann mit der API gemacht werden?

Die Position abfragen: Ermitteln Sie die aktuelle Position des Garagentors.
Die Position vorgeben: Stellen Sie die gewünschte Position des Garagentors ein.
Den Status des Tors erfassen: Überprüfen Sie den aktuellen Status des Garagentors, um festzustellen, ob es geöffnet, geschlossen oder einen anderen Zustand hat.

Was braucht man, um die API verwenden zu können?

Für den Zugriff auf die API ist ein NODEMATIC Account erforderlich.

API-Endpunkt URL:

https://www.nodedevices-service.de/smart-home-api

Ratelimit: 60/h

Fehlerhafte Anmeldeversuche: 5/Tag

Position vorgeben

Führen Sie eine POST-Anfrage aus, um die Position eines Geräts einzustellen.

Anfrage Header Parameter

Content-Type: application/json

Anfrage Body Parameter

Parameter	Typ	Beschreibung
`account-user`	string	NODEMATIC Login Name/E-Mail-Adresse.
`account-password`	string	NODEMATIC Login Passwort.
`serial`	string	Geräte-UID mit 16 Zeichen.
`uid`	string	Geräte-Seriennummer mit 32 Zeichen.
`Passwort`	string	Geräte-Passwort mit 4 bis 20 Zeichen.
`intent`	string	Die aufzurufende API-Methode. Positionseinstellung = "set_position".
`position`	int	Der gewünschte Positionswert in Prozent: `0` - Closed `1-99` - Zwischenpositionen `100` - Open `255` - Stopp

Antwort Body Parameter

Parameter	Typ	Beschreibung
`status message`	int string	Fehlercode der Anfrage und Beschreibung: `0` - Success `-1` - Service out of order `-2` - Enddevice not reachable `-3` - Enddevice not reachable `-4` - Enddevice wrong password `-5` - Enddevice wrong UID `-6` - Enddevice action mismatch `-100` - Illegal request `-101` - Serial cannot be empty and the length cannot exceed 16 `-102` - Uid length must be 32 `-103` - Invalid password value length must be between 4 - 20 `-104` - Action must be an integer and cannot exceed 65535 `-105` - Data must be a hexadecimal string `-106` - Invalid Authentication `-107` - Invalid position value. Position must be between 0-100 or 255. `-108` - Login failed - invalid credentials. Check user and password.

{
	"account-user": "NODEMATIC@nodedevices.de",
	"account-password": "NODEMATIC-Account-password",
	"serial": "1111111111111111",
	"uid": "11111111111111111111111111111111",
	"password": "0000",
	"intent": "set_position",
	"position": 100
}

{
	"status": 0,
	"message": "Success",
	"data": 
    	{
		"position": "100"
	}
}

Position abrufen

Führen Sie eine POST-Anfrage aus, um die Soll-Position zu übertragen.

Anfrage Header Parameter

Content-Type: application/json

Anfrage Body Parameter

Parameter	Typ	Beschreibung
`account-user`	string
`account-password`	string	NODEMATIC Login Passwort.
`serial`	string	Geräte-Seriennummer mit 16 Zeichen.
`UID`	string	Geräte-Seriennummer mit 32 Zeichen.
`Passwort`	string	Geräte-Passwort mit 4 bis 20 Zeichen.
`intent`	string	Die aufzurufende API-Methode. Positionseinstellung abrufen = "get_position".
`gate_status`	int	Der aktuelle Zustand der Steuerung: `0` - Stopped `1` - Opening `2` - Closing `3` - Open `4` - Closed `6` - Autoclose `7` - Autoclose `8` - Middle Position `10` - Blocked In1 `11` - Blocked In2 `12` - Blocked In3 `13` - Sensing Error1 `14` - Sensing Error2 `15` - Sensing Error3 `18` - Ventilation Position `19` - Ventilation Position `20` - Device Restarted `22` - Relay / Engine Error `23` - Door Blocked
	int	Der aktuelle Positionswert in Prozent.

{
	"account-user": "NODEMATIC@nodedevices.de",
	"account-password": "NODEMATIC-Account-password",
	"serial": "1111111111111111",
	"uid": "11111111111111111111111111111111",
	"password": "0000",
	"intent": "get_position"
}

{
	"status": 0,
	"message": "Success",
	"data": 
	{
		"position_status": "4"
		"position_percent": "100"
	}
}