Description API Key Name and Secret

General Information

To get access via the Cloud API to your device you need to provide following information in header on each method call.

  • "x-api-key" = The subsciption key (provided directly from the developer Portal here)

  • "API-Key-Name" = your personal API Key Name (provided via the Zehnder Cloud Dashboard)

  • "API-Key-Secret = your personal API Key secret (provided via the Zehnder Cloud Dashboard)

Subscription Key

The subscription Key provide you access to the Cloud API. Each user of Cloud API needs to create his/her own dedicated subscription in the developer portal.

Because the Cloud API is still a closed beta, when you request for a subscription key it needs a manual approval by Zehnder. For that reason it could take some dates until your request has been approved. You will get notify via mail, when the approval is done. In some cases you may get contact by Zehnder for detailed information about the use case of the API.

API Key Name / API Key Secret

The combination of API Key Name and API Key Secret give you access to your devices registered to your Account.

Security Risk: It is important that you carefully protect this information against misuse from thirdy party users.

How to get my personal API Key Name and API Key Secret:

To get your personal personal API Key Name and API Key Secret follow these steps:

  1. Login on the Zehnder Cloud Dashboard as End Customer
    If you are already login on the developer Portal you will automaticaly login on the Zehnder Cloud Dashboard as soon as you use the same account for cloud enabling of your device and developer portal.
    Important: The account used for Cloud Enabling needs to be used to login on the Zehnder Cloud Dashboard

  2. Open the Application setting

  3. In this windows choose the Application tab.

  4. Here you can click on the Button "Create API-Key".
    Your personal "API-Key-Name" and "API-Key-Secret" will be generated.

  5. Do see you personal you can manage this setting page, here you have also the option to delete the API-Key Pair.

Security Information: In case you have the suspicion, that you API-Key pair is misused, please immediatetly delete your API-Key Pair and create a new one via steps
described above.
Zehnder Employee has now access to your security information, in case you lost it please visit the Zehnder Cloud Dashboard to read your API-Key Pair.