Developer Docs

Revolution is extended by plugins: a plugin is registered in a customer’s tenant, authenticates with a key pair it holds itself, and calls the Revolution REST API with a token scoped to exactly what that customer granted it.

Authentication How a plugin authenticates with private_key_jwt, and the two kinds of plugin.

REST API Every plugin-accessible endpoint and parameter, generated from the OpenAPI spec.

What to read first

Get a token

Start with Authentication. Your customer registers your plugin and grants it scopes; you sign a short-lived assertion and exchange it for an access token.

Build a plugin

A user-interface plugin is a page your customer’s scientists launch from Revolution’s sidebar. A service plugin is a background process with no user at all. The UKRobotics.Plugins.Sdk NuGet package and the starter templates implement both.

Find the endpoint you need

The API Reference lists every route that accepts a plugin token, and the REST API page lists the scopes.

Conventions

Across every code sample in this section:

• $TOKEN — a plugin access token. See Authentication for how to obtain one.
• $TENANT_ID — the tenant you are integrating with. It is in the Revolution URL your customer uses, and it is also handed to a UI plugin as a launch parameter.
• $REVO — the origin of the Revolution instance you are calling. There is no single public API host: Revolution is deployed per region, and an on-premise customer runs their own — so take the origin from the customer’s own URL (https://revolution.example.com, a placeholder for whatever your customer’s is) rather than hard-coding one.