API Keys

API keys enable API integration with other products (e.g. %kiosk_product_name%, %email_product_name%).

Generating API Keys

  1. From the left sidebar menu, go to "Settings" → "Security" → "API Keys."
  1. Click the "Add API Key" button.
  2. Select the expiration date/hour from the calendar. Provide a description for the key for further reference. Example: for an integration with multiple applications, generate a key for each application for better control.
  3. Choose between "User Level API key" and "System Level API key."

By default, the API keys are created at user level. System level API keys can be created by enabling the toggle.

By selecting a System level API key, you can also enable "Allow Skip %core_product_name% Scanning" and "Allow Skip Supervision" options. With these options the created API key can control the file transfer process in an MFT to MFT integration. A System level API key also has the "Use System Default File Expiration" option which can be used for forces %product_name_short% to ignore file expiration values provided during upload and apply the system-configured expiration instead.

  1. In the "API Key" field enter a custom 30-character key or use the pre-generated key and click "Add."

Edit API Keys

Open the context menu of the API key and click the "Edit API Key" button. Adjust the key's expiration date or the related options (in case of a System level API key) in the pop-up modal.

VariableType to search · ESC to discard
GlossaryType to search · ESC to discard
InsertType to search · ESC to discard
No matches
On This Page