View API Keys

Overview

Hover over Company Administration on the User Profile drop-down in the top right of any screen, and then select API Keys.

Manage the API access keys that TraceLink uses when sending synchronous API messages (e.g. enable or disable API keys).

Getting Started

Certain TraceLink apps (e.g. Serialized Operations Manager) use a synchronous API (e.g. JAVA, .NET) for interactions. All interactions with this API require an access key, which TraceLink uses to authenticate the call.

Search Criteria

  • Company - Location – The entity within the company associated with the API key. Only API keys associated with this entity return in the results table.

Results Table

  • Company - Location – The entity within the company associated with the API key. If the key's configuration is at the company-level, all data across that company is available for that key. If the key's configuration is at the location-level (i.e. a particular location within the company), only that location's data is accessible.
  • Access Key ID – The public component of the API key. This component must be combined with the private component for TraceLink API interactions.
  • Create Date – Date of the key's creation.
  • Status – The key's status.
    • Enabled – TraceLink accepts API calls for the key.
    • Disabled – TraceLink does not accept API calls for the key.
Company - Location Access Key ID Create Date Status Actions
Kendall Pharma WBVYUCDJHOUCPODUULJMA 29 Oct 2015 09:59 PM GMT Enabled Disable
Kendall Pharma - Kendall Louisville Plant 9YL4JAG0WR1XNBKTWJKK 18 Mar 2016 12:56 PM GMT Enabled Disable
Download Private Key
Kendall Pharma - Kendall Mechanicsburg Plant 9LUD2TPRD5X8AHBUVVCM 28 Oct 2015 11:39 AM GMT Enabled Disable
Kendall Pharma - Kendall Woburn NTXDAACGYMDUIXTAKCDQQ 05 Jan 2016 11:40 PM GMT Disabled Enable
Remove

Available Actions

  1. Select a Company - Location from the drop-down.
  2. Select Search.

    The results display in the table.

  • Select Add New API Key.

    The Add API Key screen displays.

Only API keys created during the current session can be downloaded.

  • Select Download Private Key in the Actions column of the results table.
  • In the Actions column of the results table:
    • Select Enable to enable the API key.

      The API key is enabled.

    • Select Disable to disable the API key.
      • Select Confirm in the Disable API Key? dialog box.

        The API key is disabled.

Only API keys with a Status of Disabled can be removed.

  1. Select Remove in the Actions column of the results table.

    The Remove API Key? dialog box displays.

  2. Select Confirm.

    3. The dialog box closes, and the API key is removed.