Integration Concepts 1 – How to configure REST in Flowfinity

Flowfinity 19.3 includes Representational State Transfer (REST) integration features. These features are disabled by default as a security measure, so to use this method REST must be enabled by following 4 steps:

  1. Create a new user account and assign the type as 'Integration'
  2. Enable surface configuration Execute and/or Query functions
  3. Configure an integration Operation
  4. Configure an integration View or View level.

1. Create a dedicated Integration type user account

To integrate with external applications using REST you must first create a dedicated user account and assign the 'Account type' as 'Integration.' This user account will require a license like any regular or robot user. To create the dedicated integration user follow these steps:

  1. In Flowfinity, navigate to the 'Configure' tab.
  2. Select the 'Users' tab, then 'Add User.'
  3. Set the 'Account type' to 'Integration.'
  4. Assign an account username (restuser) and password.
  5. Click 'Apply & Next.'
    Flowfinity - How to configure REST
  6. Select a Role Membership of 'Regular User' for the Integration user.
  7. Click 'Save' to create the Integration User Account.
    Flowfinity - How to configure REST

2. Enable surface configuration

The following steps outline how to enable Surface Configuration:

  1. In Flowfinity, navigate to the 'Configure' tab.
  2. Select the 'Integration' tab, then 'REST Integration.'
  3. Under 'Surface configuration' there are two checkbox options:
    Check 'Execute()' to allow external applications to invoke operations in your Flowfinity apps.
    Check 'Query() to allow external apps to retrieve data from your Flowfinity apps.
    Flowfinity - How to configure REST

    Specify the dedicated Integration User Account that will be used.
    If you receive the error message: 'There are no available account of "Integration Account" type found'. This means you need to configure a dedicated Integration User Account.
    Flowfinity - How to configure REST
  4. All the Operations (Execute) and Views (Query) that have been enabled for REST integration are displayed as shown. Each 'details' link under the URL column contains a URL endpoint and example JSON payload.
    Flowfinity - How to configure REST

    For example:
    Flowfinity - How to configure REST

3. Configure an Operation

In order to enable an Operation for REST API integration follow these steps:

  1. Go to the 'Configure' tab and customize the desired application.
  2. Create a new operation or click an existing operation and select 'edit operation.'
  3. Select the Integration tab.
  4. Click the REST Execute() option, this will allow external code and visual workflow orchestration tools to invoke this operation using REST API.
    Flowfinity - How to configure REST

4. Configure a View

In order to enable a View for REST API integration follow these steps:

  1. Go to the 'Configure' tab and customize the desired application.
  2. Select the Views tab in the App Editor.
  3. Select an existing view or create a new one.
  4. Navigate to the Integration tab and select the REST API checkbox. This will allow external code and visual workflow orchestration tools to retrieve this view using REST API.
    Flowfinity - How to configure REST
  5. For Query() view objects contains, select Record Objects. This is necessary for synchronization, as it overrides any Layout settings and returns all fields during synchronization.
  6. In some instances, it may be necessary to add parameters and filters to avoid duplicating data. For further information visit this video.