Skip to main content

Articles in this section

See more

Can I use the Helm CONNECT API to update or retrieve data?

The Helm CONNECT API allows you to access your data and extend the functionality of our products.

Note We encourage all users of the Helm CONNECT APIs to review our Best Practices and reserve the right to revoke access to our APIs if we observe inappropriate behavior.

You need an API key to access the Helm CONNECT API. If you don't have permission to manage Helm CONNECT API keys, please contact your system administrator or account manager.

Caution An API key is unique to each user and using it is the equivalent of logging in with a user name and password. We strongly recommend that you protect your API key as you would any password.

To create an API key

  1. Go to the Setup > Users > Users tab.
  2. From the list, select the user the API key is for.
  3. Click Edit.
  4. Click New API Key.
  5. Give the API key a name.
  6. Click Create API Key.
  7. From the New API Key window, copy the displayed API key.

    Note Once you close this window without copying the API key, you won't be able to open it again to retrieve the key.

  8. Click OK, I got it.

To revoke an API key

  1. Go to the Setup > Users > Users tab.
  2. From the list, select the user whose API key you want to revoke.
  3. Click Edit.
  4. In the API Keys list, click the Revoke icon to the right of API you want to revoke.
  5. In the warning message, click Yes, revoke the key.

Related articles

\