WebSocket API vs. REST API

IrishFan · September 10, 2021, 8:57pm

There are two different APIs with different functionalities!

Should I decide and choose one of the two?
Are there advantages or disadvantages when using one or the other?
Does it make sense in some cases to use both?

Does only REST API support pushNotifications?
I did not found any information about pushNotifications in the documentation of WebSocket API.

dvo · September 10, 2021, 9:04pm

you mean :

volumio.local/api/v1/pushNotificationUrls?url=http://192.168.1.33/volumiostatus

github.com

volumio/docs/blob/master/docs/02_API/04_REST_API.md#notifications

## Rest API

Some commands may be invoked using Rest_api interface.

From a device on the same network, you can use

```
curl volumio.local/api/v1/commands/mycommand

```

Where _volumio.local_ is the device to be reached. You can also use the IP adress instead.

From the device itself (via a keyboard plugged on it or through [SSH](https://volumio.github.io/docs/User_Manual/SSH.html)), use :

```
curl localhost:3000/api/v1/commands/mycommand

```

This file has been truncated. show original

IrishFan · September 10, 2021, 9:52pm

Yes! I had this REST API command in mind!
Why isn’t there such functionality in WebSocket API?

That was the reason to ask the other questions.

ashthespy · September 11, 2021, 4:53pm

What do you mean? You normally open a socket connection and “subscribe” to events you want to be notified about. Have a look at the docs, but I believe you are looking for the pushState event.

IrishFan · September 11, 2021, 8:18pm

@ashthespy
I know this documentation! I read it before.
I already used the pushState event … but only together with getState request.

I am a beginner with python and socketio!
I wrongly interpreted the following documentation:

Get Player State

getState

Reply:

pushState

{
  "status": "stop",
  "position": 0,
  ...

I thought the pushState event only occur if I send an getState request to the volumio server.
But this is wrong! pushState event is sent after each change of the state.

Thank you for this hint!
Your answer pushed me in the right direction and I wrote a little test routine in python.
When I changed the state using the browser UI the test routine listed all the state changes without sending getState requests.