Project

General

Profile

API » History » Version 2

Luke Murphey, 08/31/2012 10:13 PM

1 1 Luke Murphey
h1. API
2 1 Luke Murphey
3 1 Luke Murphey
TextCritical.com will provide an API for AJAX support and for external resources to access the works.
4 1 Luke Murphey
5 1 Luke Murphey
h2. Formats
6 1 Luke Murphey
7 1 Luke Murphey
The API will provide results in multiple formats:
8 2 Luke Murphey
9 1 Luke Murphey
 * JSON
10 1 Luke Murphey
 * XML
11 1 Luke Murphey
 * TXT (human readable)
12 1 Luke Murphey
13 1 Luke Murphey
h2. Endpoints
14 1 Luke Murphey
15 1 Luke Murphey
| *Index* | provides a list of the endpoints in a machine readable way |
16 1 Luke Murphey
| *Docs* | a non-machine readable web UI regarding the APIs (something like http://api.biblia.com/docs/) |
17 1 Luke Murphey
| *Greek/Parse:* | return a pare of a word |
18 1 Luke Murphey
| *Greek/ConvertFromBetaCode* | return a Unicode version of a beta-code string |
19 1 Luke Murphey
| *Greek/ConvertToBetaCode* | return a beta-code version of a Unicode string |
20 1 Luke Murphey
| *Books/List* | provide a list of the available books |
21 1 Luke Murphey
| *Book/<book_name>* | provide information about the given book |
22 1 Luke Murphey
| *Book/Read/<book_name>/<chapter>* | provide the given chapter of a book |
23 1 Luke Murphey
| *Book/Read/<book_name>/<chapter>/<verse>* | provide the given verse of a book |