This documentation is called to provide an available API for creating a functioning client.
Firstly, to fetch Bible text, you need to get a list of available translations and an object with their books (here is all together). The translations list contain nodes, which have the next properties:
short_name field is an id of the translation in database. Use it for forming a url.
full_name field is a full name of its translation.
The books object (or list) contains books, which contain nodes, which have the next properties:
bookid field is an id of the book in database.
chronorder field is a number of the book in chronological order (just a smoll feature).
name field is a name of this book.
chapters field is a number of chapters of this book.
Then, using that data, you can form a url for fetching a chapter of certain translation and book. The url constructor is the next:
https://bolls.life/get-text/<slug:translation>/<int:book>/<int:chapter>/
Where <slug:translation> is a translation abbreviation like YLT or
UBIO or SYNOD, and where <int:book>
and<int:chapter> is just a number of a book and a number of a chapter. For example by the next
url you will got an eight chapter of Song of Solomon book:
https://bolls.life/get-text/YLT/22/8/
The result of this request will be a list of verses of that chapter, where every verse will has some several fields.
pk field is an id of the verse in database.
verse field is a number of the verse in its chapter.
text field contains a text of this verse.
To find verses by a slug or a string you need to form a url in the next manner:
https://bolls.life/<slug:translation>/<str:piece>/
Where <slug:translation> is a translation in which you want to find something. The
<str:piece> is a piece of text which can be a slug or a string which you look for. It is`not
case sensitive, and it can be anything on any language: .../WLC/שָּׁמַ֖יִם וְאֵ֥ת/, .../LXX/ὁ
θεὸς τὸν/, .../UBIO/Небо та землю/, .../CUV/淵 面 黑 暗/. For example the next url
will returm a list of verses, where "Haggi" word is found:
https://bolls.life/search/YLT/haggi/
The result of this request will be a list of ALL found verses in the given translation, where every verse will has some several fields:
pk field is an id of the verse in database.
translation field is a translation in which was the search.
book field is a book of the verse.
chapter field is a chapter of the book.
verse field is a number of the verse in the chapter.
text field contains a text of this verse.
You can get full translation just quering in hte next manner:
https://bolls.life/get-translation/<slug:translation>/
The result of it will be an array of all verses, that belongs to the given translation. For example you can try the next link:
https://bolls.life/get-translation/YLT/
The structure of nodes in this array will be like in the nodes of search query