Vue
Vue.js is an open-source model–view–viewmodel front-end JavaScript framework for building user interfaces and single-page applications.
Node [Version 12.x+ ] , Node Package Manager (NPM) [Version 6.x+]
1. The first step to getting started with SAWO API integration into your Vue web page is to install the sawo package as given below:
npm i sawo
2. After installation is done, you have to import the Sawo class from the installed sawo package to the top of the file:
import Sawo from "sawo"
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. Initialise SAWO and render the form according to the following steps:
- As part of this step, a container has to be created for the SAWO component. This has to be done on your project’s source file.
<div id="sawo-container" style="height: 300px; width: 400px;"></div>
Every added custom field should be accompanied by an
65px increase in the component height.- Some configurations have to be checked as given below. The code given below should help in the same.
var config = {
// should be same as the id of the container created on 3rd step
containerID: "<container-ID>",
// can be one of 'email' or 'phone_number_sms' or 'both_email_phone'
identifierType: "phone_number_sms",
// Add the API key copied from 2nd step
apiKey: "",
// Add a callback here to handle the payload sent by sdk
onSuccess: (payload) => {},
};
- Then a SAWO instance has to be created using the code given below:
this.sawo = new Sawo(config)
- The showForm method should be called thereafter as the showForm method is responsible for rendering the form in the given container.
this.sawo.showForm()
7. Below code-block can be used as a reference after you have completed setting up your project:
<template>
<div class="containerStyle">
<section>
<h2 class="title">VUE | Sawo Form Example</h2>
<h2 class="title">User Logged In : {{ isLoggedIn }}</h2>
<div class="loggedin" v-if="isLoggedIn">
<h2>User Successfull login</h2>
<div>UserId: {{ userPayload.user_id }}</div>
<div>Verification Token: {{ userPayload.verification_token }}</div>
</div>
<div class="formContainer" id="sawo-container" v-if="!isLoggedIn">
<!-- Sawo form will populate here -->
</div>
</section>
</div>
</template>
<script>
import Sawo from "sawo";
export default {
name: "Sawo",
data: () => ({
isLoggedIn: false,
userPayload: {},
Sawo: null,
}),
mounted() {
const sawoConfig = {
// should be same as the id of the container
containerID: "sawo-container",
// can be one of 'email' or 'phone_number_sms' or 'both_email_phone'
identifierType: "email",
// Add the API key
apiKey: "API key",
// Add a callback here to handle the payload sent by sdk
onSuccess: (payload) => {
this.userPayload = payload;
this.isLoggedIn = true;
console.log("Payload : " + JSON.stringify(payload));
},
};
// creating instance
this.Sawo = new Sawo(sawoConfig);
this.Sawo.showForm();
},
};
</script>
8. Once the SAWO SDK is successfully set up, a login form will be rendered in the provided container as displayed in the picture below:
Last modified 8mo ago