README.md

django-tastypie-oauth

Providing OAuth services for Tastypie APIs

Dependencies

This library works with the django-oauth-toolkit library. Make sure you have it set up before continuing.

Usage

1. Add tastypie_oauth to INSTALLED_APPS in Django.

2. When you create your Tastypie resources, use OAuth20Authentication like so:

   # mysite/polls/api.py
   from tastypie.resources import ModelResource
   from tastypie.authorization import DjangoAuthorization
   from polls.models import Poll, Choice
   from tastypie import fields
   from tastypie_oauth.authentication import OAuth20Authentication
   
   class ChoiceResource(ModelResource):
       class Meta:
           queryset = Choice.objects.all()
           resource_name = 'choice'
           authorization = DjangoAuthorization()
           authentication = OAuth20Authentication()
   
   class PollResource(ModelResource):
       choices = fields.ToManyField(ChoiceResource, 'choice_set', full=True)
       class Meta:
           queryset = Poll.objects.all()
           resource_name = 'poll'
           authorization = DjangoAuthorization()
           authentication = OAuth20Authentication()

   Or, if you want to use scoped authentication, use the OAuth2ScopedAuthentication class:

   from tastypie_oauth.authentication import OAuth20ScopedAuthentication
   
   class ChoiceResource(ModelResource):
       poll = fields.ToOneField("polls.api.PollResource", "poll", full=False)
       class Meta:
           resource_name = 'choice'
           queryset = Choice.objects.all()
           authorization = DjangoAuthorization()
           authentication = OAuth2ScopedAuthentication(
               post=("read write",),
               get=("read",),
               put=("read","write")
           )

3. After authorizing the user and gaining an access token, you can use the API almost as before with just one minor change. You must add a oauth_consumer_key GET or POST parameter with the access token as the value, or put the access token in "Authorization" header.