Skip to content

Getting Started

Zachary Way edited this page May 30, 2023 · 1 revision

Getting Started with Krios API Integration

This guide will walk you through the necessary steps to get started with integrating your application with the Krios API. By following these instructions, you'll be able to authenticate your application, make API requests, and access HR data seamlessly.

Prerequisites

Before you begin, make sure you have the following:

  • A Krios API account and valid credentials.
  • Basic understanding of RESTful APIs and HTTP requests.
  • Familiarity with your chosen programming language and tools.

Authentication

To interact with the Krios API, you can use Azure Active Directory (Azure AD) authentication. Follow the example below to authenticate your PowerShell application using Azure AD and obtain an access token:

$accessToken = Get-MsalToken -TenantId $tenant -ClientId $clientId -Scopes $Scope -ClientSecret $secretString -AzureCloudInstance AzurePublic

$headers = @{
    "Authorization" = "Bearer " + $accessToken.AccessToken
    "Api-Version"   = "v1"
}

Replace the $tenant, $clientId, $Scope, and $secretString variables with the appropriate values specific to your Azure AD configuration.

Making API Requests

Once authenticated, you can start making API requests to access HR data from Krios. The Krios API offers various endpoints to retrieve information such as employee details, time-off balances, work anniversary information, and more.

Refer to the API Endpoints section to explore the available endpoints, their purposes, required parameters, and expected responses. You'll also find code examples demonstrating how to make API requests using popular programming languages.

Data Formats

The Krios API primarily communicates using JSON for both request payloads and response data. It's important to ensure your application can handle and process JSON data efficiently.

In the Data Formats section, you'll find information about the data formats used in the Krios API, including examples of request and response payloads.

Next Steps

Now that you have a basic understanding of getting started with Krios API integration, you can proceed with implementing specific functionalities based on your application's requirements. Explore the rest of the wiki to find code examples, additional guides, and answers to frequently asked questions.

If you have any questions or need further assistance, don't hesitate to reach out to our support team. Contact information can be found in the Support section.

We wish you success in integrating your application with the Krios API!

Clone this wiki locally