Share

Welcome to the Fusion API (Application Programming Interface)

What is an API?

For those new to customizing applications by writing programs, the first question might be, "What is an API?". An API, or Application Programming Interface is a term used to describe a set of functionalities exposed by an application that allows it to be controlled by a program. For example, you can use Fusion's API to write a program that will perform the same types of operations you can perform when using Fusion interactively.

Fusion, by definition, is a general CAD system, meaning that it is not aimed at any specific industry or set of individuals that only model certain types of products. By providing an API, Fusion allows specialized functionality to be added and repetitive operations to be automated, resulting in the improved productivity that comes from a tailored solution.

An API is also important in that it allows third-party applications to integrate with Fusion.

API Help Content

This online documentation is the primary source for details about the API and the content is accessed through the table of contents, as shown below. There are also some other resources that are referenced below.

API Table of Contents

The help content for the API consists of three major categories:

  • User's Manual - Contains high level overviews of the various parts of the API and describes how to use them. The User's Manual is the place to start if you're new to the API.
  • Reference Manual - Provides details about every object, method, property, event, and enum exposed by the API. Many topics include links to code samples that demonstrate how to use that specific object or function. This is the heart of the API documentation and is something you will use continually as you write programs for Fusion.
  • Code Samples - These are complete code samples that you can copy, paste and run. Most code samples simply demonstrate how to successfully call a specific function and are not necessarily meant to accomplish a useful task; however, many of them also demonstrate common and useful workflows. Most of the small samples that demonstrate a specific function are not in the sample list but are accessed from the specific topic it is demonstrating.

Searching the API Documentation

The Fusion help system has built-in support for searching. There is a search field near the top of the page, as shown below. Using this help supports filters to restrict the results but still often ends up with a large list of results that can be difficult to refine and pick the most appropriate topic. Better search results can usually be achieved by using a Google search. The entire help system is indexed by Google.


Searching_Help

Offline Access to the API Documentation

The same API help content is also available as a CHM file that can be used offline. Support to view a CHM file is built-in to windows and there are apps available for Mac.

Additional Resources

Fusion Object Model - As discussed in the Basics Concepts of Fusion's API topic here's a link to the pdf of the Fusion object model.

Here are a few additional resources outside of this standard documentation that can also be very useful.

Was this information helpful?