Cloud: install Web API

Overview

The Web API provides an alternative method of connecting M-Files with SQL Server. On-premise installations typically use an ODBC connection to allow a user to trigger context menu actions in M-Files for processing on the SQL Server. However, M-Files Cloud deployments—and other scenarios where the M-Files Server is not on the same network as SQL Server—can use secure HTTPS web service calls to trigger the same operations on the remote SQL Server.

The Web API is an IIS web application that receives calls from M‑Files and forwards them to the SQL Server where MFSQL Connector is installed. The Web API must be installed on a web server with IIS 7 or later and must have outbound access to the SQL Server.

The MFSQL Connector Web API is a separate installation routine. It is not installed by the main Installer. The Web API is used when the M‑Files Server and SQL Server are in different domains (e.g., M‑Files Cloud) so that context menu actions can securely call SQL over HTTPS.

When to use

  • Cross‑domain or cloud deployments where ODBC direct connections from VAF to SQL are not possible.

  • Optional for on‑prem deployments in the same domain; VAF can call SQL directly without the Web API.

Prerequisites

  • IIS 7+ with HTTPS binding and a valid certificate

  • Service account for the application pool, with outbound access to SQL

  • Connectivity from the web server to the SQL instance/port used by MFSQL Connector

  • When the vault and SQL are in different domains, such as with M-Files Cloud, then use the Web API for context menu actions.

Steps

  1. Install and configure IIS with HTTPS binding (valid certificate)

  2. Deploy the MFSQL Connector Web API package to the site

  3. Create or confirm a service account for API access

  4. Note the HTTPS API base URL and service credentials

  5. Ensure outbound connectivity from the web server to SQL instance/port

Next