Create API Application Key or Web Service

Describes how to create API application keys and web services for file transfer uploads and downloads.

Context

When you create an API application key, the system auto-generates the application key, Client ID, and Client Secret.

Procedure

  1. To create a new API Application Key

    1. On the Self-Service Dashboard, choose the API Application Keys tile.

      The Create API Application Key page opens.

    2. Enter the following values:

      • Application Name (must be a unique value)

      • Description

    3. Choose Create.

      The API Application Key List details page opens and displays a success message confirming the key was created. Note that the status of the new key is Active.

      In the API Application Key Details section, the following details display:

      • Application Name is the name you entered on the previous page.

      • Application Key is auto-generated.

      • Client ID is auto-generated.

      • Client Secret is auto-generated.

      • Description is the description you entered on the previous page.

      To edit the API application key, on the right-side of the page, choose Edit. For more information, see Edit API Application Key or Web Service.

  2. To create a new Web Service

    1. After creating an API application key, on the Application Key details page in the Setup Web Service section, choose New on the right side of the page.

      The Edit Details dialog box opens.

    2. Enter/ select the following values:

      • Application Name (must be a unique value)

      • Virtual Person Name (Username)

      • Status (enabled or disabled)

  3. Choose Save.