Before getting started with the Forge Platform, you need to set up an app and get your client ID and secret.
- Step 1: Log in to the Dev Portal Go to the Dev Portal.
*If You Already Have an Autodesk Account
Click the “SIGN IN” button. In the next “Sign In” screen, enter your email address and password, and click “Sign In” to log in to the Dev Portal.
- Step 2: Create an App Once you’re signed in, you can create your application.
Click the “CREATE APP” button on the top-right in the “My Apps” page, in the next screen,
Select APIs you are going to use. Enter your application name and description. Enter a callback URL. Note that wildcards are allowed in the path (but not in the hostname). For more information, see the “callback URL” definition in API Basics.
*Step 3: Note Your Client ID and Secret Once you set up an application, you will see a Client ID and Client Secret in your newly created app page. You will need these in all other OAuth flows and, by extension, to complete every other tutorial on this site!
By default, a key can be used on any site and application. However, we strongly recommend that you restrict the use of your key to domains that you administer, to prevent use on unauthorized sites. We also recommend you create a new App (API key) for every new application rather than reuse the same key in multiple applications.
If you want to learn more about OAuth 2 legged and 3 legged token, check out the rest of the Step-by-Step guide.
Now you have your API key, the next step is to upload and translate a model so it can be displayed on your webpage.
Upload one of your models to your account and get its URN using the following web page.
Alternatively, you can use one of the following desktop solutions instead if you prefer:
If you prefer using other programming languages or methods, there are even more samples in our GitHub collection and on the developer page.
If you don't have your own model to work with, some 2D and 3D sample models are provided with this workshop, in the Sample files folder.
Each of these solutions will upload and translate models on your account which you can use and view later.
Steps to translate a model using the web page.
-
Enter your Client Id and Client Secret, and press the 'Get my access token' button
-
Select one of the models from the 'Samples' list. For example the 'Robot Arm' sample. Or Drag 'n Drop one of yours on the gray area. Then press the 'Translation this one for me' button.
-
You should see a progress bar in the 'Currently translating...' area, please give it some time, ...
-
Once the translation is over, You would see your model listed in the 'Ready"' section with the 'urn' that you need later. Make sure to copy and save that urn somewhere for later use.
For this tutorial, we'll create a minimal Node.js web server to serve your html/css/js files as usual as well as provide code to access your translated files.
If you prefer to use another web server technology, you can adapt these instructions yourself to serve the index.html file included with the project.
Check out the appropriate workshop starting point version of the node.js skeleton application from the View and Data API Node.js basic sample as explained in Prerequisites - Get the sources:
$ git clone https://github.com/Developer-Autodesk/workflow-node.js-view.and.data.api
$ cd workflow-node.js-view.and.data.api
$ git checkout v1.0-workshop
Before you can run the sample, you need to download the node.js dependency modules used by the sample. You do this by executing the following command:
npm install
This command will download the following modules into the node_modules directory:
- express: Express is a minimal and flexible Node.js web application framework that provides a robust set of features for web and mobile applications.
- request: Request is designed to be the simplest way possible to make Http calls. It supports HTTPS and follows redirects by default.
- serve-favicon: Node.js middleware for serving a favicon.
Rename or copy the ./credentials_.js file into ./credentials.js
Windows
copy credentials_.js credentials.js
OSX/Linux
cp credentials_.js credentials.js
Configure your local server with your keys. Replace the placeholder with your own keys in credentials.js, line #29 and #30
client_id: process.env.CONSUMERKEY || '<replace with your consumer key>',
client_secret: process.env.CONSUMERSECRET || '<replace with your consumer secret>',
Copy the URN which you generated prior to installing the server in file /www/index.js at line #18
Note: the URN given to you by using [models.autodesk.io] (http://models.autodesk.io) is already base64 encoded. In case it is not, you will need to encode it to base 64 as mention here under "Step 1: Convert the source URN into a Base64-Encoded URN"
var defaultUrn = '<replace with your encoded urn>';
Run the server from the Node.js console, by running the following command:
node server.js
Connect to your local server using a WebGL-compatible browser:
Note that we use port 3000 and not the default http port 80 because if you are on Mac OSX or use Skype, port 80 may already be in use. If you want to use port 80 to avoid having to specify the port in the URL, edit the server.js file, change the default port from 3000 to 80 and restart the node.js server.