Skip to main content

Overview of the Connector API

The MindKey Connector API is a powerful tool designed to facilitate data integration and automation within your environment. This section provides a high-level introduction to the Connector API, outlining its purpose, core features, and the audience it serves.

Purpose and Use Cases​

The Connector API extends the functionality of MindKey by providing a read-only HTTP OData API. Its primary purposes are:

  • Data Integration: You can use the Connector API to extract data from your MindKey instance and integrate it with other systems, such as business intelligence tools, reporting systems, or third-party applications.

  • Automation: The API allows you to automate various HR-related tasks, such as creating Azure AD users, generating scheduled reports, or performing data synchronization.

Audience and Prerequisites​

The Connector API is intended for technical professionals and IT experts who are familiar with HTTP, OData, and API integration. To make the most of this documentation, users should have the following prerequisites:

  • A basic understanding of HTTP and RESTful API concepts.
  • Familiarity with OData query syntax (though we provide a brief introduction in this documentation).
  • Access to MindKey and the necessary permissions to generate API keys.