Versions Compared

Version Old Version 5 New Version Current
Changes made by

Michael Stivers

Michael Stivers

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

On this screen, you can create an ShipHawk API key, and view a list The Developer API screen provides how to get an API URL and API Key.

For security reasons, a user who wants to generate an API Key must be logged in using Two Factor Authentication (2FA). See Using Two-Factor Authentication (2FA) in ShipHawk TMS

On the ShipHawk TMS, choose ⚙️ > Settings > Developer API:

...

  • Get the API URL: On the Developer API screen, the field Use this URL for all API integrations provides the API URL.

  • Get the API Key: To create a new API key, click CREATE API KEY. In the pop-up, enter a descriptive (what will this key be used for?) name for the API key.

Next, the screen lists of all your keys for the ShipHawk API.

Note

  • Managing these keys will make sure that you do not accidentally book shipments.

  • ShipHawk API keys must never be published and must be kept confidential.

  • These keys can perform any API request to ShipHawk without restriction.

The list of API keys indicates the Name, Status (Active or Revoked), Days Active, and Last Action. From the list, you can revoke individual keys by clicking Revoke in the Actions column. Note that you show only the active keys by selecting Hide revoked keys in the upper right corner.To add a new API key, click CREATE API KEY. In the pop-up, enter a descriptive (what will this key be used for?) name for the API key.

See also: https://docs.shiphawk.com/#api-keys

...