Under maintenance

Heretto Help

Create an API Key

API keys are necessary for authorizing and authenticating users, and to call Heretto Deploy API endpoints. There are two API key types you can chose form: Simple API Key or JWT HS256 Key. For more information on API key types and authentication methods, see Authentication and Security.

This procedure can be completed only by users assigned the Administrator role in Heretto CCMS.

Important:

For production applications, never expose your secret keys in client-side code or third-party web tools.

Ensure you are assigned the Administrator role in Heretto CCMS.

  1. Log in to Heretto CCMS as an Administrator.
  2. In the top-left corner, click the Main Menu and go to Deploy API.
  3. Click the New API Key drop-down menu and select a key type:
    • Simple API Key
    • JWT HS256 Key
  4. In the window that opens, provide key details:
    1. In the Name field, enter a meaningful key name.

      For clarity, we suggest including map or deployment details in the key name.

    1. From the Access Type drop-down menu, select the access type for the key.

      The All Content option grants the token owner access to the entire Content Library. The Specific Map option grants the token owner access limited to a map of you choice.

  5. Click Save.

The new API key is listed in the Deploy API along with its type, name, and access.

Figure 1. The Deploy API interface in Heretto CCMS with a number of API keys configured
Deploy API with list of API keys.

If you created a Simple API Key, you are ready to make authenticated API calls. See Make Authenticated API Calls.

If you created a JWT HS256 key, you must create a JWT. See Create a JWT.