Jahresrückblick 2025 – unser neuer Blogbeitrag ist online! ✨

[lugge86]

Ich versuche mich momentan am subscriben per rest-API.
Dafür habe ich in einem python-/flask-script einen endpoint "callback" angelegt. Dieser endpoint soll von iobroker aufgerufen werden sobald sich der abonnierte state ändert.

Subscriben geht angeblich per GET und per POST.

Ich würde GET vorziehen da, zumindest soweit man SwaggerUI trauen kann, bei GET ein Delta angeben kann und somit nicht jede kleine Änderung mitkriegt.

Mit POST klappt soweit alles, d.h. mein endpoint und mein Skript sind korrekt.
Per GET krieg ich das aber nicht hin. Sobald ich per SwaggerUI das subscriben via GET probiere schmiert der REST-adapter ab:

Den selben Fehler (Cannot read properties of undefined (reading 'url')..." bekomme ich auch bei diversen anderen API-calls. Scheinbar erwartet der Adapter hier eine URL.
Mir scheint die Doku bzw. SwaggerUI sind hier nicht vollständig. In Swagger gibt es z.B. keine Möglichkeit, eine URL zu hinterlegen.

Nutzt jemand erfolgreich diese API? Kennt jemand diesen Fehler?

[haus-automatisierung]

@lugge86 sagte in Test Adapter rest-api:

Scheinbar erwartet der Adapter hier eine URL.

Ja, Du musst dem Adapter ja mit dem Subscribe sagen, wohin die Änderungen des States publiziert werden sollen. Oder wie stellst Du Dir ein Subscribe vor?!

[lugge86]

@haus-automatisierung sagte in Test Adapter rest-api:

@lugge86 sagte in Test Adapter rest-api:

Scheinbar erwartet der Adapter hier eine URL.

Ja, Du musst dem Adapter ja mit dem Subscribe sagen, wohin die Änderungen des States publiziert werden sollen. Oder wie stellst Du Dir ein Subscribe vor?!

Klar, ist mir das klar. Habe ja auch extra einen entsprechenden Endpoint in meinem flask-script angelegt.

Und wenn ich den Subscribe per POST durchführe kann ich die URL dieses Endpoints dem iobroker auch im POST-body mitgeben. In Python sieht das dann z.B. so aus:

Aber bei der GET-Variante gibt es, zumindest laut SwaggerUI, keine Möglichkeit eine URL mitzugeben. Das sieht in Swagger so aus:

Ich kann zwar ein onchange und ein delta einstellen, aber keine URL hinterlegen.
Nun ist Swagger aber mehr oder weniger die einzige Doku die ich habe.
Die Frage lautet also: wie gebe ich die URL mit?

Hab mal zur Gaudi probiert einfach ein &url= im GET-Request anzuhängen, ohne Erfolg. Der Adapter schmiert ab weil die URL fehlt:

curl -X 'GET'   'http://192.168.0.252:8093/v1/state/0_userdata.0.test.test2/subscribe?method=GET&onchange=true&url="http://192.168.0.85:5800/callback"'   -H 'accept: application/json'

[haus-automatisierung]

@lugge86 sagte in Test Adapter rest-api:

Hab mal zur Gaudi probiert einfach ein &url= im GET-Request anzuhängen, ohne Erfolg.

Eventuell ist das auch ein Fehler im Adapter. Aber wie Du die URL übergibst ist in jedem Fall falsch. Da gehören keine Anführungszeichen drumherum und Du solltest URL Encoding verwenden. Also

&url=http%3A%2F%2F192.168.0.85%3A5800%2Fcallback

[haus-automatisierung]

Wie es aussieht, wird die URL immer nur aus dem Body geholt:

https://github.com/ioBroker/ioBroker.rest-api/blob/f3b56614b5961aef28731a31604f36a57ec7fc03/src/lib/api/controllers/state.ts#L90-L91

[lugge86]

Danke nochmal für die Rückmeldung. Ja, so hab ichs auch schon mal probiert:

curl -X 'GET'   'http://192.168.0.252:8093/v1/state/0_userdata.0.test.test2/subscribe?method=GET&onchange=true&url=http%3A%2F%2F192.168.0.85%3A5800%2Fcallback'   -H 'accept: application/json'
curl: (52) Empty reply from server

Um ehrlich zu sein, ich habe schon recht viel probiert- Aber ich kann halt nur raten, denn die Doku ist entweder falsch oder unvollständig.

Mein Problem ist dass leider andere APIs auch davon betroffen sind. Die API zum Abfragen der bestehenden Subscriptions zeigt das selbe verhalten.
(die hier:)

Mich würds aber wundern wenn bisher noch niemand diese APIs getestet hat. Hier scheint wohl nur der Entwickler weiterhelfen zu können...

[lugge86]

@haus-automatisierung sagte in Test Adapter rest-api:

Wie es aussieht, wird die URL immer nur aus dem Body geholt:

https://github.com/ioBroker/ioBroker.rest-api/blob/f3b56614b5961aef28731a31604f36a57ec7fc03/src/lib/api/controllers/state.ts#L90-L91

Da scheint aber noch mehr nicht zu passen, denn eigentlich sollte im Falle einer fehlenden URL ein JSOn mit einer Fehlerbeschreibung zurückgegeben werden.

Wie man auf meinen Screenshots sieht crasht aber bei mir der Adapter.

Kannst du bei dir mal mittels curl schauen ob das Problem auch bei dir auftritt?

Update: dein Tipp mit dem Body war gold wert.
Folgender Aufruf klappt:

curl -X 'GET' \
  'http://192.168.0.252:8093/v1/state/0_userdata.0.test.test2/subscribe?method=GET&onchange=true&delta=5' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{ "url": "http://192.168.0.85:5800/callback"}'

Mal schaun ob das auch für die anderen APIs klappt.

[lugge86]

Nachtrag: ja, klappt auch mit anderen APIs.
Solange die URL im Body kommt gibts keine Abstürze mehr.
Bin nur etwas verwundert dass noch niemand scheinbar dieses Problem hatte...

Hab jetzt noch weiter rumgespielt und herausgefunden dass, entgegen der "Doku", die onchange- und delta-Parameter auch bei POST funktionieren, und zwar bei Übergabe sowohl im Body als auch direkt im Request. Gemäß SwaggerUI dürfte keines von beiden funktionieren.
Dann kann ichs auch direkt per POST und alles im Body machen, dann ists wenigstens einheitlich.

Schade nur dass die "Doku" so massiv neben der Realität ist.

[mcm1957]

@lugge86

Wär sinnvoll wenn du mindestens ein Issue dazu - optimaler Weise gleich einen PR mit der korrigierten Docu erstellen könntest wenn du schon rausgefunden hats was nicht passt.

DANKE

[haus-automatisierung]

@lugge86 sagte in Test Adapter rest-api:

Bin nur etwas verwundert dass noch niemand scheinbar dieses Problem hatte...

Die meisten werden wahrscheinlich POST nutzen. Aber schön finde ich das auch nicht. Man nutzt ja meistens GET mit URL Parametern, weil man keine Möglichkeit hat einen Body zu übergeben. Sonst könnte man ja direkt POST nutzen...

Sehe das also schon als Bug, wenn die Url nicht als GET-Parameter übergeben werden kann.

[lugge86]

@haus-automatisierung sagte in Test Adapter rest-api:

@lugge86 sagte in Test Adapter rest-api:

Bin nur etwas verwundert dass noch niemand scheinbar dieses Problem hatte...

Die meisten werden wahrscheinlich POST nutzen. Aber schön finde ich das auch nicht. Man nutzt ja meistens GET mit URL Parametern, weil man keine Möglichkeit hat einen Body zu übergeben. Sonst könnte man ja direkt POST nutzen...

Ich hab mich ehrlich gesagt auch nur mit GET beschäftigt weil es laut SwaggerUI dort die Möglichkeit gibt, sich mittels den Parametern "onchange" und "delta" nur über gewisse Änderungen benachrichtigen zu lassen.
Aber nachdem diese Parameter ja auch mit POST funktionieren hat sich die GET-Variante ohnehin für mich erledigt.

Sehe das also schon als Bug, wenn die Url nicht als GET-Parameter übergeben werden kann.

Das doofe ist halt auch dass SwaggerUI suggeriert, die URL soll als Parameter übergeben werden (und auch keine andere Möglichkeit in der GUI bietet).
Von dem her ist die Implementierung in sich nicht stimmig.

Aber wie auch immer, Problem ist für mich gelöst, es klappt nun alles. Ich versuche dran zu denken, am WE ein issue zu erstellen :-)