http api v2 question

ploveman

I'm trying to get the api v2 http for service/show to work (the v1 works fine). OpenLP 3.0.1. Can someone either share or point me to a working example of json in the v2 API? I'm sending a POST to http://192.168.1.118:4316/api/v2/service/show with a body of {"id": "5051046b-95bb-11ed-84c1-2cf05d9aeb80"} This seems like it should work based on https://gitlab.com/openlp/wiki/-/wikis/Documentation/HTTP-API . The get using the v2 api to get service items works fine. I don't know if I'm looking at the right api guide or if there's another with examples? Any help greatly appreciated.

jednou

Hi, your json is OK, but you need to POST with proper header "Content-type: application/json" so your json is not interpretted as form-encoded...

ploveman

Thanks @jednou that was it.

LuckeeGuyy

UPDATE - the default type for $.post is xml-encoded so I went the 'fetch' route instead since it allows easier control over config settings

--------------------------------------------

I'm also trying to call the V2 API service/show endpoint but instead using Javascript from a browser.

A "400 (BAD REQUEST)" is returned which I think is caused by the wrong data type being sent with the POST - thought it was sending JSON but maybe not. I've tried several different ways of sending the data (2nd parameter in the post) but get 400 every time.

Before making the call I used "http://localhost:4316/api/v2/service/items" to get a list of service items and grabbed the ID from the list.

Here's the code snippet for reference:

------------------------------

$.post("http://localhost:4316/api/v2/service/show",

{"id":"dc57e88c-2f0c-11ee-afd1-4c034fc3af90"},

function(result) {console.log("POST successful: " + result);}

);

-----------------------------

Any help with Javascript syntax is appreciated!

Paul

LuckeeGuyy

@ploveman - using http://localhost:4316/api/v2/service/items to return a JSON list of service items, I've found that the song 'id' changes every time I restart OpenLP which makes it impossible to use as a fixed/absolute identifier - OR did I miss something?

@raoul ^^^^^

Renton

@LuckeeGuyy

Base on WIKI "http://localhost:4316/api/v2/service/show" needs Authentication Header and data as JSON.

From WIKI: AUthentication

"send a POST request to /api/v2/core/login with a JSON body containing the

and

. That will return the authentication token which you need to put in your request header:

All endpoint that have "padlock" on WIKI needs Authentication Header.

I looked at the source code to understand it better.

"https://gitlab.com/openlp/openlp/-/blob/master/openlp/core/api/versions/v2/service.py?ref_type=heads"

LuckeeGuyy

@Renton - thanks for digging into this and the pointers, much appreciated!

I assume I need to first setup User Authentication in the Remote Interface setup then make the call to core/login.

For whatever reason, I thought an endpoint would not require auth when the User Authentication checkbox on the Remote Interface setup page was not checked. EDIT: this is why I thought authentication was not required, found this on the HTTP API wiki page: Some endpoints require authentication if a username and password has been added in the settings.

I'll give this a try...

Renton

@LuckeeGuyy

Ah yes, my fault on the "User Authentication checkbox on the Remote Interface".

You can use it without Authentication header when it is unchecked.

I used.

function show(itemid, auth){ $.ajax({ type: "POST", url: "http://localhost:4316/api/v2/service/show", data: JSON.stringify({id: itemid}), headers: {"Authorization": auth}, success: function() { console.log("Show Success on " + itemid); }, contentType: "application/json", dataType: 'json' });}

"auth" param is optional and can be empty when "User Authentication" is unchecked.