forge.commandline-nodejs v1.0.0

Forge API:

forge.commandline-nodejs

Note: For using this sample, you need a valid oAuth credential. Visit this page for instructions to get on-board.

Demonstrates the Autodesk Forge API authorisation and translation process using a Node.js console application.

• both 2 legged and 3 legged
• support both callback and promises

Description

This sample exercises the Node.js engine as a command line utility to demonstrate the Forge OAuth application authorisation process and the Model Derivative API mentioned in the Quick Start guide.

In order to make use of this sample, you need to register your consumer key, of course:

• https://developer.autodesk.com > My Apps

This provides the credentials to supply while calling the Forge WEB service API endpoints.

Dependencies

Node.js and NPM

Setup/Usage Instructions

1. Install Node.js on your computer.
2. Download (fork, or clone) this project.
3. Install Node.js dependency modules:

   npm install

4. Request your consumer key/secret key from https://developer.autodesk.com.
5. Set 2 environment variables FORGE_CLIENT_ID / FORGE_CLIENT_SECRET, or edit the forge-cb.js and forge-promise.js files and replace the placeholders by the consumer key/secret keys.

6. Note for the 3 legged command: while registering your keys, make sure that the callback you define for your callback (or redirect_uri) match the one in the scripts (mycallback variable in forge-cb.js and forge-promise.js). Default is : http://localhost:3006/oauth

The 2 scripts provide quick help information for the commands and arguments. Use the --help to see it.

A typical workflow is (replace -cb by -promise if you want to use promises vs callbacks):

# Do authentication.
node forge-cb.js 2legged

# Create a bucket. Bucket name must be lower case and valid characters.
node forge-cb.js bucketCreate my_bucket_name

# Upload a model.
node forge-cb.js upload samples/Au.obj

# Register the model to get it translated.
node forge-cb.js translate Au.obj

# Wait until the translation completes.
# Translation is complete when it reaches 'success - 100%'
node forge-cb.js translateProgress Au.obj

# Retrieve preview image.
node forge-cb.js thumbnail Au.obj Au.png

# Create an HTML page with your URN and a read-only access token.
node forge-cb.js html Au.obj Au.html

Note your access token and bucket name are saved in the data folder to be used as default by the scripts, but you can edit them as you wish.

Bucket information (JSON replies) returned by the system are stored in the data folder as well.

License

This sample is licensed under the terms of the MIT License. Please see the LICENSE file for full details.

Written by

Cyrille Fauvel Forge Partner Development http://developer.autodesk.com/ http://around-the-corner.typepad.com