Provide REST API for Telethon authorization
Project description
=====
Django Telethon Authorization
=====
Provide REST API for authorizing telethon sessions
Quick start
-----------
1. Add "django-telethon-authorization" to your INSTALLED_APPS setting::
INSTALLED_APPS = [
...
'django-telethon-authorization',
]
2. Include django-telethon-authorization URL's in your project urls.py like this::
path('telegram-auth/', include('django_telethon_authorization.urls')),
3. Add environment variables::
* TG_API_ID = 111111
* TG_API_HASH = api_hash
* TG_SESSION_PATH = /path/to/sessions
Provide `TG_SESSION_PATH` only if you use SQLite as a session backend (Telethon default)
4. Run `python manage.py migrate` to create the models.
Way of work
------------
- When you request a telegram code - `TelegramAuthorization` model will be created.
- It will be automatically linked to `request.user`
Endpoints
------------
All endpoints accept JSON payloads.::
Usually response has status code `200` with a JSON.::
Each response contains boolean `success` property which indicates if request was successfull.::
If `success` == `False` -> variable `message` will be present inside JSON response with explanation.::
* POST /request_code/
* payload: {phone: <phone>}
* POST /submit/
* payload: {phone: <phone>, code: <code>, password: <password>}
* POST /logout/
* payload: {phone: <phone>}
Django Telethon Authorization
=====
Provide REST API for authorizing telethon sessions
Quick start
-----------
1. Add "django-telethon-authorization" to your INSTALLED_APPS setting::
INSTALLED_APPS = [
...
'django-telethon-authorization',
]
2. Include django-telethon-authorization URL's in your project urls.py like this::
path('telegram-auth/', include('django_telethon_authorization.urls')),
3. Add environment variables::
* TG_API_ID = 111111
* TG_API_HASH = api_hash
* TG_SESSION_PATH = /path/to/sessions
Provide `TG_SESSION_PATH` only if you use SQLite as a session backend (Telethon default)
4. Run `python manage.py migrate` to create the models.
Way of work
------------
- When you request a telegram code - `TelegramAuthorization` model will be created.
- It will be automatically linked to `request.user`
Endpoints
------------
All endpoints accept JSON payloads.::
Usually response has status code `200` with a JSON.::
Each response contains boolean `success` property which indicates if request was successfull.::
If `success` == `False` -> variable `message` will be present inside JSON response with explanation.::
* POST /request_code/
* payload: {phone: <phone>}
* POST /submit/
* payload: {phone: <phone>, code: <code>, password: <password>}
* POST /logout/
* payload: {phone: <phone>}
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
Close
Hashes for django-telethon-authorization-0.2.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5564dad18300c38afb1515196e3cd035f34c76a08617beea1d08366d3ef227f8 |
|
MD5 | 559e76e061281d33fe9dbe3b26c46696 |
|
BLAKE2b-256 | c1cfb85c152c13e0c096227989c7e070113dc7f79135ef5a94735ce40ed5308b |