tfa-python-sdk 1.0.0

Telegram Factor Authentication python library

Telegram Factor Authentication - Python SDK

If you are using TFA as your authentication service in your python applications, you can use our library.

How to use the library

So, let's have a quick review of our steps.

• Installation
• Configuration
• Checking result

Installation

The easiest step is installation. You can install it with pip or pipenv. Just go ahead and enter the command below:

$ pip3 install tfa-python-sdk

Congratulations! First step is done!

Configuration

After installation, go to your file and import the library:

from tfa_python_sdk import TFA

Second, you need to epecify the accecc_token. You can get it in your dashboard panel. So, call the class:

auth = TFA('access_token')

Ok, now library know your access token. Now it's time to enter the user_token. User token is the code you get it from your form field or a post method. Importent is to get user token. So, we use authUser function to pass user token and get the result.

result = auth.authUser('user_token')

You are done it this step. Let's move forward and check status codes and check user result.

Checking result

When you get the result, you can check codes and see what are them. Here is a quick review:

statCode = result.error

if (statCode == 800):
    print('Authenticated.')
elif (statCode == 820):
    print('User token is wrong.')
elif (statCode == 290):
    print('Admin token is wrong.')

This was just knowing status codes. If you don't know them now, check out our docs and read them, and know what are result of every status code.

Ok, 800 and 290 just return you an 2 lenght object. One is error and second is message. But 800 doesn't return you a message. You check the stat, if it was 800, second item is user. User item is the user data that telegram uid is stored there and you can use it.

More about status codes

Here let's know about them in deep.

• 800

{
    "error": 800,
    "user": {
        "_id": "document id",
        "uid": "telegram user id",
        "token": "one time token. Every time become null",
        "createdAt": "when created",
        "updatedAt": "last update",
        "__v": 0
    }
}

• 820

{
    "error": 820,
    "message": "User authentication token is not valid"
}

• 290

{
    "error": 290,
    "message": "Admin access token is not valid"
}

Development

If you want to develop the library, it is so simple. Edit library codes and run test.py like this:

$ python3 test.py

Before you start: **Remember the base or codes are stored in tfa_python_sdk/tfa_python_sdk.py. You need to edit there.