Article Content

Overview

API keys are used to authenticate requests to the Resolver API without entering user credentials.

Note: For added security, it's recommended that the Admin setting is not enabled for API users unless Administrator privileges are needed to complete the required API calls.

User Account Requirements

The user must have Administrator permissions to access the Admin Overview screen.

Related Information/Setup

Please refer to the API Key Overview article for more information on using API keys in Resolver. 

Navigation

1. Follow the steps to retrieve a user ID. 

2. Follow the steps to retrieve a user's Org membership ID.

3. From the Home screen, click the Administration icon.

Administration Icon

4. From the Administrator Settings menu, click the Admin Overview link.

Admin Overview Link

5. From the Admin Overview screen, click the Swagger Docs tile in the Tools section.

Swagger Docs Tile

Creating an API Key

1. From the Admin: Help screen, enter the keyword apiKey in the search text box, then click the apiKey topic from the results.

APIKey Topic

2. Click the POST /user/apiKey (create an api key) endpoint to open the parameters.

API Endpoint

3. In the Parameters section, click the Click to Populate Example box to populate the template in the body text box.

Click to Populate Example Box

4. In the body text box, delete the 0 in the orgUserId attribute, then enter the user's org membership ID number, obtained in step 2 in the Navigation section. Enter a descriptive name for the API key in the name attribute.

Body Text Box

5. Click the Execute button.

Execute Button

6. Copy the apiKey from the Response Body and store it for safekeeping. For security purposes, once an API key is generated, it cannot be retrieved. If you misplace an API key, a new key must be generated.