Skip to main content
All CollectionsIntegrationsAPI
API - Key configuration, benefits and examples of use
API - Key configuration, benefits and examples of use

In this article, you'll learn what Calamari's public API is, how you can leverage it, and how to generate API keys.

Agata Skowrońska avatar
Written by Agata Skowrońska
Updated this week

What is an API and What Can It Do for You?

A public API is a tool that allows you to automate and streamline everyday HR processes. With it, you can integrate Calamari with other systems your company already uses. The API facilitates the automatic exchange of data, eliminating the need for manual input or logging into the system. Think of it as building a bridge between Calamari and other tools, enabling seamless cooperation.

By integrating Calamari through the API, you can, for instance, transfer information about requests, track work hours, or automate recurring report generation and delivery.

Since a public API requires an infrastructure capable of sending requests to the application, we recommend involving your IT department to effectively link Calamari with your other applications.

You can find all the necessary details for building an integration using our API on developers.calamari.io.

What is an API Key?

An API Key acts as an identifier between Calamari and the external system. To use the Calamari API integration, you need to generate an API key.

How to generate an API Key?

Go to Settings → API → Enable.

Once the integration is enabled, you'll have the option to generate as many API keys as you need.

Creating a New API Key

When creating a new API key, you can choose whether the key will allow communication with all available API endpoints or only specific functionalities.

For example:

Our documentation provides a detailed description of each endpoint, including the specific scopes (e.g., Absence Requests, Holidays, etc.).

Important Note:

  • One-time Display: When you click Generate Key, the API key will only be displayed once, allowing you to copy it and use it in your integration tool. This enhances security, as the key cannot be retrieved again by any administrator.

  • Changes Upon Re-enabling: Each time you disable and re-enable the API integration, your API key will change. This may affect the functionality of existing integrations.

Tip:

The application interface allows you to check basic information about the API keys you’ve generated.

Additionally, if a key hasn’t been used for over 12 months, the system will suggest verifying whether it’s still needed.

Did this answer your question?