This tutorial will show you how to integrate OAuth.io in your Node.js backend with a web front-end, using the server-side flow.
This tutorial uses both the OAuth.io front-end JavaScript SDK and the OAuth.io Node.js SDK.
This tutorial is based on a git repository that you can clone. You can follow the instructions by yourself or checkout each step of the tutorial, which are marked by tags in the git repository.
The tutorial contains the following steps :
Part 1 : server-side code
step-0 Getting the code (tagged step-0) step-1 Initializing OAuth.io server-side (tagged step-1) step-2 Adding a state token retrieval endpoint server-side (tagged step-2) step-3 Adding an authentication endpoint server-side (tagged step-3) step-4 Adding a request endpoint server-side
Part 2 : client-side code
step-5 Initializing OAuth.io client-side (tagged step-5) step-6 Adding a call to retrieve the state token (tagged step-6) step-7 Adding a call to authenticate the user (tagged step-7) step-8 Adding a call to the request endpoint to get user info (tagged step-8)
To be able to follow the tutorial, you need to be registered on oauth.io, and to have an application containing the provider Facebook, which must be set on server-side flow.
In this part you'll have to get the code from our Github repository, and fill up gaps in it to complete the tutorial.
The project in the repository is a really simple webserver written in Node.js with expressjs, that serves a single static page. That page must allow a user to login through Facebook, retrieve his basic information (name, email, avatar), and finally display them on the page.
Everything that doesn't concern OAuth.io's integration has already been written to gain time.
Step 0 : Getting the code
To checkout tutorial Github repository, just run the following commands :
$ git clone https://github.com/oauthio/sdk-node-tutorialTo get the beginning point and start coding, checkout the step-0 tag :
$ git checkout step-0Then you need to run npm install to install all the dependencies of the project.
$ npm installYou are now all set to follow the tutorial !
Step 1 : Initializing OAuth.io server-side
The first thing you need to do is to install the OAuth.io Node.js SDK and save it to the project's dependencies in the package.json :
$ npm install oauthio --saveOnce that's done, you can initialize the framework server-side in the app.js file. This file holds the whole server side to simplify things. The backend is based on express.js.
In that file, you'll find comments defining placeholders for the different steps of the tutorial.
Here we need to initialize the SDK. To do that, you need to note the key and secret of the app you want to use on OAuth.io (in that case an app with the provider Facebook).
Once you have them, take a look at the config.example.js. This file holds a configuration that we will use in the app.js file, and will enable us to store the key and secret efficiently.
You'll have to fill the gaps, and rename the file as config.js.
module.exports = {
key: 'your_app_key',
secret: 'your_app_secret'
};Then, we will use this file to initialize the backend in app.js. You will find in that file a comment placeholder for the initialization part :
/* Requiring the lib */
// Require oauthio here (done in step-1)
[...]
/* Initialization */
// Initialize oauthio here (done in step-1)Replace the // Require oauthio here (done in step-1) comment with :
var oauth = require('oauthio');Replace the // Initialize oauthio here comment with :
try {
var config = require('./config.js');
oauth.initialize(config.key, config.secret);
} catch (e) {
console.log(e);
}That's it for step 1.
If you want to get the code from step 1, just run the following command:
$ git checkout step-1 --forceNote that any change you made will be discarded and replaced by the code shown in this tutorial (except for your config.js file, that is ignored and will remain there).
step-2 Adding a state token retrieval endpoint server-side