Fluro Javascript API

Site | Documentation | REST API Documentation | Support

Javascript Frameworks

Frameworks are available for Vue, Angular and React Vue Plugin

Installation

Before installing update the .npmrc file with your font-awesome license number

npm install fluro --save

Getting Started

//Import the Fluro module
import Fluro from 'fluro';

/////////////////////////////////////////////

//Set some defaults 
const API_URL = 'https://api.fluro.io';
const APPLICATION_TOKEN = '$55fkshadh12425324...';
const APPLICATION_DOMAIN_NAME = 'https://myapplication.com'; 

/////////////////////////////////////////////

//Create a new Fluro instance
const fluro = new Fluro({
    apiURL: API_URL,
    applicationToken: APPLICATION_TOKEN,
    domain:APPLICATION_DOMAIN_NAME,
});

/////////////////////////////////////////////

//Optionally set a default timezone (otherwise will default to browser clock timezone)
fluro.date.defaultTimezone = 'Australia/Melbourne';

Authentication

The FluroAuth service makes it easy to handle actions and behaviours like login, logout, signup, reset password etc. It's often a good idea to save the user's session, which contains refresh and access tokens to local storage Once you have authenticated the fluro module will take care of authenticating your requests, refreshing tokens before they expire and caching data for more information checkout the FluroAuth module

If a static application token has been set then when a user signs out of the app all requests are made as the application instead of the user

Listening to user session changes

It's helpful to listen for the 'change' event so that your application can respond to a user logging in/out

//Listen for when the user logs in/out
fluro.auth.addEventListener('change', userUpdated);

/////////////////////////////////////////////

//Update whenever the user session changes
function userUpdated(user) {
    
    if(user) {
    	//The user is logged in and you have their session details
    	window.localStorage.userSession = user;
    } else {
    	//The user is logged out
    }

    //Get new information for the user's 'likes', 'plays', 'pins' etc..
    fluro.stats.refresh();
}

//Set the user session object if we already have it in localStorage
fluro.auth.set(window.localStorage.userSession);

Logging In as a Fluro User

To login and authenticate using your Fluro username and password you can use the FluroAuth.login function, upon successfuly login all subsequent requests to the API will be authenticated with your access token, and your token will be refreshed automatically until you sign out

//Login to the server as a general Fluro user
fluro.auth.login({
	'username':'[email protected]',
	'password':'yourpassword',
}).then(function(user) {
	//We are now logged in
})
.catch(function(err) {
	//Couldn't sign in
	console.log(err.message);
});

Logging in to an application as a managed persona

If your application is a public website or a whitelabelled product that you want users to be able to sign up or log in to, you can allow them to authenticate as a 'managed persona', this allows your users to authenticate without ever hearing or knowing about Fluro, giving you complete control over their usernames, passwords permissions and other information. Managed persona's can sign in to your applications resulting in an access/refresh token pair that grants them both the permissions of the persona AND the permissions of the application.

//Login to the server as a persona (whitelabelled user)
//By providing the application:true property
fluro.auth.login({
	'username':'[email protected]',
	'password':'yourpassword',
}, {
	application:true
}).then(function(user) {
	//We are now logged in
})
.catch(function(err) {
	//Couldn't sign in
	console.log(err.message);
});

Logging Out

//Logout and clear all caches
//And revert back to the application if a token has been provided
fluro.auth.logout()

Handling Errors

The FluroUtils service has a handy function for translating an error into a human readable message, this can be be helpful when needing to show error messages to the user

//Get the user session
fluro.api.get('/content/event/5ca3d64dd2bb085eb9d450db')
.then(function(response) {
	//Success
})
.catch(function(err) {
	var errorMessage = fluro.utils.errorMessage(err);
	console.log(errorMessage);
});