API

To call 1Integrate programmatically, you can call one of its Web Services APIs which allows it to be embedded within a workflow, or be invoked from other software or scripts.

The API is available from the 1Integrate installation: http://[server]:[port]/1Integrate/rest/.

The API is documented using the OpenAPI standard and is available from the 1Integrate installation: http://[server]:[port]/1Integrate/rest/ (e.g. http://[server]:[port]/1Integrate/swagger).

API Authentication

All calls to the REST service must be authenticated by using either JSON Web Tokens or API Keys.

The API Authentication page summarises the generation of tokens, but for more information on creating API Keys in the 1Integrate interface, see API Keys below.

API Keys

API Keys can be used by software accessing the 1Integrate REST API, instead of creating specific service users to authenticate via usernames and passwords.

API Keys can be managed from the Administration screen in the 1Integrate UI.

API Call Examples

Some common uses of the 1Integrate REST API may feature a number of calls in sequence, the following are quickstart examples of these:

• Discover Data Stores

• Create File Data Store

• Create, Run and Check Session Results

Built-in Function Programmer Guide

The Rule extensibility API allows you to create custom functions ("built-in functions") in Java for use in the 1Integrate.

See the Built-in Function Programmer Guide for more information.