autharmor-jsclient-sdk v1.4.1
AuthArmor Javascript Client-side SDK
🏁 Installation
You can integrate the AuthArmor SDK into your website by installing and importing our NPM package:
# Via NPM
npm i -s autharmor-jsclient-sdk
# Via Yarn
yarn add autharmor-jsclient-sdkYou can also load the SDK via our CDN by placing this script tag in your app's <head>
<script src="https://cdn.autharmor.com/scripts/autharmor-sdk.js"></script>🧭 Usage
🚀 Initializing the SDK
In order to initialize the SDK, you'll have to create a new instance of the AuthArmor SDK with the url of your backend API specified in it.
const SDK = new AuthArmorSDK("https://api.example.com/"); // specify your backend's url🧲 Invites
Generating a new invite
You can easily generate invites to your app by doing the following:
// Initialize the SDK
const SDK = new AuthArmorSDK("https://api.example.com/");
// Generate a new invite
const invite = await SDK.invite.generateInviteCode({
nickname: "", // Specify the invite's nickname
referenceId: "" // Specify a reference ID for the invite
});
console.log(invite);
/**
* Returns:
* {
* "nickname": "string",
* "invite_code": "string",
* "date_expires": "ISODate string",
* "invite_type": "string",
* "aa_sig": "string"
* }
*/Using an invite
Once an invite is generated, there are two methods for having the user consume the invite. You can either have your app show a QR Code which is then scannable using the AuthArmor app, or you can show a browser popup which prompts the user to accept the invite directly through the AuthArmor site:
// Display QR Code for user to scan using the AuthArmor app
invite.getQRCode(); // Returns a base64 representation of the QR Code image which can be used by supplying it to an <img> tag
// Or open the invite link in a popup window
invite.useInviteLink();Confirming an invite
After generating an invite and having the user scan it, you'll need to confirm that the profile is fully setup in the user's device before sending authentication requests to his/her device.
console.log("Confirming invite ID:", invite.nickname);
await SDK.invite.confirmInvite(invite.nickname);
console.log("Invite has been confirmed successfully!");What happens when confirming an invite?
The SDK sends a request to your backend containing an ID of the profile (nickname) the user just imported to his/her phone. The backend then sends a test authentication message to the user's phone, if the user approved it, this means the profile was setup successfully. Otherwise, the user must have incorrectly setup the profile
🔏 Authentication
Initializing an authentication request
In order to initialize a login request for authenticating users to your site, you can simply call the authenticate() function with the nickname you wish to request an authentication request for. Once you call the authenticate() function, an AuthArmor overlay will appear on top of your app which reacts accordingly to the authentication request's status.
try {
console.log("Authenticating user...");
await SDK.auth.authenticate("nickname");
console.log("User authenticated!");
} catch (err) {
console.error("The request was declined or has timed out!", err);
}💥 Events
There are several events emitted by the SDK which you can attach to and have your app react accordingly.
Available Events
| Event Name | Description |
|---|---|
| inviteWindowOpened | Triggered as soon as the invite popup window is open |
| popupOverlayOpened | Triggered once the AuthArmor overlay for invite/auth shows |
| popupOverlayClosed | Triggered once the AuthArmor overlay for invite/auth is removed |
| inviteWindowClosed | Triggered as soon as the invite popup window is closed |
| inviteAccepted | Triggered once a user opens the invite popup and accepts it |
| inviteCancelled | Triggered once a user opens the invite popup and presses the cancel button |
| error | Triggered once an error occurs while accepting/declining an invite |
Attaching an event listener
Attaching an event listener is pretty simple, all you'll have to do is call the on function with the event you wish to attach a function to followed by a callback function:
SDK.on("<event_name>", () => {
// Do something...
});