Guide to the Reading API
The Reading API for this site allows users and apps to access book and chapter objects in JSON format. The url for the Read API is the site's base url plus "api.php" (e.g., https://edtechbooks.org/api.php).
Two types of objects may be requested via the Read API: (a) a book or (b) a chapter. Book calls require the book variable, which will look up the book based upon the unique "short name" provided. Chapter calls require both the book variable and the chapter variable, which will look up the chapter based upon the unique "short name" for each.
Usage
The API may be used to display content in your own site or app provided that you include proper attribution for the content and the hosting site.
Variables
| Variable | Type | Status | Description |
|---|---|---|---|
| book | string | required | The short name of the book, which is the last part of the book's base or cover url. For example: http://edtechbooks.org/qualitativeinquiry |
| chapter | string | optional | The short name of the chapter, which is the last part of the chapter's url. For example: http://edtechbooks.org/qualitativeinquiry/storyanalysis |
| key | string | unused | The Reading API currently does not require a key. |
Examples
To request the book object for https://edtechbooks.org/k12handbook, the API call would be:
https://edtechbooks.org/api.php?book=k12handbook
To request the chapter object for https://edtechbooks.org/k12handbook/connectivism, the API call would be:
https://edtechbooks.org/api.php?book=k12handbook&chapter=connectivism
Authentication
The API currently does not require a key, but that could change as the site and its services develop. For more information on future plans for the API or to request a key, please contact the site administrator [mailto:admin@edtechbooks.org].