Forge API Intro Labs Overview

In the next few posts, I’m going to write about the introduction to Forge API. This is a revised version of what I have done as “View and Data API Intro Labs” a few years back, which was unfortunately outdated now. The goal of the labs is to learn the basic of Forge API through building a simple application to view a design model in a web browser. In the back of my mind, I’m also thinking this as a preparation for Design Automation for Revit (DA4R), which is expected to come near future. For example, to use DA4R, the developer will need to use authentication API. He/she may want to take a Revit file from A360 or BIM 360 and display the result in the viewer. I hope Revit add-on developers who are new to Forge API will find these labs easy to digest.

Autodesk Forge is a collection of web services and various platform technologies that allows the third party developers to integrate with Autodesk’s cloud-based products as well as to build their own applications. They are technologies that Autodesk internally uses to build its own services as well.

One of popular functionalities in Forge is Viewer. The third party developers can embed Forge Viewer in their web page to view a design model in a browser without needing to install any application. It’s the same technologies that you see in A360, BIM 360 Docs when you are viewing a design model, such as Revit file.

While I’m writing this labs instruction, I should note that there are plenty of materials about Forge API already. There are a couple of versions of getting started available. Samples are written in various programming languages. Many of them covers advanced functionality and suitable for demonstration. They are posted on the github and available for anybody who is interested in trying out. For your reference, I have included the list of links to the existing materials at the bottom of this post. A bit of drawback of pointing to those existing materials is that there are so many. It’s a little overwhelming when you are trying to look for the first time. My intention here is to provide THE minimum sample focusing on the logic of the first basic steps to view a model.

Note: If you are interested in integrating with A360 and BIM 360 Docs/Team, there are additional API’s to navigate through hubs and projects with those products. I intend to cover them later. In this lab series, we use a custom storage called OSS (Object Storage System) instead of A360 or BIM 360. But basically both use the same Forge API’s.

Here are the steps I’m going to follow:

They are written in C#, ASP.NET and JavaScript. But my focus will be on clarifying workflow. After the Lab4, the final application looks like below. You can get the source code for each lab from here: Lab1 | Lab2 | Lab3 | Lab4


Appendix: References

Here is a list of the existing materials I know of as references. Please be warned that these pages are continuously updated. They may change anytime.

1. Getting started

2. Documentations

  • — This is the main entrance page to Autodesk Forge. You will need to come here to register your apps and get client ID and secrets. You will also find links to various site about Forge API. More specifically, following pages will be good starting points:

3. Samples

4. Blog and Forums

Next: Lab1 “Hello Forge World”



Leave a Reply

Fill in your details below or click an icon to log in: Logo

You are commenting using your account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s