getBible/v2
5
2
Fork 0
mirror of https://github.com/getbible/v2.git synced 2024-11-24 13:47:37 +00:00
Code Issues

Update README.md

Browse Source 
Updated the API URL
This commit is contained in:
eWɘyn 2023-05-31 17:05:32 +02:00 committed by GitHub
parent d72d15262c
commit 23e5ecd838
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -1,6 +1,6 @@
# V2 GetBible API (2020) # V2 GetBible API (2020)
We have **completely** moved away from an **open public repository** of the Holy Scripture, with **great sorrow and struggle**. This is because of a huge blow-back from Crosswire and other, saying that they regularly find typos and other mistakes in their modules of the Holy Scripture, and then they fix it. This means an open public repository like [Unbound-Biola](https://github.com/getbible/Unbound-Biola) becomes outdated, and all those who forked it have outdated and incorrect text. **This was never our intent, and so in seeking to correct this issue, we now created a whole new [API version 2](https://github.com/getbible/v2)** that will be hosted only on [getbible.net/v2/translations.json](https://getbible.net/v2/translations.json) itself to ensure it remains totaly in sync with the [Crosswire Modules](http://www.crosswire.org/sword/modules/ModDisp.jsp?modType=Bibles). This is a step back, but after months of prayer and tears it seems like the only way forward at this time. We have **completely** moved away from an **open public repository** of the Holy Scripture, with **great sorrow and struggle**. This is because of a huge blow-back from Crosswire and other, saying that they regularly find typos and other mistakes in their modules of the Holy Scripture, and then they fix it. This means an open public repository like [Unbound-Biola](https://github.com/getbible/Unbound-Biola) becomes outdated, and all those who forked it have outdated and incorrect text. **This was never our intent, and so in seeking to correct this issue, we now created a whole new [API version 2](https://github.com/getbible/v2)** that will be hosted only on [api.getbible.net/v2/translations.json](https://api.getbible.net/v2/translations.json) itself to ensure it remains totaly in sync with the [Crosswire Modules](http://www.crosswire.org/sword/modules/ModDisp.jsp?modType=Bibles). This is a step back, but after months of prayer and tears it seems like the only way forward at this time.
# How will this work and is the old API still active? # How will this work and is the old API still active?
@ -14,31 +14,31 @@ The old API query looked like this:
- https://getbible.net/json?passage=1Jn3 - https://getbible.net/json?passage=1Jn3
The new API (V1) query will look like this: The new API (V1) query will look like this:
- https://getbible.net/v1/kjv/62/3.json - https://api.getbible.net/v1/kjv/62/3.json
>That is really the only change, but we trust it will serve us all better. >That is really the only change, but we trust it will serve us all better.
[V2](https://github.com/getbible/v2) query will look like this: [V2](https://github.com/getbible/v2) query will look like this:
- https://getbible.net/v2/kjv/62/3.json - https://api.getbible.net/v2/kjv/62/3.json
### Mapping Helpers ### Mapping Helpers
Since we will be working with numbers and translation abbreviations, we will be adding helper mappers which are available in this repository, and in the API's respectively. The purpose of these mapping helpers are to inform you of any changes via a hash for various parts of the scripture, and to validate downloads. Then these mapping helpers will also serve to inform you of each translation's scope of the Holy Scripture, and other helpful information. Since we will be working with numbers and translation abbreviations, we will be adding helper mappers which are available in this repository, and in the API's respectively. The purpose of these mapping helpers are to inform you of any changes via a hash for various parts of the scripture, and to validate downloads. Then these mapping helpers will also serve to inform you of each translation's scope of the Holy Scripture, and other helpful information.
> Translations > Translations
- For translations: https://getbible.net/v2/translations.json - For translations: https://api.getbible.net/v2/translations.json
- For translations: https://getbible.net/v2/translations - For translations: https://api.getbible.net/v2/translations
- For translations: https://getbible.net/v2/checksum.json - For translations: https://api.getbible.net/v2/checksum.json
- For translations: https://getbible.net/v2/checksum - For translations: https://api.getbible.net/v2/checksum
> Translation Books > Translation Books
- For books: https://getbible.net/v2/kjv/books.json - For books: https://api.getbible.net/v2/kjv/books.json
- For books: https://getbible.net/v2/kjv/books - For books: https://api.getbible.net/v2/kjv/books
- For books: https://getbible.net/v2/kjv/checksum.json - For books: https://api.getbible.net/v2/kjv/checksum.json
- For books: https://getbible.net/v2/kjv/checksum - For books: https://api.getbible.net/v2/kjv/checksum
> Book Chapters > Book Chapters
- For a book: https://getbible.net/v2/kjv/62/chapters.json - For a book: https://api.getbible.net/v2/kjv/62/chapters.json
- For a book: https://getbible.net/v2/kjv/62/chapters - For a book: https://api.getbible.net/v2/kjv/62/chapters
- For a book: https://getbible.net/v2/kjv/62/checksum.json - For a book: https://api.getbible.net/v2/kjv/62/checksum.json
- For a book: https://getbible.net/v2/kjv/62/checksum - For a book: https://api.getbible.net/v2/kjv/62/checksum