- 3 minutes to read

Install Web API

The Nodinite Web API is the REST API behind the Web Client, your reports, and your automation scripts. It ships with the Core Services package, so you never install it on its own: you configure your environment in the Nodinite Portal, download the generated ZIP, and run the CLI package. The complete procedure is in Install Nodinite v7; this page lists what matters for the Web API.

Before you start, check the Web API Prerequisites (IIS features, SQL Server rights, firewall).

What You Set for the Web API in the Portal

Setting Portal step
Authentication mode: Windows Authentication or OAuth 2.0 / OpenID Connect Step 2: Auth → Auth mode
Service account defaults (Windows Authentication), including gMSA Step 2: Auth → Service account defaults
Web API Audiences (OAuth 2.0 / OpenID Connect) Step 2: Auth → Web API
SQL Server type and connection string for the Configuration Database Step 3: Infrastructure → SQL Server connectivity
Server that hosts the Core Services Step 4: Servers → Selected server
TLS host name (FQDN) and certificate subject Step 4: Servers → Core host Configuration
Web API port and service identity Step 4: Servers → Core platform services
Summary of allocated ports, download of the ZIP Step 6: Review and Download

Tip

For OpenID Connect with Microsoft Entra ID, prepare the app registrations first, including the Web API app registration that defines the audience: Install Nodinite v7 - OpenID and Install Nodinite v7 - OpenID - EntraID.

What the CLI Does for the Web API

You run the generated package with Nodinite.Installer.Cli.exe in an elevated PowerShell 7 prompt (Step 7: recommended workflow: validate, dry-run, deploy). For the Web API, the CLI:

  • Creates the Web API IIS web site and its application pool, with the port, TLS binding, and identity from the Portal
  • Configures the site for the authentication mode you chose in the Auth step
  • Deploys the Web API binaries together with the other Core Services, and registers the service addresses that the Web API reads from the ProductArtifactsPath System Parameter

Don't change the site, bindings, or authentication by hand; change the value in the Portal and run the package again.

Verify the Web API

  1. In IIS Manager, check that the Web API site and its application pool are Started.
  2. Browse to Scalar at the root of the Web API site, for example https://nodinite.contoso.com:<port>/scalar, using the TLS domain name and the Web API port from the Portal. If Scalar opens, the base URL is right; see Find the base URL.
  3. In Scalar, send a test request to GET api/Users/whoami. The response lists your identity and your Nodinite Roles.
  4. Open the Web Client and a Log View to confirm that the Web Client reaches the Web API.

If the CLI reports errors, see Step 7: Troubleshooting and the Web API Troubleshooting page. To call the Web API from scripts, continue with Manage the Web API.

Note

Nodinite v6 is no longer supported. To move an existing v6 installation, follow Updating from v6 to v7.

Next Steps