Minimum Software Version8.14.3
Solution(s)Cases International ✓ Cases US ✓ Institutions ⨉

Third party software vendors can integrate with Opus 2 via REST API. Once set up, a user can get a token from the application and then they can give that to a third party application that has been set up to read and write content via the API as an alternative to logging in and viewing and editing content through the user interface. 

The aforementioned authentication for the REST API can be generated yourself.

Overview

Requests to the external API execute as a specified user within the Opus 2 Platform. This can be a real user, but can also be an "automation" user created specifically for API use. Requests made through the API all have the same permissions and capability checks as that user when accessing Opus 2 via the user interface. Requests are authenticated with a bearer token that is first generated when the user is logged into Platform. 

Prerequisites

Log into the platform as the user who will be using the API.

To generate a token: 

  1. Select your user profle.
  2. Select the Application tokens tab.

Application tokens tab showing Generate token button

  1. Select Generate token.

  1. Ensure the API version is set to V8.
  2. Give the token a name.
  3. Select Generate. 

  1. Copy and paste the token in to the third-party system (or your own code) which then uses the API. This token is confidential and should be treated in the same manner as a password. 
Once generated, tokens cannot be recovered from Opus 2. A user may generate new tokens at any time and replace their token in the external system.

To revoke a token, select the Application tokens tab. 

Related articles 

Using the Inbound Documents API