All Collections
Versions 3.0 and 2.0
Implement
Platform SDK
How will my workflow change if I use the Platform SDK?
How will my workflow change if I use the Platform SDK?
Elisa Dinsmore avatar
Written by Elisa Dinsmore
Updated over a week ago

This article is for Flatfile's Portal 3.0 and Workspaces. If you'd like to check out the latest version of the Flatfile Data Exchange Platform, click here!

The biggest change you'll notice when adopting the Flatfile Platform SDK is that you will no longer need to rely on the UI to be able to edit and deploy your Templates/Sheets and Portals. Once you have set up your API keys and found your teamID, the Platform SDK will allow you to build out your Templates/Sheets and Data Hooks® from your IDE and deploy them without needing to access your dashboard for additional setup.

We've also added a new element to template creation: Workbooks. Workbooks define the shape of data that leaves Flatfile after a user imports raw data and validations and edits are performed on that data. Workbooks can contain one or more templates, or sheets. Previously, this was defined per-template, and we didn't provide a way to group templates that were created to achieve similar goals.

There are some changes to how Data Hooks and other validations can be set up, and more information about how to perform various validations on your data is located in this article.

One last thing to note - Templates deployed from the Platform SDK cannot be edited from the browser. Any changes to Templates that were created in the Platform SDK should be deployed from the Platform SDK, but any Templates created prior to implementing the Platform SDK will still be editable from the Dashboard.

Our goal is to support our developers in building the best implementation for your workflow and allow you to test and deploy your Templates and Data Hooks alongside your own application code.

Did this answer your question?