search

getbible / Unbound-Biola

Please do not use, Since some of the Scripture Text has errors!!! USE https://github.com/getbible/v2 instead.
Other
59 stars 22 forks source link

Whole new API #16

Open brianhaferkamp opened 4 years ago

brianhaferkamp commented 4 years ago

Would it be possible to add Hausa to the API? It is spoken by many African people as a bridge language, especially central and western Africa.

Thanks!

Llewellynvdm commented 4 years ago

Hi @brianhaferkamp , we are going to archiving this repository soon due to errors we have found in the Text.

We will start using Crosswire Bibles in combination with those we have done, since they are maintained by a larger more committed community of Christian developers.

We will then release a V1 (the old JSON) and V2 (new JSON) API with documentation.

I just looked over their Bibles at Crosswire and they do not seem to have Hausa, do you have it in digital format, and permissions to add it to getBible?

brianhaferkamp commented 4 years ago

I'm sorry, I don't have access to the translation. It was a request from some people I met.

Will the API as I've been using it continue to exist? Will I need to change anything to continue using it? I currently have one app in production and another in development that use the API.

Thanks,

Brian H.

On Thu, Dec 26, 2019, 5:54 PM [[ewe]]yn notifications@github.com wrote:

Hi @brianhaferkamp https://github.com/brianhaferkamp , we are going to archiving this repository soon due to errors we have found in the Text.

We will start using Crosswire Bibles http://www.crosswire.org/sword/modules/ModDisp.jsp?modType=Bibles in combination with those we have done, since they are maintained by a larger more committed community of Christian developers.

We will then release a V1 and V2 API with documentation.

I just looked over their Bibles at Crosswire http://www.crosswire.org/sword/modules/ModDisp.jsp?modType=Bibles and they do not seem to have Hausa, do you have it in digital format, and permissions to add it to getBible?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/getbible/Bibles/issues/16?email_source=notifications&email_token=AEMNDEPBMGROF7HI7WWWHXDQ2U73TA5CNFSM4J7GQYU2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEHWJDYA#issuecomment-569151968, or unsubscribe https://github.com/notifications/unsubscribe-auth/AEMNDEL255UORHJ6BMR4KDDQ2U73TANCNFSM4J7GQYUQ .

Llewellynvdm commented 4 years ago

How are you using this API? I mean exactly how are you getting the Text. Since there are more then one way.

Like I said we will keep the old version 1 API as is, on get Bible. But we will add a new version 2 with the correct Text, and this would be the API I would suggest you use for the best stability, and accuracy.

We will not make corrections to version 1 initially as our focus is to get version2 up and running.

This repository is a list of text documents of the scripture, and it is these text documents that we are going to remove not the Json API on getBible.net

So I think answering my question in terms of how are you using the API will help me answering your question more accurately.

Llewellynvdm commented 4 years ago

We are planning to completely move away from an open public repository of scripture, this is due to huge blow back from Crosswire and other saying that they regularly find typos and make corrections to their modules of the Holy Text. This means a repository like this becomes outdated and all those who fork it have outdated and incorrect text.

So the plan is to have just one API on getBible.net that I will keep in sync with them, to insure we are always on the latest correct versions.

So we will change this repository to reflect the way to use the new API aswell as the old one. Now with the V1 you made a call to get Text like this:

https://getbible.net/json?passage=1Jn3

Now it will look like this

https://getbible.net/v1/kjv/62/3.json

So yes the URL will change (V1 new urls are not yet active) but the JSON layout will remain the same.

V2 url call will look like this:

https://getbible.net/v2/kjv/62/3.json

and its JSON will look like this:

{
    "translation": "King James Version",
    "abbreviation": "kjv",
    "lang": "en",
    "language": "English",
    "direction": "LTR",
    "encoding": "UTF-8",
    "book_nr": 62,
    "book_name": "1 John",
    "chapter": 3,
    "name": "1 John 3",
    "verses": [
        {
            "chapter": 3,
            "verse": 1,
            "name": "1 John 3:1",
            "text": "Behold, what manner of love the Father hath bestowed upon us, that we should be called the sons of God: therefore the world knoweth us not, because it knew him not."
        },
        {
            "chapter": 3,
            "verse": 2,
            "name": "1 John 3:2",
            "text": "Beloved, now are we the sons of God, and it doth not yet appear what we shall be: but we know that, when he shall appear, we shall be like him; for we shall see him as he is."
        }
    .........

We will be adding mapping files to help.

Translations

Books

Book

Basically this whole repository will change to a README that explains how to use these new API's

We will keep the old API open for the first year after this upgrade is released, but will start giving notice to all to move over. Since this new API will be a far better solution, with far stronger, faster, and correct outcome.

My apology for any inconvenience this may cause, but I am also under submission to other over me.

Do note that the new API is not fully ready but the V2 API is already active... yet I am still working on the part that will keep it in sync with Crosswires modules. Which will basically mean whenever you query it, it will always be the latest update version. So the checksums will help you notice a change, and the actual text has version history notes in it as you will see here: https://getbible.net/v2/kjv.json

I am not adding the history notice to books https://getbible.net/v2/kjv/63.json and chapters https://getbible.net/v2/kjv/63/1.json since it will get to bloated. I am think of having a translation specific call, for just the info, and not the text.

Llewellynvdm commented 4 years ago

Then there is this issue that most Translations that are not open, and in the public domain does not want us to transmit the whole Bible or a Book at once. Only chapters... ugly I know. So I am planning to keep only translations which allows full freedom of use. To this end we will allow publishers to contact us if they have a claim.