On-premises runtime

SpreadAPI Runtime runs your services on your own infrastructure instead of the SpreadAPI cloud. This page explains what it is, who it is for, how a service gets there, and how to ask for it.

What it is

Normally a published service is calculated on SpreadAPI's servers. With the on-premises runtime, the calculation runs on a server that you operate. Your applications call the service inside your own network, and the values of a call do not leave it.

You still build the service in the SpreadAPI app in the browser: import the workbook, choose inputs and outputs, test. Instead of publishing to the cloud, you export the finished service as a file and load it into your runtime.

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. See Plans overview.

How it works

1. Build the service in the app. Import your Excel file, define inputs and outputs, and test the calculation on the Configuration (Konfiguration) tab.
2. Export the runtime package. Open the three-dot menu in the header of the service and choose Export for Runtime (Für Runtime exportieren). A window explains the steps; click Export Runtime Package (Runtime-Paket exportieren). A file with the service configuration and the workbook data downloads to your computer.
3. Install SpreadAPI Runtime on your server or infrastructure. It runs as a Docker container.
4. Import the package into your runtime. 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.

What the package contains

The runtime package contains the complete service configuration and the workbook data, formulas included. Treat the file like the original Excel file: store it safely and pass it on only inside your organisation.

How it differs from the cloud

The plan limits described in this help centre (published services, calls per month, workbook size) refer to the SpreadAPI cloud. What applies to your runtime is part of your agreement.

How to ask for it

The runtime is part of the Custom plan and is agreed individually.

1. Read the public page at /on-premises on spreadapi.io. It also links a technical whitepaper about architecture, security and deployment.
2. Write to support@airrange.io, or click Custom in Upgrade Your Plan in the app. See Upgrade and billing.
3. Describe your environment: where the runtime should run, how many services and calls you expect, and which compliance rules apply.

For developers and agents

• Export for Runtime is in the three-dot menu of the service page and needs the workbook to be loaded; open the Configuration tab first.
• The exported file is a JSON package.
• A service in the runtime is called over REST with JSON, like a cloud service. The address is the one of your own runtime, not spreadapi.io.
• Installation, operation and the technical requirements of the runtime are described in the whitepaper at /on-premises/whitepaper.
• An agent connected to a SpreadAPI account works with the services in the cloud account. It does not reach a customer's on-premises runtime through that connection.

FAQ

Can I run SpreadAPI on my own servers?

Yes, with SpreadAPI Runtime. You build the service in the app, export it as a runtime package and run it on your own infrastructure; it is part of the Custom plan.

What is the on-premises runtime?

It is the part of SpreadAPI that calculates services on a server you operate, instead of on SpreadAPI's servers. Your applications call it inside your own network.

Who needs the on-premises runtime?

Organisations whose calculation data must not leave their own infrastructure, for example because of compliance rules. For everyone else the cloud plans are simpler.

How do I get a service into the runtime?

Open the service, choose Export for Runtime in the three-dot menu and click Export Runtime Package. Then import the downloaded file into your SpreadAPI Runtime.

What does the on-premises runtime cost?

It is agreed individually as part of the Custom plan. Write to support@airrange.io with your requirements.

Is the runtime included in Pro?

No. The on-premises runtime belongs to the Custom plan.

What is in the runtime package file?

The complete service configuration and the workbook data, including formulas. Keep the file as safe as your original Excel workbook.

Where do I find technical details about the runtime?

On the public page /on-premises on spreadapi.io and in the technical whitepaper linked there. For questions about your environment, write to support@airrange.io.

Do I have to export again after changing the workbook?

Yes. The runtime uses the package you imported; after a change, export a new runtime package and import it into your runtime.

As an agent, can I deploy a service to my user's own servers?

No. Exporting the runtime package and installing the runtime are done by the user. You can help build and test the service in the cloud account beforehand.