Documentation

Go to "Apps > Developer API > Documentation".

'Documentation’ has all available APIs. The content is available in English only.

A developer API is required to develop APIs. The key is already stored in the API portal and is automatically applied in 'Try it out’ mode. For external tools, the key must be copied from Climatix IC and added to the tool. As follows:

  1. Click 'Copy primary API key'.
  2. Or click 'Copy secondary API key'.
  1. The primary or secondary developer API key was copied to the clipboard and can be added to the external tool.
info

On how to create and regenerate API keys: See 'Developer API' and 'API Key'.

  1. Click an API (1).
  2. A drop-down menu with available 'API endpoints' opens.
  3. Click one of the available actions (2).
  4. The entry masks with fields to enter programming texts opens as well as examples for programming code.
  6. Enter the mandatory or optional parameters.
  7. Click 'Execute' (3).
  9. 'Execute' changes to 'Execute' and 'Clear' (4).
  1. The action is performed.
  2. 'Responses' documents the results of the action (5).
  3. An error message appears in the case of bad entries.
  1. Select 'Execute’ again to repeat your action.
  2. Use 'Clear’ to delete your entries.

The developer API is located by default in active 'Try out’ mode. Click 'Cancel' (6) to stop the 'Try out’ mode. Click 'Try it out' (7) restart the 'Try out’ mode:

  1. Click 'Cancel' (6)
  3. 'Try out’ mode stops.
  4. The 'Cancel' button is replaced with the 'Try it out' (7) button.
  5. Click 'Try it out'.
  1. 'Try out’ mode restarts
  2. 'Cancel' button displays again.