Skip to content

Instantly share code, notes, and snippets.

@nathanborror
Created August 25, 2012 20:21
Show Gist options
  • Star 9 You must be signed in to star a gist
  • Fork 1 You must be signed in to fork a gist
  • Save nathanborror/3470564 to your computer and use it in GitHub Desktop.
Save nathanborror/3470564 to your computer and use it in GitHub Desktop.
Readernaut API

Readernaut API

I'm going to be deprecating the current Readernaut API in favor of a newer more built-out version. People using the current version have two weeks to switch over to the new API. Currently you can find your API_KEY by viewing source on any page and searching for "api_key" in the output (this will get better later). Here are some example endpoints:

Notes

  • Old: /services/api/USERNAME/notes/
  • New: /api/v1/notes/note/?username=YOUR_USERNAME&api_key=YOUR_API_KEY&user__username=USERNAME

Books

  • Old: /services/api/nathan/readerbooks/
  • New: /api/v1/readerbooks/readerbook/?username=YOUR_USERNAME&api_key=YOUR_API_KEY&user__username=USERNAME

Goals

  • Old: /services/api/nathan/goals/
  • New: /api/v1/goals/goal/?username=YOUR_USERNAME&api_key=YOUR_API_KEY&user__username=USERNAME

Progress

  • Old: /services/api/nathan/progress/
  • New: /api/v1/goals/progress/?username=YOUR_USERNAME&api_key=YOUR_API_KEY&user__username=USERNAME

This new API is built with Tastypie, if you're interested in what you can do with it you can read over Daniel's documentation.

@cimm
Copy link

cimm commented Aug 25, 2012

Any chance of a write API as well?

@nathanborror
Copy link
Author

Possibly, what are you trying to do?

@koenbok
Copy link

koenbok commented Aug 27, 2012

Why tastiepy > piston? https://bitbucket.org/jespern/django-piston/wiki/Home

Just curious.

@nathanborror
Copy link
Author

I prefer Tastypie's declarative syntax but I have used Piston in a while. I also know Daniel and can bug him when I have questions :)

@cimm
Copy link

cimm commented Sep 22, 2012

Would like to be able to update my progress, from within a mobile application for example.

@matthewpennell
Copy link

Is this API currently supposed to be working? Using my api_key and username I just get 404s from the Readernaut site. :(

@JackShepard98
Copy link

Hi.how can I get an api key?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment