Giter Club home page Giter Club logo

biblesearch-api-php's Introduction

American Bible Society PHP wrapper for the Bible Search API

This repository is a fork of the biblesearch-api-php library, as a composer module.

The latest version of this library can always be found at https://github.com/americanbible/biblesearch-api-php.

This library is intended to ease your development with the BibleSearch API by providing php classes that do the direct interfacing with the API, which is xml based. You are welcome to use the API directly, without these classes, but if your application is written in PHP you will probably save time by using these classes.

The API provides access to much of the functionality of http://bibles.org, including search various Bible translations. The benefit of using the API for your Bible access includes:

  1. You don’t have to have local storage of the text. We do the storage for you.
  2. You don’t have to keep your local storage updated with the latest versions of the text. Again, we do that for you.
  3. We take care of managing copyright usage. There’s just one important rule for handling this, which is detailed in the section titled FUMS below.
  4. Usage is free. We don’t charge for access to the data, or any updates. ABS is a non-profit organization and we provide this as a service to the entire Christian community.

API Key

To access the API, you must be a registered BibleSearch user and have activated your unique API token via the Signup Page at http://bibles.org/pages/api/signup. Once you have your API token, you can make calls to the API and retrieve content. Your API token is unique to you. It’s a secret, so don’t share it with anyone else or your access privileges may be revoked!

API Documentation

You can find the Bible Search API documentation at http://bibles.org/pages/api/documentation.

FUMS

The Fair Use Management System is how ABS provides this data for free, and yet respects all copyrights. We have to provide usage data back to the copyright owners to make sure that the data is being used according to our agreements. The way we do this is via an extremely light javascript tracking mechanism. In order to use the API you must make sure and embed the FUMS javascript into your web page whenever the data pulled from the API is used. You may cache the FUMS and data returned from an API call locally, but the FUMS needs to be on any web page where the cached data is used.

If your application is not a web site, contact us for details on proper FUMS usage.

For more information on how FUMS works please visit http://bibles.org/pages/api/documentation/fums.

biblesearch-api-php's People

Contributors

bryceallison avatar maderesponsively avatar mark-bradshaw avatar roydejong avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.