How to Get Your API Key for the techSHIP Desktop Client [Guide]

Modified on Tue, 10 Jun at 3:07 PM

To use the techSHIP Desktop Client, you must configure it with a valid API Key associated with your user account. This article provides a step-by-step guide to either generate a new API Key or retrieve an existing one.

NOTE: The setup process has changed. You no longer use your username and password to configure the techSHIP Desktop Client. Instead, you must generate a personal API Key as described below.

For complete installation and login instructions, see How to install the TechShip Desktop Client - [Step-by-step guide].

WARNING: Handle API Keys securely. Avoid exposing them to unauthorized parties.

As a user, you can manage your own API Key. If you are a Portal Administrator, you can also manage API Keys for all portal users. Use the section that applies to your case:

Manage Your API Key
Manage API Keys as a Portal Administrator

A. MANAGE YOUR API KEY

To manage your API Key, click Profile from the main menu.

Available actions:

A. Copy: Copies your API Key to the clipboard immediately.

B. Rotate API key: Generates a new API Key.

WARNING: Generating a new API Key will immediately log you out of all logged-in techSHIP Desktop Clients. You will be prompted to confirm this action.

To log in again, copy your new API Key using the Copy button and paste it into the client.

B. MANAGE API KEYS AS A PORTAL ADMINISTRATOR

To manage API Keys as a Portal Administrator:

1. Click Maintenance from the main menu.

2. Click Portal users.

3. Press Edit for the desired user.

Available actions:

A. Copy API Key: Copies the user's API Key to the clipboard immediately.

B. Rotate API Key: Generates a new API Key for the user.

WARNING: Generating a new API Key will immediately log the user out of all logged-in techSHIP Desktop Clients. You will not be prompted to confirm this action.

To log the user in again, copy the new API Key using the Copy button and paste it into the client.