API User Keys

Owned by Oz Akman
Last updated: Mar 01, 2024 by Keith McCollum
2 min read

API User Keys Overview

To secure your Softrip instance, API methods and calls require an API key. API keys help ensure that only authorized third parties are using your API, and can help with determining over- or under-usage of the API.

When a third party makes a request to the Softrip API for your instance, they will pass the API key that you set up for them in their request.

Creating a new API key

To create a new API key for an API user, go to the Security subsytem's "User API Keys" screen. Note that this screen has to be enabled for your instance by Softrip, and your user account will need security checkpoint S022 to create and manage API keys.

Once on the screen, click the "+" icon to build a new API key:

 

Fill in the details on the detail form for the user for whom you want to create an API key.

Note: that an API key requires an existing user to be loaded. This user may be an internal user, an external user, a contact, or an API user.

 

Fields

  • Name

    • The name of the API key you are building. You can load multiple API keys for the same user, if you or they want to track their usage of different requests separately.

  • Source ID

    • The ID of the user for whom you are building this API key. For example, this will be the UserID for an API user.

  • Source Type

    • The type of user for whom you are building this API key.

    • Valid Source Types:

      • External - An API user (see also External Users)

      • Internal - An internal/in-house user

  • Expiration Date

    • The last date on which this API key will be valid. Requests sent to the API with this API key beyond this date will be rejected as invalid.

  • API Key

    • The unique API key to be shared with the user for whom you are building this API key.

Usage

Once this User API Key is built, the user will be able to send requests to the API.

Examples