On-Premises Excel API: Keep Your Data, Scale Your Calculations

On-Premises Excel API: Full Control Over Your Data

Your finance team built a complex pricing model in Excel. Your actuaries maintain risk calculations that took years to get right. Your tax department has formulas for edge cases nobody else understands.

Now other systems should use these calculations. But the data of a calculation must not leave your network, because of data protection law, industry regulation or your own security policy.

The Challenge: Excel Logic as an API Without the Cloud

The usual options:

  • Rewrite everything. Rebuild the Excel logic in Python, Java or JavaScript, and then keep two versions in sync.
  • Stay manual. Keep passing Excel files around, with the errors and version conflicts that come with it.
  • Use a cloud API. That means the values of every calculation are processed on someone else's servers.

For sensitive models none of the three fits.

The Solution: Build in the App, Run on Your Servers

SpreadAPI Runtime calculates your services on infrastructure that you operate. Your applications call the service inside your own network, and the values of a call do not leave it.

SpreadAPI on-premises workflow in three steps: build in the browser, export the package, deploy internally
SpreadAPI on-premises workflow in three steps: build in the browser, export the package, deploy internally

Step 1: Build the Service in the App

You build the service in the SpreadAPI app in the browser, as for the cloud: import the Excel workbook, choose inputs and outputs, and test the calculation on the Configuration tab. The test panel calculates in the editor in your browser.

Step 2: Export the Runtime Package

Open the three-dot menu in the header of the service and choose Export for Runtime, then click Export Runtime Package. A JSON file downloads to your computer. It contains the complete service configuration and the workbook data, formulas included.

Treat that file like the original Excel file: store it safely and pass it on only inside your organisation.

Step 3: Run It on Your Infrastructure

Install SpreadAPI Runtime on your server and import the package. The service is then available as a REST API inside your network. When the workbook or the parameters change, export the package again and load the new file into the runtime.

Keeping the Workbook Out of the Cloud While You Build

By default a service you build is saved in your SpreadAPI account. The technical whitepaper describes a second mode for organisations that do not want that either: in the app's storage setting you choose Private instead of Cloud, the service is then kept in your browser, and you export the runtime package from there. If this matters to you, raise it when you ask for the runtime, so that the set-up is checked for your environment.

SpreadAPI data flow: calculation data stays within your private network
SpreadAPI data flow: calculation data stays within your private network

The Runtime

The following points are taken from the technical whitepaper.

  • Deployment: a Docker container or a Node.js application.
  • Storage: the local file system. Service definitions and workbook data are JSON files. No external database is required.
  • Network: no outbound connections are required. The runtime is compatible with environments that have no connection to the internet.
  • Updates: you update the container yourself, on your schedule.
  • Scaling: horizontally, with several containers behind your container orchestration.
  • Input and output values: processed, not stored.

Starting the Container

As described in the whitepaper:

docker pull spreadapi/runtime:latest

docker run -d -p 3001:3001 \
  -v ./services:/app/services \
  -v ./logs:/app/logs \
  spreadapi/runtime:latest

curl http://localhost:3001/api/health

Access to the runtime is part of your agreement; see "How to get it" below.

The Runtime's API

GET       /api/health         Health check and version
GET       /api/services       List the deployed services
GET       /api/services/{id}  Metadata and schema of a service
GET/POST  /api/execute/{id}   Run a calculation
POST      /api/upload         Deploy a service package

A calculation is called over REST with JSON, like a cloud service. The address is the one of your own runtime, not spreadapi.io:

curl -X POST http://localhost:3001/api/execute/{id} \
  -H "Content-Type: application/json" \
  -d '{"inputs": {"quantity": 100, "region": "EU"}}'

Supported Excel Features

The calculation engine lists more than 500 Excel functions, among them:

  • Lookup: VLOOKUP, HLOOKUP, XLOOKUP, INDEX, MATCH
  • Dynamic arrays: FILTER, SORT, SORTBY, UNIQUE, SEQUENCE
  • LET and LAMBDA, with helpers such as MAP, REDUCE and BYROW
  • Financial: NPV, IRR, PMT, FV, PV, RATE, XNPV, XIRR
  • Statistical and math functions

VBA macros do not run, and links to other workbooks are not followed. See Supported Excel features.

We do not publish performance numbers for the runtime, because they depend on your workbook and your hardware. For the cloud we measured one workbook and describe the method in Excel API response time.

What the Runtime Means for a Security Review

From the checklist in the whitepaper:

  • Data residency: all data is stored on your infrastructure.
  • Data in transit: inside your network only.
  • Data at rest: your encryption, your policies.
  • Access control: you put the runtime behind your own access management.
  • External dependencies: none. It runs offline.
  • Vendor access: SpreadAPI has no access to the data in your runtime.

One thing the runtime is not: a certificate. It is a software component that runs in your infrastructure. Compliance certification remains your organisation's responsibility, based on your overall security set-up.

Who It Is For

  • Organisations whose data must stay on their own servers, for example in financial services, insurance, healthcare or consulting.
  • Teams with compliance rules that do not allow calculation data to be processed in an external cloud.
  • Environments without a connection to the internet.

If the cloud is fine for your data, you do not need the runtime. A regular plan is simpler.

How to Get It

The on-premises runtime is part of the Custom plan and is agreed individually. It is not included in Basic or Pro.

  1. Read the on-premises page and the technical whitepaper.
  2. Write to support@airrange.io, or click Custom in Upgrade Your Plan in the app.
  3. Describe your environment: where the runtime should run, how many services and calls you expect, and which compliance rules apply.

You can build and test the service in the app before that.

Learn More