- 4 minutes to read

What is the Nodinite Web API?

The Nodinite Web API is a secure, modern REST-based API that powers end-to-end logging, monitoring, reporting, and automation for your integration landscape. It provides seamless access to the Configuration Database and the Log Databases, enabling you to build custom solutions and automate processes with confidence.

✅ Secure, modern REST API with interactive Scalar and Swagger API references
✅ End-to-end logging and monitoring with audit trails
✅ Enables custom reporting, dashboards, and automation
✅ Integrates with Power BI, Excel, QlikView, and more

On Windows Server, the Web API is an IIS web site, with its own port in each environment, and is installed as part of the Core Services package. See Prerequisites for pre-installation information.

All operations that change data, or involve sensitive actions like downloads or message views, are logged in tamper-resistant Log Audits storage for compliance and traceability.

Understanding the Web API

Everything you do in the Web Client goes through the Web API, and so do your own reports, scripts, and dashboards.

graph LR subgraph "Consumers" roCode(fal:fa-code Build & Deploy) roMobileApp(fal:fa-mobile App) roBrowser[fab:fa-chrome Chrome
fab:fa-firefox Firefox
fab:fa-edge Edge] roReports(fal:fa-chart-line-up Reports) roDashboard(fal:fa-tachometer Custom Dashboards) end subgraph "Web Server and local SQL DB" roWebClient(fal:fa-globe Web Client) roWebAPI --- roDB(fal:fa-database Databases) roBrowser --> roWebAPI roBrowser --> roWebClient roWebClient --> roWebAPI(fal:fa-cloud-sun Web API) roCode-->roWebAPI roMobileApp-->roWebAPI roReports-->roWebAPI roDashboard -->roWebAPI end

The Web API sits in the middle between the databases and its consumers.

Key Components

Component Role for the Web API
Web Client The user interface; every action in it is a Web API call.
Configuration Database Holds the Repository Model, Roles, System Parameters, and other configuration that the Web API reads and changes.
Log Databases Hold the Log Events that Log Views search through the Web API.
Logging Service and Monitoring Service The Web API calls these services, each on its own site and port, and finds them through the ProductArtifactsPath System Parameter.
Log Audits Record every change, and sensitive actions such as message views, with the identity of the caller.

Where the Web API Is Configured

Most Web API settings are set per environment in the Nodinite Portal, and the generated install package applies them. Don't change them by hand in IIS.

Setting Where
Port and service identity Portal, Servers step → Core platform services
Host name (FQDN) and TLS certificate Portal, Servers step → Core host Configuration
Windows Authentication or OAuth 2.0 / OIDC Portal, Auth step → Auth Mode
OAuth 2.0 Web API audiences Portal, Auth step → Web API
SQL Server and connection string Portal, Infrastructure step
System Parameters the Web API reads Web Client or Web API, see System Parameters in Manage the Web API

Managing the Web API

With the Nodinite Web API you can manage and unlock powerful features:

  • Custom Reporting
  • Automation
  • Custom Dashboards

Web API
The Web API as seen from your supported Client Browser.

Custom reporting

Create your own custom reports using the tools you know and love (Power BI, Excel, QlikView, and more) by leveraging the Nodinite Web API. See Reports and Power BI for examples.

Automation

With the Web API, you can automate tasks such as:

  • Populating the Repository Model from your build & deploy process
  • Changing run-time behavior on the fly from your own apps, for example System Parameters
  • Retrieving data for use in your intranet, wiki, custom portals, and apps

To call the Web API from a script, service, or CI/CD pipeline, start with Manage the Web API. It helps you choose between Windows Authentication and OAuth 2.0 client credentials and links to step-by-step Scenarios with code in PowerShell, curl, C#, Python, and Node.js.

Scalar API reference for the Web API showing GET /api/Users/whoami (7.10)
Add /scalar to the Web API base URL to browse every operation, generate code snippets, and send test requests. Swagger is also available at /swagger.

Tip

The Web API is deterministic: the same request returns the same result, which makes it the right choice for automation. To ask natural-language questions about your integrations from VS Code, Claude Desktop, or similar AI tools, use the MCP Endpoint instead. Read more in AI in Nodinite and Web API or MCP Endpoint?.

Custom Dashboards

Use Nodinite to create custom reports in Power BI and display them on the Dashboard within the Web Client.
PowerBI Dashboard
Example: Power BI dashboard integrated with Nodinite Web Client.

System Parameters

The Web API reads several System Parameters, for example MaintenanceMode, ProductArtifactsPath, SqlServer, and the licence keys, and it hosts the api/SystemParameters operations that scripts use to change them. The full list, what each one is used for, and the operations are in System Parameters in Manage the Web API. The step-by-step walkthrough is in Manage System Parameters.

Frequently asked questions

Find solutions to common problems and the Nodinite Web API FAQ in the Troubleshooting user guide.

Next Steps

Prerequisites for the Web API
Install Web API
Manage the Web API
Web API Scenarios
Dashboard
Web Client

Core Services
Update Web API
Monitor Views
Log Views
Repository Model
MCP Endpoint
MCP Endpoint (Core Services)
AI in Nodinite
Log API
System Parameters
ProductArtifactsPath