Skip to main content

Integration Options

Welcome to our API Integration Options page. MindKey Software A/S provides two distinct APIs to meet your HR data integration needs: the Connector API and the Integration API. Each API has unique features and capabilities, allowing you to choose the best fit for your specific integration requirements. In this section, we'll explore the key differences between the Connector API and Integration API and provide guidance on when to opt for one over the other. Whether you need standardized, read-only access or a more flexible, custom solution with read and write capabilities, this guide will help you make an informed choice.

Connector API​

The Connector API is a standardized HTTP OData API provided by MindKey Software A/S. It adheres to the OData V4 standard and is primarily designed for read-only access. This API exposes a selected set of entities from the MindKey HR SaaS product, following a consistent and well-documented structure. The Connector API is ideal for scenarios where you need to retrieve HR data for reporting, analysis, or integration with read-only systems.

When to Choose the Connector API​

  • Data Retrieval: Choose the Connector API when your primary requirement is to retrieve HR data from the MindKey system. It's well-suited for scenarios where you need up-to-date HR data for reporting, analysis, or data synchronization.

  • Standardized Access: If you prefer using a standardized, well-documented API following the OData V4 specification, the Connector API is the right choice. It provides a consistent and easy-to-use interface for data access.

  • Read-Only Needs: When your integration tasks involve data extraction, querying, and you don't require write access to the HR data, the Connector API is the more suitable option.

Integration API​

The Integration API is a custom REST API developed by MindKey Software A/S. It does not adhere to any specific standard like OData. The Integration API offers a broader set of entities and supports both read and write operations, providing greater flexibility. However, it does not support relations in the same way OData does. This API is suitable for scenarios where you require custom access to HR data and need both read and write capabilities without adherence to standardized relations.

When to Choose the Integration API​

  • Custom Data Access: Opt for the Integration API when you require custom access to HR data, and your use cases involve not only retrieving information but also making changes or updates to the HR data within the MindKey system.

  • Non-Standard Requirements: If your integration tasks necessitate a more flexible approach that doesn't follow the OData standardized structure and does not involve complex relations, the Integration API provides the freedom to design custom solutions.

  • Full Data Control: When you need complete control over the data, including the ability to write, modify, or delete records, the Integration API offers a comprehensive solution.

In summary, the choice between the Connector API and the Integration API depends on the specific needs of your integration project. If you primarily require read-only access to HR data, prefer standardized access, and want to follow the OData V4 specification, the Connector API is the right choice. On the other hand, if your integration demands custom access, a broader range of entities, and both read and write capabilities without the complexity of relations, the Integration API provides the flexibility you need. It's essential to assess your project's requirements and objectives to make an informed decision.