Use the IntelliFront BI Postman collection

Use the IntelliFront BI Postman collection to explore native analytics resources and configured reporting workflows in your own IFBI installation. It contains 42 requests in 10 folders, with scripts for the supported example workflows. The API reference describes the complete public API.

Download both files

If your browser displays JSON, use Save as to save each file with its original .json filename.

Import and select the environment

Open the Postman desktop app and select Import.
Import both JSON files.
Confirm IntelliFront BI Public API appears under Collections.
Select IntelliFront BI Environment Template from the environment selector.
Duplicate and rename the environment for your installation if helpful.

The collection uses the Postman Collection v2.1 format. Keep the collection and its matching environment together.

Configure your installation and identity

Variable	What to enter
`baseUrl`	Your IFBI API root, including its configured port (normally 50255) and any IIS application path, without a trailing slash or an added `/api` suffix.
`username` and `password`	An authorised user’s credentials for user authentication.
`domain_user`	`true` for configured domain login; otherwise `false`.
`otp`	A current passcode when required; also enable the disabled X-OTP form field.
`client_id` and `client_secret`	Registered service-client credentials when using client authentication.
`access_token`	Filled by a successful authentication request.

IFBI installs its web application and API in IIS. The web application normally uses HTTPS on port 443; API requests go to the API URL, normally on port 50255. Do not use the web application address as baseUrl.

Replace the example.com host and confirm the API’s protocol, port and application path with your administrator. For an API configured at https://bi.example.com:50255/ifbi, use https://bi.example.com:50255/ifbi/api/token for its standard token endpoint.

Keep credentials and tokens in local values. The distributed environment leaves credentials, tokens, resource IDs and cached configurations empty. Do not export or share a populated environment.

Authenticate

Open 01 Authentication and choose Authenticate an IFBI user or Authenticate a service client. Both send form-encoded requests to /api/token with No Auth.

The service client must have the SERVICE claim. A service identity does not automatically provide the current user ID needed by canvas and favorite operations. Use a suitable user token for those workflows. See authentication.

The scripts clear previous token values before requesting a new token and capture access_token, token_expires_in and token_expires_at after a valid response. Protected requests inherit Bearer Token authentication from the collection. There is no automatic renewal; authenticate again when needed.

Choose a workflow

Folder	What it helps you do
02 Discover native content	Find datasets, dashboards, KPIs and user canvases.
03 Datasets	Inspect configuration and refresh history, export a definition and import it with an approved connection.
04 Dashboards	Inspect configuration, groups, cache timestamps and definition XML.
05 KPIs	Read a selected KPI, calculate its result or update its goal.
06 Canvases	Create a canvas for an existing group and manage the signed-in user’s favorite.
07 Users and groups	Review current-user information, group configuration and membership.
08 Configured report jobs	Inspect a Gizmo and submit one manual-run request.
09 Monitoring and troubleshooting	Read API, queue and latest-error evidence.
10 Schedules and workflows	Inspect existing schedule and workflow configuration.

Choose the intended resource IDs manually. IFBI uses GUIDs for the resource variables in these examples. Set each variable to the resource you intend to use.

Run and verify requests individually

Read each request description and set the variables it names. Do not run the entire collection as a discovery step: it includes dataset import, KPI updates, canvas creation, preference changes and report-job execution.

Some requests build their JSON body in a pre-request script. For KPI calculation and goal updates, first run Get a KPI configuration for the selected kpi_id. Dataset import first requires Export and cache a dataset definition, compatible target connection IDs and a new dataset name.

The scripts check HTTP success and wrapper errors where applicable. After a change, read the configuration back, test the intended user’s access and check the reporting outcome.

Start with Your first native analytics workflow in Postman. For execution behaviour, see configured report jobs. For request failures, use troubleshooting.