Building a file upload API on Django with user authentication

Question

I have a Django app that lets a user upload a file and does some processing on it, and I need to write an API for this app. The requirements are:

The API must accept file uploads (this is really the only thing the API will be responsible for)
User authentication must be supported, meaning each file uploaded must be associated with an existing Django user

I wrote the first part quite easily by just telling Django to listen for POST'ed data on a specific URL (which I hit by passing a file to curl), but that obviously won't give me user auth.

How can I add that in? Should I try something like tastypie since it's for building API's and has support for user auth, even though I will only barely scratch the surface of its functionality with this basic API? Or could I just get away with telling Django to accept a username and password in the POST along with the file? Is there a best practice for authenticating a user through an API built on top of Django?

Does the whole thing have to happen in one request or can it happen in two phases? — koniiiik
– koniiiik, Commented Aug 16, 2011 at 19:30
@koniiiik ideally one request, but if the LOE is much less for two phases, then I'd settle with that. What are you thinking? — Mike Crittenden
– Mike Crittenden, Commented Aug 16, 2011 at 19:34

koniiiik · Accepted Answer · 2011-08-16 22:42:47Z

2

My take on this would be to simply use the django.contrib.auth application and before handling the actual file data in the POST request just verify that the POST request also contains valid authentication info. You can do that by calling the authenticate function, see https://docs.djangoproject.com/en/dev/topics/auth/#django.contrib.auth.authenticate

The above applies in case you want the whole process to happen in a single request. That, however, means that the whole file will be uploaded before checking the authentication info. If you can afford to split this into one auth request followed by a file upload, you can just create a view that will take care of the authentication and then protect your file upload view by the login_required decorator. This will require sessions...

answered Aug 16, 2011 at 22:42

koniiiik

4,4221 gold badge28 silver badges29 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

jterrace · Accepted Answer · 2011-08-16 21:41:16Z

0

Unless it's overkill for your application, I would consider using OAuth for authentication to your API. There is a django module called oauth2app that lets you guard a URL behind oauth authentication.

answered Aug 16, 2011 at 21:41

jterrace

67.5k23 gold badges164 silver badges208 bronze badges

Comments

ybdesire · Accepted Answer · 2015-08-13 08:17:21Z

0

Auth

Add an authid for API. Such as url/uploadfile?file=1.txt&authid=xxx
The auth id can be got from another API with username & password auth.

Please refer to my code for file upload & API auth at git.

answered Aug 13, 2015 at 8:17

ybdesire

1,7431 gold badge22 silver badges38 bronze badges

Collectives™ on Stack Overflow

Building a file upload API on Django with user authentication

3 Answers 3

Comments

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related