ApiForms

Welcome to this tutorial on A-P-I Forms in Biz Control.

In this video, we will show you how to make an existing Form available as an A-P-I Form, allowing external systems to create and access Form instances directly through API communication.

A-P-I Forms are smart digital questionnaires that can include predefined scoring and impact calculations. Through API integration, these Forms can be embedded into operational processes within third-party or bespoke applications, while all Form instances remain centrally managed in Biz Control.

To begin, navigate to the Forms page.

Here, you can either create a new Form or use an existing one. For this example, we will use an existing Form.

Select the Action button next to the Form and choose Create A-P-I Form.

A new window will open, prompting you to select a Workspace.

Choose the Workspace where all future Form instances created through this A-P-I Form should be stored.

This is an important step, as every time the A-P-I Form is called from an external system, the resulting Form instance will automatically be recorded within the selected Workspace.

Once the Workspace has been selected, confirm your choice.

The Form is now available as an A-P-I Form.

Next, navigate to the Configure page and ensure that the correct Workspace is selected in the upper-right corner of the screen.

In the A-P-I Forms table, locate your A-P-I Form and select the A-P-I Form Key button.

This section contains the information your developers need to integrate the Form with external systems.

Before an external application can create Form instances, it must first authenticate with Biz Control using the provided authentication endpoint and API credentials.

After successful authentication, Biz Control returns an access token that authorizes subsequent API requests.

The A-P-I Form Key section also contains the unique API endpoint for this specific Form.

When this endpoint is called, a new Form instance is automatically created in the selected Workspace.

Additional information, such as Order Numbers, Shipment Numbers, Case IDs, or other business identifiers, can be passed as tags within the API request. These tags are then stored with the Form instance for easy reference and reporting.

Once the Form instance has been created, Biz Control returns a response containing a direct Task Link.

This link can be stored within the external system, allowing users to reopen and continue working on the same Form instance at any time directly from their operational process.

You're now ready to connect your Forms to external applications and streamline your business processes with powerful API integration.

Thank you for watching, and as always: Biz Control — Get it done.