Sunday, April 13, 2008

BibleShared.com API

Hello all,

I've been hard at work on BibleShared.com this last week, and am excited about some of the new things in store. This might not interest much of the general public, but for software developers and web designers, this might generate some excitement.

I'm working on developing an open API for BibleShared.com that will allow programmers to create software and web sites that use the features of BibleShared.com. Imagine being able to access your notes using a program on your cell phone, or searching the scriptures by sending a text message. These kinds of thing, and more will be possible.

It will be implemented as a SOAP web service which should have .NET programmers especially excited. An API Key will be required for applications to be able to call its methods, but that will be provided for free to those who request it. To access any information for or about a user, direct authorization must be granted by that user through an interface already implemented on BibleShared.com.

Currently the following methods are planned to be supported:
  • AddNote
  • AddNoteComments
  • CreateSubGroup
  • GetAuthCodeStatus
  • GetChapterAddress
  • GetNewAuthCode [Done]
  • GetNote
  • GetNoteComments
  • GetPassageText
  • GetPassageURL [Done]
  • GetProgress
  • GetRecentNotes
  • MarkAsRead
  • SearchBible [Done]
  • SearchNotes

If you are a developer and would have interest in programming against this API, let me know in the comments, and suggest any methods you would like to see. No destructive methods will be supported (i.e. there will be no "delete" operations offered through the API).

On an unrelated side note, the Verse of the Day widget is still planned, we just need more verses to feature. Please leave comments with your favorite verses. Thanks!

About the Author: Nick is the creator of BibleShared.com -- a web application that allows you to read the Bible, write notes in the margin, share these notes with others, and track your Bible reading progress.