Skip to main content
# django-rest-framework-api-key [![travis][travis-image]][travis-url] [![codecov][codecov-image]][codecov-url] [![pypi][pypi-image]][pypi-url]
Authenticate Web APIs made with Django REST Framework


### Supports

- Python (2.7, 3.3, 3.4, 3.5)
- Django (1.8, 1.9, 1.10)
- Django Rest Framework (3+)


### Installation

Install using pip:

pip install drfapikey

Add 'rest_framework_api_key' to your `INSTALLED_APPS` setting:

INSTALLED_APPS = (
...
'rest_framework_api_key',
)

Finally set the django-rest-framework permissions under your django settings:

REST_FRAMEWORK = {
'DEFAULT_PERMISSION_CLASSES': (
'rest_framework_api_key.permissions.HasAPIAccess',
)
}


### Example Request

```python
response = requests.get(
url="http://0.0.0.0:8000/api/login",
headers={
"Api-Key": "fd8b4a98c8f53035aeab410258430e2d86079c93",
},
)
```


### Tests

pyvenv env
source env/bin/activate
pip install -r requirements/requirements-testing.txt
python runtests.py


### Contributing

1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request
6. Make sure tests are passing


[travis-image]: https://travis-ci.org/ekonstantinidis/django-rest-framework-api-key.svg?branch=master
[travis-url]: https://travis-ci.org/ekonstantinidis/django-rest-framework-api-key

[codecov-image]: https://codecov.io/github/ekonstantinidis/django-rest-framework-api-key/coverage.svg?branch=master
[codecov-url]:https://codecov.io/github/ekonstantinidis/django-rest-framework-api-key?branch=master

[pypi-image]: https://badge.fury.io/py/drfapikey.svg
[pypi-url]: https://pypi.python.org/pypi/drfapikey/

Metadata

Release files for drfapikey 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for drfapikey 0.0.1
File Size Uploaded
drfapikey-0.0.1.tar.gz 5.6 kB Details

Release files / drfapikey-0.0.1.tar.gz

Download URL drfapikey-0.0.1.tar.gz
Size 5.6 kB
Tags Source
SHA-256 checksum
How to use checksums
6b9fc3a5c915bde96b7891b1a772c70eca8f5e7eb5517bfdd5de40e598f37da4
BLAKE2b-256 checksum
How to use checksums
79bfb84af0d09c556b603d7cda2e062ec235f9c470f79c93928c69c218439be8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

0.0.3

1 release file

0.0.2

This release

0.0.1 This release

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page