Flask
Flask is a micro web framework written in Python. It is classified as a micro framework because it does not require particular tools or libraries.
Python, pip (package-management system written in Python used to install and manage software packages)
1. The first step to getting started with SAWO API integration into your Django website/application is to install the sawo package as given below:
pip install sawo
2. Next, you have to import createTemplate, getContext, and verifyToken methods from Sawo. The getContext method is used to create sawo dictionary object from data gain from Django Database. The ways to create the template and verify the token are given in subsequent steps.
from sawo import createTemplate, getContext, verifyToken
3. To use SAWO Login you would need an API key which can be obtained by creating a project in the sawo dashboard.
4. Once you create your project, you would need to set your project name and hostname.
4.1. For development in a local machine, the hostname should be set to 'localhost'.
If using ''localhost" as hostname is not working for you, try "127.0.0.1"
4.2. For production, the hostname should be set to your domain.
If you are adding your domain do not add 'https://', ''http://', 'www' or even trailing backslash.
Example:
https://dev.sawolabs.com/ should be kept as dev.sawolabs.com5. Copy the API key from the project and keep it safe and secure.
The best practice to store your API key is to store values in .env so that they are not exposed.
6. Getting Started with the Setup in Flask:
- First, you have to create a template for SAWO password-less and OTP-less Authentication for your Flask website. Use the code given below for the same:createTemplate("./<filepath>",flask=True)#examplecreateTemplate("./templates/partials",flask=True)
- Next, you have to send this data required by _sawo.html. The variable names used in _sawo.html template are sawo.auth_key, sawo.identifier and sawo.to Therefore,to send this data you have to create a JSON.
Note:
The "to" route should be a post route that can receive posted data.
If you don’t know how data is passed to templates in Django or Flask. We will suggest looking into it first
METHOD USING ADMIN AND DATABASE TO SAVE CONFIG FOR SAWO
- Creating fields for sawo api_key and identifier to set it from admin dashboard. Copy this code in models of your app
class Config(models.Models):
api_key = models.CharField(max_length=200)
identifier = models.CharField(max_length=200)
choices = [("email","Email"),("phone_number_sms","Phone")]
- Setting up view.py of the app. Note: Route should be the receiving end where you can handle post request
from models import Config
from sawo import getContext
def <your_function>(request):
config = Config.objects.order_by('-api_key')[:1]
context = {
"sawo" = getContext(config,<route>) #the route where you will recieve
the payload sent by sdk
}
#example
def index(request):
config = Config.objects.order_by('-api_key')[:1]
context = {
"sawo" = getContext(config,"login")
}
FLASK
"sawo":{
"auth_key": "<api_key>",
"identifier": "email | phone_number_sms"
"to": <route> #the route where you will recieve the payload sent by sdk
}
#example
"sawo":{
"auth_key": "785ha-hdjsdsd-799-ss345",
"identifier": "email | phone_number_sms"
"to": login
}
Once the SAWO SDK is successfully set up, a login form will be rendered in the provided container as displayed in the picture below:
Final Render of SAWO Login
Congratulations !! The SAWO API is now ready to be used in your Flask application 🤘.
Last modified 7mo ago