Metadata-Version: 2.1
Name: django-Rest-phonenumber-confirmation
Version: 0.2
Summary: Phone number confirmation
Home-page: https://github.com/thomas545/django-Rest-phonenumber-confirmation
Author: Thomas Adel
Author-email: thomas.adel31@gmail.com
License: MIT
Keywords: django-phonenumber-confirmation phonenumber confirmations twilio django-twilio
Platform: UNKNOWN
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development
Description-Content-Type: text/markdown
Requires-Dist: Django (>=3.0)
Requires-Dist: djangorestframework (>=3.11.0)
Requires-Dist: django-phonenumber-field (>=4.0.0)
Requires-Dist: phonenumbers (>=8.12.1)
Requires-Dist: twilio (>=6.0.0)

# django-Rest-phonenumber-confirmation
- A Django library for phone number confirmation with twilio with phone number validation 

### Quickstart
For installing django-drf-auth, just run this command in your shell

```
pip install django-Rest-phonenumber-confirmation
```

### settings
```
INSTALLED_APPS = (
    # ...

    'rest_framework',
    'phonenumber_field',
    'phonenumber_confirmation',
)

UNIQUE_PHONE_NUMBER = True
PHONE_CONFIRMATION_EXPIRE_MINUTES = 15

PHONENUMBER_DEFAULT_REGION = "Your region code"
PHONENUMBER_DB_FORMAT = ( 'INTERNATIONAL' or 'NATIONAL' )

# YOUR TWILIO INFORMATION
TWILIO_ACCOUNT_SID = 'xxxxxxxxxxx'
TWILIO_AUTH_TOKEN = 'xxxxxxxxxxx'
TWILIO_FROM_NUMBER = 'xxxxxxxxxxx'

```

### Dont forget do 
```
python manage.py migrate
```

### URLS

```
urlpatterns = [
    # ...
    path('phone-confirm/api/', include('phonenumber_confirmation.urls')),
]
```

#### API Endpoints: 

##### CREATE PHONE NUMBER AND SEND CONFIRMATION
Method: `POST`  
Endpoint: `/phone-number/sent/`  
Payload:  
`{  
    "phone": "PHONE NUMBER"
}`

##### CONFIRM PHON NUMBER 
Method: `POST`  
Endpoint: `/phone-number/confirmation/`  
Payload:  
`{  
    "pin": "PIN"
}`

##### RESEND CONFIRMATION TO PHON NUMBER 
Method: `POST`  
Endpoint: `/resend/<int:phonenumber_id>/confirmation/`  
Param : phonenumber_id = phone number object id


### PYPI
 - [PYPI](https://pypi.org/project/django-Rest-phonenumber-confirmation/)

