API

API

1. Standard format

   • Success (true/false)
   • HTTP Status
   • Message (If failed)

2. Versioning

   • Namespaced
   • Configured minimum supported to allow client to force update
   • Current version read from environment

3. Authentication

   • Authenticated actions require 'authentication_token' HTTP header
   • User identified by: Email + Password or Facebook access token
   • Devise token authenticable
     • TTL

4. I18n

   • Optional header: 'i18n_locale'

5. Actions implemented

   • /api/v1/tokens
   • /api/v1/subjects
   • /api/v1/featured
   • /api/v1/search
   • /api/v1/profiles
   • /api/v1/registrations
   • /api/v1/quizzes
   • /api/v1/flash_card_decks
   • /api/v1/completion_markers