DRF AccountKit is the wrapper to use facebook account kit to authenticate first time in Django REST Framework
Project description
# drf-accountkit
This package enables the use of Facebook Accountkit for Django Rest Framework
If you want to know more about Facebook Accountkit, check out the following resources
- https://auth0.com/blog/facebook-account-kit-passwordless-authentication/
- https://developers.facebook.com/docs/accountkit
## Installation & Configuration
pip install drf-accountkit
Then to add the Django Accountkit to your project add the app `drf_accountkit` to your `INSTALLED_APPS`
And add `drf_accountkit` URLconf to your `url.py` like this:
path('[YOUR_PREFIX]/', include('drf_accountkit.urls')),
Now add the following settings in your settings.py file
FACEBOOK_APP_ID = <Accountkit App ID>
ACCOUNT_KIT_APP_SECRET = <Accountkit App Secret>
ACCOUNT_KIT_VERSION = "v1.0"
## Usage
You have to configure account kit in your frontend and specify `[YOUR_PREFIX]/login_success` as the success url.
You either send to login success as POST (or GET) those info:
- `access_token`
or
- `code`, `state`, `status`
You will get as result:
- **Successful:** API status 200 or 201
- `token`
- `user_id`
- **Refusal:** API status 401
- `message`
## Costumization
You can overide methods of `LoginSuccess` API view like:
- `get_username(phone, email)` to costumize the username to be stored
- `response(user, token)` to costumize the response of endpoint
### This is project is based on
- The django implementation of accountkit at https://github.com/antiproblemist/django-accountkit
This package enables the use of Facebook Accountkit for Django Rest Framework
If you want to know more about Facebook Accountkit, check out the following resources
- https://auth0.com/blog/facebook-account-kit-passwordless-authentication/
- https://developers.facebook.com/docs/accountkit
## Installation & Configuration
pip install drf-accountkit
Then to add the Django Accountkit to your project add the app `drf_accountkit` to your `INSTALLED_APPS`
And add `drf_accountkit` URLconf to your `url.py` like this:
path('[YOUR_PREFIX]/', include('drf_accountkit.urls')),
Now add the following settings in your settings.py file
FACEBOOK_APP_ID = <Accountkit App ID>
ACCOUNT_KIT_APP_SECRET = <Accountkit App Secret>
ACCOUNT_KIT_VERSION = "v1.0"
## Usage
You have to configure account kit in your frontend and specify `[YOUR_PREFIX]/login_success` as the success url.
You either send to login success as POST (or GET) those info:
- `access_token`
or
- `code`, `state`, `status`
You will get as result:
- **Successful:** API status 200 or 201
- `token`
- `user_id`
- **Refusal:** API status 401
- `message`
## Costumization
You can overide methods of `LoginSuccess` API view like:
- `get_username(phone, email)` to costumize the username to be stored
- `response(user, token)` to costumize the response of endpoint
### This is project is based on
- The django implementation of accountkit at https://github.com/antiproblemist/django-accountkit
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
drf-accountkit-0.2.3.tar.gz
(4.7 kB
view details)
File details
Details for the file drf-accountkit-0.2.3.tar.gz
.
File metadata
- Download URL: drf-accountkit-0.2.3.tar.gz
- Upload date:
- Size: 4.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: Python-urllib/3.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 67bd94555711acc4fdece13d0260c97e94d3bbfeee8bfeb534171259006952c2 |
|
MD5 | 3648863e82f7541860166aa699ca1ff6 |
|
BLAKE2b-256 | 8abf2db61a63fb5251a107e5a91b472a35d86c02fedd70c7b76b486f26e2e434 |