What is RestAPI?
Flowster Studio uses Rest API to allow clients (browser apps) to communicate with a server. An API is an application programming interface that consists of a set of rules that allow programs to talk to each other. REST determines how the API looks like. It stands for “Representational State Transfer” and defines a set of rules that developers follow when they create their API. One of these rules states that you should be able to get a piece of data (called a resource) when you link to a specific URL. Each URL is called a request while the data sent back to you is called a response. REST APIs accepts JSON for request payload and also send responses to JSON.
...
In comparison with previous versions of Flowster Studio 4.8.x where additional settings were needed before invoking RestAPI methods ( e.g. create or use an existing Client Hash from a Client App, Set Token for a user in Client App Security), for the new RestAPI, only a username (with permissions to access Flowster Studio) and password are required to obtain the JWT to authorize additional requests.
RestAPI Client App
This client app is configured during installation to be later used for third-party scripts invoking RestAPI methods. The RestAPI documentation URL is added as a Setting for the client app:
...
- The methods from Flowster 4.8.x are still available for usage and should be used as before. They are exposed for backwards compatibility and are visible in the RestAPI documentation page with the suffix Deprecated (Please keep in mind that in the future versions of Flowster Studio, these methods will not be supported anymore and they need to be replaced with the new RestAPI methods).
- The methods from Flowster 4.8.x under Assets and Global Variables are not supported anymore in the new RestAPI. For instance related operations (Assets), please adapt your scripts to use FlowsterInstance methods.
Code Samples
The archive for RestAPI code samples can be downloaded HERE (The zip contains the deprecated code samples and a new methods code samples for the new RestAPI).
...