API Tokens are used to authorize invokes of Workflows via REST API

Creating and Managing Tokens

Access the API Keys Management Pane by clicking on your Site name in the left-hand menu and then choosing API Keys.


Click + to generate a new API Key, then choose New Token-based Key

Name

Provides a unique name for the key. When a invoked using a key, the InitialisationXml Property will indicate the key that was used in the form Key: your-key-name in the Username element.

Enabled

Keys can be disabled as necessary. Note that it may take up to five minutes for a disabled key to stop working.

Primary and Secondary Keys

Contains the generated keys. Note that these keys are only available when first generated. If a key is lost it will be necessary to regenerate it and all consumers relying on the old key must be updated to use the new key.

Permitted Workflows

Select the Workflows that will be permitted to execute against this Key. Note that only Workflows that are bound to a REST template are displayed in this list. Flowgear will only authorize the Key against the selected Workflows.

Specifying a Key in an API call


API Keys can be provided via a querystring or via the Authorization HTTP Header.

Providing a Key in the HTTP Authorization Header (recommended)

Specify the Authorization header like this:

Authorization: Key=your-auth-key 

Providing a Key in the URL querystring (not recommended)

Append the querystring auth-key to the request URL. For exampe, if you are invoking this Workflow:

https://mycompany.flowgear.net/customers/123/

Provide the API Key like this:

https://mycompany.flowgear.net/customers/123/?auth-key=your-auth-key

Note that we do not recommend using this technique because it is possible that the URL will be logged.

Did this answer your question?