forge-apis

Forge Node.js SDK

Overview

This Node.js SDK (version 0.1.9) enables you to easily integrate the Forge REST APIs into your application, including OAuth, Data Management, Model Derivative, and Design Automation.

Requirements

• Node.js version 4 and above.
• A registered app on the Forge Developer portal.
• A Node.js web server (such as Express) for 3-legged authentication.

Installation

    npm install forge-apis --save

Tutorial

Follow this tutorial to see a step-by-step authentication guide, and examples of how to use the Forge APIs.

Create an App

Create an app on the Forge Developer portal. Note the client ID and client secret.

Authentication

This SDK comes with an OAuth 2.0 client that allows you to retrieve 2-legged and 3-legged tokens. It also enables you to refresh 3-legged tokens. This tutorial uses both 2-legged and 3-legged tokens for calling different Data Management endpoints.

2-Legged Token

This type of token is given directly to the application. To get a 2-legged token run the following code:

var ForgeSDK = require('forge-apis');
var CLIENT_ID = '<your-client-id>' , CLIENT_SECRET = '<your-client-secret>';

// Initialize the 2-legged OAuth 2.0 client, and optionally set specific scopes.
// If you omit scopes, the generated token will have all scope permissions.
var oAuth2TwoLegged = new ForgeSDK.AuthClientTwoLegged(CLIENT_ID, CLIENT_SECRET, [
    'data:read',
    'data:write'
]);

oAuth2TwoLegged.authenticate().then(function(credentials){
    // The `credentials` object contains an access_token that you use to call the endpoints.
    // You can set the credentials globally on the OAuth client and retrieve them later on.
    oAuth2TwoLegged.setCredentials(credentials);
}, function(err){
    console.error(err);
});

3-Legged Token

Generate an Authentication URL

To ask for permissions from a user to retrieve an access token, you redirect the user to a consent page. Run this code to create a consent page URL:

var ForgeSDK = require('forge-apis');
var CLIENT_ID = '' , CLIENT_SECRET = '', REDIRECT_URL = '';

// Initialize the 3-legged OAuth 2.0 client, and optionally set specific scopes.
// If you omit scopes, the generated token will have all scope permissions.
var oAuth2ThreeLegged = new ForgeSDK.AuthClientThreeLegged(CLIENT_ID, CLIENT_SECRET, REDIRECT_URL, [
    'data:read',
    'data:write'
]);

// Generate a URL page that asks for permissions for the specified scopes.
var authUrl = oAuth2ThreeLegged.generateAuthUrl();

//Redirect the user to authUrl (the user consent page).

Retrieve an Authorization Code

Once a user receives permissions on the consent page, Forge will redirect the page to the redirect URL you provided when you created the app. An authorization code is returned in the query string.

GET /callback?code={authorizationCode}

Retrieve an Access Token

Request an access token using the authorization code you received, as shown below:

oAuth2ThreeLegged.getToken(authorizationCode).then(function (credentials) {
    // The `credentials` object contains an `access_token` and an optional `refresh_token` that you can use to call the endpoints.
}, function(err){
    console.error(err);
});

Note that access tokens expire after a short period of time. The expires_in field in the credentials object gives the validity of an access token in seconds. To refresh your access token, call the oAuth2ThreeLegged.refreshToken(credentials); method.

Example API Calls

Use the credentials object to call the Forge APIs.

// Import the library.
var ForgeSDK = require('forge-apis');

// Initialize the relevant clients; in this example, the Hubs and Buckets clients (part of the Data Management API).
var HubsApi = new ForgeSDK.HubsApi(); //Hubs Client
var BucketsApi = new ForgeSDK.BucketsApi(); //Buckets Client

// Get the buckets owned by an application.
// Use the twoLeggedCredentials that you retrieved previously.
BucketsApi.getBuckets({}, twoLeggedCredentials).then(function(buckets){
    console.log(buckets);
});

// Get the hubs that are accessible for a member.
// Use the threeLeggedCredentials that you retrieved previously.
HubsApi.getHubs({}, threeLeggedCredentials).then(function(hubs) {
    console.log(hubs);
});

Support

[e-mail]