API documentation - 3.1

bevand10

As a developer, where can I find documentation regarding APIs for the 3.1 series?

In particular, I'm looking for web API documentation regarding importing new songs into the sqlite database. I'm familiar with using the 2.4 web api to manage service items (add, remove, search etc), and to navigate songs and readings once live (e.g. "page to page" control) but now looking for more automation capabilities beyond the basics I'm already using.

Pumba

As far as I know, there is no comprehensive documentation available. However, you could use the OpenLP Remote and inspect the network analysis in your browser to explore some of the functions. If that doesn't suffice, you can refer to the source code at the following links:
https://gitlab.com/openlp/openlp/-/blob/master/openlp/core/api/versions/v2/controller.py
https://gitlab.com/openlp/openlp/-/blob/master/openlp/core/api/versions/v2/core.py
https://gitlab.com/openlp/openlp/-/blob/master/openlp/core/api/versions/v2/plugins.py
https://gitlab.com/openlp/openlp/-/blob/master/openlp/core/api/versions/v2/service.py

If you want to use functions not included in the files mentioned above, your only option might be to write your own Python-based plugin. This would allow you to create your own API functions or recreate the ones you need. Unfortunately, the available documentation for plugins is sparse and outdated. Here is a starting point:
https://gitlab.com/openlp/wiki/-/wikis/Development/Plugin_Developers_Guide

There may be other solutions, but none that I am aware of. My coding experience is limited, but I did manage to create a plugin that extends the available Web API calls. If you decide to take this route and need assistance, I’d be happy to show you what I’ve done.

Jamie Hockin

@bevand10 I populated our songs.sqlite using the DB Browser for sqlite app. The structure is pretty straightforward. It took a bit of massaging to get the SQL commands working properly. I started with an MS Word copy of the lyrics for our hymn book and did a lot of replacements to get it in order.

If you have songs in some database format already, it will be much simpler to import. I suggest doing this offline rather than messing with the OpenLP API, unless you want to be able to import a song on the fly.