Introduction

Welcome Flux developer! The Flux JavaScript SDK and Flux C# SDK connect your app to popular design tools like SketchUp, Revit, Excel, Google Sheets, Grasshopper, Dynamo, 3ds Max and AutoCAD. You can also exchange data with other 3rd party apps that use the Flux SDK.

By connecting to Flux, your app will have direct access to projects and data created by Flux users (once they've logged in with their Flux credentials and authorized your app).

This page has links to tutorials designed to teach you how to do exactly that. By the end of the tutorials, you'll have a clear understanding of how to leverage the most powerful features of Flux.

Tutorials

JavaScript

The step by step introduction explains login, rendering 3D geometry, reading and writing data and more. https://flux.gitbooks.io/flux-javascript-sdk/content/

C#

The step by step introduction explains reading and writing data, working with notifications and more. https://github.com/fluxio/flux-sdk-cs/tree/master/Docs/tutorial

Before You Begin

To get started, you will need to register your own Flux account, and create an app in the App Manager.

Each app you create will be assigned a unique client ID and secret. The client ID is used to identify API requests made by your app. It is important that each app has its own client ID, since your users will be prompted to authorize access to their data. The client secret is used to sign API requests made by your app. You will only be required to use your client secret in certain cases. For example, server to server communications.

Software License

You own your code. You're also welcome to redistribute and modify Flux SDK libraries in your own apps under the MIT software license, which is further explained in LICENSE.md (JS) and License.md (C#).

Troubleshooting and Help

If you run into trouble, need some friendly advice, or have something to share: head over to https://community.flux.io/developers. For urgent matters, like server outages or security concerns please contact sdk@flux.io. Thanks in advance for being a great citizen, and know that we're always striving to improve. Good luck!