Enable your API Key

  • Last updated on December 15, 2020 at 4:36 AM

An API key is used to authenticate your API requests to Sitepass. Every business account is provided with a single API key that can be found on Configuration > Developers > API Key page.

You should keep some key principal’s in mind when using API key

  • API keys should be kept confidential and only stored on your own servers. Your account’s secret API key can perform any API request to Sitepass without restriction.
  • API Keys should be kept in a secure place. Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

To enable your API key, please follow these steps:

  1. Go to Configuration > Developers > API Keys
  2. Click on Enable API Key
  3. At this point, a confirmation message will be displayed. Click Enabled button to enable the API Key.

Obtain your API Key

API keys are not displayed by default.

  1. Navigate to Configuration > Developers > API Keys
  2. If you API key is enabled, then click on Copy to copy the key to your Clipboard, otherwise refer to Enabling your API key.

You can also click on Click to reveal to view your API key.

Note: Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Was this article helpful?