Articles in this section
Category / Section

How to Access your API Keys

Published:
2 mins read
Updated:

Zuddl provides an Access key ID and Secret key for org admins to authenticate API requests. These keys are unique to each Zuddl org.

  • API key: An API key has the necessary permissions to access Zuddl resources.
  • Secret key: A secret key is unique to each Zuddl organization and is used in the authorization header for API requests.
Only Zuddl admins can create and manage API keys.


How to access your keys

To access the keys:

  1. Login to your Zuddl dashboard and go to General settings > API Access Key.
  2. Click on Generate new key.
    1    
  3. On the form enter the following:
    1. Key name: A unique name to easily identify the key
    2. Specify the Scope: The scope of the API key determines whether you can perform read operations or write operations. The read operations make GET API calls, and the write operations include making PUT or POST APIs, such as adding an attendee.
    3. Define key usage. Enter the internal or external website that will be allowed to use the key.
    4. Enter the website URL in a comma-separated format.
      2
    5. You can add more URLs or remove the added website URLs as well.
      3    
  4. Click Generate access key button. This shows the Access key ID and Secret key.
    4
    The secret key is only generated once and does not appear again after you cancel this screen.    
  5. Store the page, save the credentials, or click Download as .env file.
  6. This creates an API key and adds it to the list of created API keys.
Was this article useful?
Yes
No
Help us improve this page
Please provide feedback or comments
Comments (0)
Please  to leave a comment
Access denied
Access denied