Skip to content

Quick start (5 minutes)

The goal: start from a fresh installation and end up with an authenticated request whose URL and token both come from variables. Allow five minutes.

File ▸ New (Ctrl+N), then File ▸ Save as (Ctrl+Shift+S) to give it a name, for example demo.restorm.

A project is just a file on your disk. You can drop it in a git repository right away — Restorm is built for that.

Right-click in the sidebar tree ▸ Add ▸ Environment folder.

An environment folder (also called a variables folder) is the container that carries your environments — local, staging, production — and therefore your {{variables}}. Every request inside it inherits the selected environment.

Open it, create a local environment and add a variable to it:

KeyTypeValue
baseUrlStringhttps://api.exemple.test

An environment folder's tab, on its Environments sub-tab: the selected environment on the left and its baseUrl variable on the right

Right-click the folder ▸ Add ▸ HTTP request. In the tab that opens:

  • leave the method on GET;
  • type the URL {{baseUrl}}/health — the resolved value appears under the field, which is your safety net;
  • click Send.

The response opens below: status, time, size, headers, and the body rendered in a collapsible JSON viewer.

An HTTP request whose URL uses {{baseUrl}}, with the response panel open on the right — status, time, size and JSON body

Rather than pasting a hard-coded token, create an authentication request: right-click ▸ Add ▸ HTTP authentication request. Configure the call that obtains the token (for instance a POST /oauth/token), then, in its Configuration tab, declare what it produces:

Header producedValue
Authorization{{token_type}} {{access_token}}

The value is an expression evaluated against the response body of the authentication request. While you are there, fill in the expiry expression (for example {{expires_in}}) so that Restorm renews the token on its own.

Go back to your GET request and, in the top bar, pick that authentication route. The header is now injected on every send, and a 401 automatically triggers a renewal followed by a retry.

Details: Authentication.

  • Already have a specification or a collection? File ▸ Import (Ctrl+I) rebuilds the whole tree: see Import & export.
  • Chain several calls and check the results with a scenario.
  • Run that scenario in your CI: Headless execution.