Developer Tools: API
Rhyngwyneb Rhaglennu'r Rhaglen (API)
Mae Rhyngwyneb Rhaglennu Rhaglen BibleSearch (API) yn gadael i unrhyw ddatblygwr gynnwys testun Ysgrythyrol yn unrhyw fan ar eu gwefan neu raglen gyfrifiadurol os yw i ddibenion an-fasnachol. Os nad ydych yn ddatblygwr, ac eisiau cynnwys Ysgrythur neu BibleSearch ar eich gwefan, edrychwch ar rai o'n gwasanaethau yma. I chi sydd yn ddatblygwyr, mae API BibleSearch yn API wedi ei sylfaenu ar REST a gallwch ddarllen y dogfennau llawn yma.
Darllennwch y Cwestiynau Cyffredin i ddeall sut i ddefnyddio API BibleSearch. Os oes gennych gwestiynau, teimlwch yn rhydd i ymweld â'n fforwm API i ofyn cwestiwn. Gallwch hefyd gysylltu â ni drwy e-bost firstname.lastname@example.org a rhoi API yn y pennawd pwnc.
Sut mae cael mynediad?
I gael mynediad i'r API, rhaid bod wedi cofrestru fel defnyddiwr BibleSearch ac actifadu eich tocyn API unigryw drwy gofrestru yma. Pan mae'r tocyn API gennych, gallwch gysylltu a'r API ac adfer cynnwys. Cofiwch fod rhaid i bob galwad gynnwys y tocyn API. Mae eich tocyn API yn unigryw i chi. Mae'n gyfrinach, felly peidiwch a'i rannu gyda neb arall!
Sut alla i ddefnyddio'r data?
Allwch chi ddim defnyddio'r Ysgrythur oddi ar yr API i bwrpas masnachol, nac unrhyw raglen anghyfreithlon, tramgwyddus, anllad, treisiol, anfoesol, neu sy'n ddirmygus o'r Ysgrythur ei hun. Felly chwaraewch yn deg. Peidiwch newid ystyr yr Ysgrythur, neu sut y gellid ei ddehongli.
If you do want to use this content for commercial purposes, you must get specific approval by contacting us via email at email@example.com with API in the subject header. Further, we ask that you only display 500 consecutive verses at a time, and always include the copyright information for the versions you are using along with the Scripture content you display. You can also review our complete API Terms and Conditions here.
What type of applications can I build?
As long as you're using the Scripture content in a non-commercial, positive manner that respects the integrity of the Scripture text as described above, you can create whatever you want. We are always curious what developers can dream up, so please share your creations with us and the community at the BibleSearch API forum.
What versions are available?
Currently, we are only able to offer the versions listed below. We want to make as many versions available to you as possible, but we have to get all the various publishers on board first. If there is something you really want to have access to, let us know either via email or on our forums and we will do everything in our power to work with you!
Why aren't there more Scripture versions?
Scripture versions are intellectual property of various publishers and license owners. To give access to the version via the API, we have to get special permission from the various publishers first. If there is something you want, the fastest way to get that permission is to speak up and request access to versions on our BibleSearch API Forum. If you let us know what you want, we can approach the publishers and try our best to make it happen.
To help build trust with the publishers and intellectual property owners, we've built the Fair Use Management System into the API. This helps us provide an extra layer of data on how Scripture content is being consumed by API users and ultimately your application's end users. We are really trying to emphasize transparency with how Scripture content is used via our API, as that will show publishers and IP owners that we are protecting their content and ensuring it maintains the integrity Scripture deserves.
What's the Fair Use Management System?
Why do you require using the Fair Use Management System?
The Fair Use Management System helps provide information to Scripture publishers and shows them how their content is being used. This will in turn add more Scripture versions to the API as we demonstrate the additional reach that API access gives to a publisher. It also provides valuable information that helps us allocate our development resources to ensure that the API expands to include features and data that are important to API users.
What implications does the Fair Use Management System have for my app?
Can I cache data?
You can cache data, but we request that you limit it to fewer than http://support.bibles.org/categories/11919-biblesearch-api verses. We also recommend that you clear your cache every 14 days or less because we are constantly updating the structure of our data and improving it to make it more accessible for you. With that in mind, it's not a great idea to cache things for a long time because we want you to have the most up to date Scripture content available.
How many requests can I make a day? Is there a rate limit?
Yes, there is a default rate limit. You may only perform 5,000 queries a day. If you are building a massive application that will require more queries than this per day, please contact us via email or on the forum so we can work something out that will accommodate your needs. Ultimately, we want to provide you with access to the Scripture content you need while protecting our servers at the same time.
Can I request permission to exceed the rate limit?
We are definitely open to it. Drop us a line at firstname.lastname@example.org with API in the subject header and let us know what you are working on and what type of access you need. We are more than happy to work with you and try to meet your needs.
How do I use the API?
To get started with the API, we suggest you read over the complete documentation to see the capabilities and limitations of the current API. If you are lost or stuck, check out our BibleSearch API Forum to ask the community for help. We read the forum daily and will respond to questions or troubleshooting issues. If you want immediate help, submit a ticket request from the forum and we will get back to you as soon as possible.
Do I have to display the copyright for each version I display?
Yes. It's important to give credit to the publishers who own the rights to the particular version of Scripture content. As such, please include the copyright information with all of the Scripture you display.
How do I get my version into the API?
If you are a publisher or intellectual property owner and want your Bible version to be made available on BibleSearch and through the API, we'd love to hear from you. Drop us a line at email@example.com
What if my question wasn't answered here?
We have a forum for you to explore community questions and contributions, as well as articles from our development team. If you can't find what you're looking for there and want immediate help, drop us a line at firstname.lastname@example.org with API in the subject header.