Technical Documentation

SpreadAPI Enterprise:
On-Premises Deployment Guide

Technical documentation for enterprise IT architecture teams evaluating SpreadAPI for regulated environments.

1. The Business Problem

Excel: The Enterprise's Hidden Business Logic Layer

Large organizations rely on Excel for critical business calculations. These spreadsheets encode years of business knowledge, regulatory requirements, and edge-case handling. They are trusted, audited, and battle-tested.

DomainExamples
Tax & ComplianceVAT calculations, tax residency rules, transfer pricing models
Financial ServicesLoan amortization, risk scoring, portfolio valuations
InsurancePremium calculations, actuarial models, claims processing
ConsultingFee calculations, resource pricing, engagement scoping
ManufacturingBill of materials, cost rollups, margin calculations

The Challenge: Scaling Excel Logic

Excel works well for individual analysts but fails when you need to embed calculations in web applications, process thousands of calculations per minute, or integrate with automation workflows.

Traditional solutions require rewriting Excel logic in code—a process that takes months, introduces calculation discrepancies, and creates maintenance burden.

2. Architecture Overview

SpreadAPI consists of two deployment models:

Cloud (spreadapi.io)

  • Multi-tenant SaaS
  • Managed infrastructure
  • Data stored in our cloud
  • Suitable for non-sensitive workloads

On-Premises (Runtime)

  • Single-tenant, your infrastructure
  • Docker/Kubernetes deployment
  • Data never leaves your network
  • Full data sovereignty

Core Technology

SpreadAPI is powered by an enterprise-grade Excel engine, supporting 500+ Excel functions including modern array functions (XLOOKUP, FILTER, SORT, UNIQUE, SEQUENCE, LET, LAMBDA). It handles complex dependencies and processes calculations in milliseconds.

3. On-Premises Deployment

SpreadAPI Runtime is a lightweight, self-contained calculation server designed for on-premises deployment. It executes Excel-based services within your infrastructure, ensuring complete data isolation.

DeploymentDocker container or Node.js application
StorageLocal file system (no external database required)
NetworkNo outbound connections required
UpdatesManual container updates (you control the schedule)
ScalingHorizontal scaling via container orchestration

4. Data Flow & Compliance Architecture

The Zero-Cloud-Storage Workflow

For maximum compliance, SpreadAPI supports a workflow where no sensitive data ever touches external infrastructure:

1
Build in Browser

Import Excel, define inputs/outputs, test calculations. Everything stays in browser memory.

2
Export Package

Click "Export for Runtime" to download a JSON file containing your service configuration.

3
Deploy Internally

Run SpreadAPI Runtime on your servers. Upload the service package. Your API is live—internally.

Enterprise Mode: Disabled Cloud Storage

For organizations requiring absolute assurance, we offer Enterprise Mode where the "Save to Cloud" functionality is completely disabled. Even accidental data leakage is architecturally impossible.

5. Security Model

Layer 1: Network Isolation

Runs entirely within your network perimeter. No required outbound internet connectivity. Compatible with air-gapped environments.

Layer 2: Container Isolation

Runs in isolated Docker container. Minimal attack surface (Node.js runtime only). No database dependencies.

Layer 3: Calculation Isolation

Each calculation runs in isolated context. No shared state between requests. Memory cleared after each execution.

Layer 4: API Security

Optional authentication (API keys, OAuth, custom). Rate limiting per endpoint. Request/response logging.

What Data is Stored?

Data TypeLocation
Service definitionsLocal JSON files
Workbook dataLocal JSON files
Request logsLocal log files (configurable)
Calculation cacheIn-memory only (cleared on restart)
Input/output valuesNOT stored (processed, not persisted)

6. Deployment Options

Docker Deployment (Recommended)

# Pull the image
docker pull spreadapi/runtime:latest

# Create directories
mkdir -p services logs

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

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

Cloud Platform Options

AzureAzure Container Instances or AKS
AWSECS Fargate or EKS
GCPCloud Run or GKE

All major cloud providers support Docker containers within your private VPC/VNet, ensuring data never traverses public networks.

7. Technical Specifications

API Endpoints

EndpointMethodDescription
/api/healthGETHealth check and version info
/api/servicesGETList deployed services
/api/services/{id}GETService metadata and schema
/api/execute/{id}GET/POSTExecute calculation
/api/uploadPOSTDeploy new service package

Supported Excel Features

Math & Trig

SUM, SUMIF, SUMIFS, SUMPRODUCT, ROUND...

Statistical

AVERAGE, MEDIAN, STDEV, PERCENTILE...

Financial

NPV, IRR, PMT, FV, PV, RATE, XNPV, XIRR

Lookup

VLOOKUP, HLOOKUP, INDEX, MATCH, XLOOKUP

Array Functions

FILTER, SORT, UNIQUE, SEQUENCE, SORTBY

Dynamic Arrays

LET, LAMBDA, spill ranges

Performance

Cold start (first calculation)200-500ms
Warm calculation10-50ms
Complex workbook (1000+ formulas)50-200ms
Memory per service~10-50MB

8. Compliance Checklist

IT Security Review Checklist

Data ResidencyAll data stored on your infrastructure
Data in TransitInternal network only (HTTPS optional)
Data at RestYour encryption, your policies
Access ControlIntegrates with your IAM
Audit LoggingConfigurable request logging
External DependenciesNone - runs fully offline
Vendor AccessZero vendor access to your data
Network IsolationNo outbound connections required

Supporting Your Compliance Requirements

SpreadAPI Runtime's on-premises architecture is designed to fit within your existing compliance framework. The Runtime has no external dependencies, no outbound connections, and stores no data outside your network.

Note: SpreadAPI Runtime is a software component that runs in your infrastructure. Compliance certification is your organization's responsibility based on your overall security posture.

Ready to Get Started?

Contact us to discuss your enterprise requirements.