Connect to your IntelliFront installation

Use your installation’s API URL, prepare credentials and make a small authenticated request.

Your integration connects to the API hosted by your IFBI installation. ReadMe describes the API; it does not host your reporting data or replace your IFBI server.

Use the API URL

IFBI installs both its web application and its API in IIS. The web application normally uses HTTPS on port 443; the API normally uses port 50255. Send API requests to the API URL, rather than the address you use to open the web application.

Ask your administrator for the API’s full URL, including its protocol, host, port and any application path. Build endpoint URLs by appending the documented path to that API root.

Example API rootToken endpoint
https://bi.example.com:50255https://bi.example.com:50255/api/token
https://bi.example.com:50255/ifbihttps://bi.example.com:50255/ifbi/api/token

These examples show an API configured for HTTPS on port 50255. Use the protocol, port and application path configured for your API in IIS. Preserve the application path and avoid adding /api twice. Use the method and path shown for each operation in the API reference.

Prepare a minimal first connection

  1. Confirm that the application server can reach the API host and port. When using HTTPS, confirm that it trusts the API’s certificate.
  2. Obtain an authorised IFBI identity for the task. Start with a user identity when the endpoint requires a current user ID.
  3. Request a token through Get an access token.
  4. Send it as Authorization: Bearer <access_token> on one small request, such as the current-user information call.
  5. Read both the HTTP status and the endpoint’s documented response body.

The Authenticate and make your first API request recipe in Recipes includes a complete Python example. Install its requests dependency and set the API root and credentials in your process environment. Keep credentials and bearer tokens on the server side.

Using the API reference interactively

Set the reference’s server URL to your API address, including its port and application path, before using Try It. Do not use the web application URL. A successful request from your application server does not guarantee that a browser can reach the same private host. Browser access also depends on network reachability, TLS trust and the installation’s browser request configuration.

Before expanding the integration

Confirm that the intended user can access the selected reporting content. A token establishes identity; it does not bypass content permissions or licensing. Record the installation and resource IDs together so development and production mappings remain separate.

Next: Authentication and Requests, responses and errors.


Did this page help you?