Skip to content

Instantly share code, notes, and snippets.

@tschoffelen tschoffelen/spec.md
Created Jul 4, 2014

Embed
What would you like to do?
Spec Folio API

API Specificatie

Books

folioapp.nl/api/books

folioapp.nl/api/books/{id}

Categories

Books for category

folioapp.nl/api/books/category/{id}

All categories

folioapp.nl/api/categories

Category info

folioapp.nl/api/categories/{id}

Special categories

folioapp.nl/api/books/top10

folioapp.nl/api/books/editorstips

folioapp.nl/api/books/newreleases

Featured books

All the currently featured books and collections

folioapp.nl/api/books/featured

Parameters

offset		# start at zero and increment with 'limit' for page 2, 3, etc of the results
limit		# amount of results to return, 0 or unspecified returns all results
order		# order results by
		# for books: id_book, id_category, title, author, is_top10, is_editors_tip, is_new_release
		# for categories: id_category,name,description
direction	# direction of order: up, down
Example:

http://folioapp.nl/api/books?offset=20&limit=10&order=author&direction=up is sorted on ascending author name, showing 10 results starting with result 20

rescount	# returns the total amount of results
Example:

http://folioapp.nl/api/books/category/1?rescount returns the amount of books with category_ID 1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.