Integrating with Darwinbox

Prerequisites Case One: When you have access to Darwinbox Studio Module Step 1: Creating a Studio User Step 2: Creating an API key Case Two: When you don't have access to Darwinbox Studio Module Step 1: Contact your Darwinbox Representative

Darwinbox has two methods to integrate with their APIs:

1. If you have Darwinbox Studio module as part of your Darwinbox subscription, then you can directly create an API key yourself.

2. If you don't have a Darwinbox Studio module you will need to reach out to your Darwinbox account manager.

Prerequisites

1. An active Darwinbox admin account.

Case One: When you have access to Darwinbox Studio Module

Step 1: Create a Studio user

1. Log into your Darwinbox account with super admin role, and go to the modules page.

2. Click on Darwinbox Studio.

   
3. Under Studio Users tab, click on Add Studio User.

4. Add the below user details in the next screen:

   1. Enter Username as “Drivetrain Integration”.

   2. Select Type as External.

   3. Enter the email address as shared by your Drivetrain customer success manager.

   4. Enter a unique User ID.

   5. Enter a strong password.

Username and Password are needed for authentication.

Step 2: Create an API key

1. Under Darwinbox API Keys Tab, click on Configure Darwinbox API.

2. Drivetrain fetches data from two essential APIs, if more APIs need to be pulled raise this to your Drivetrain’s CSM.

   1. Employee Data
   2. Employee CTC Data
3. Add the below API details in the next screen:

   1. Enter key type as static key.

   2. Enter the API configuration name as Drivetrain Integration Employee Data.

   3. Select the user created in the previous step.

   4. Select the module you want to pull into drivetrain. For employee data API select the module as Core, and Compensation for Employee CTC data.

   5. Select endpoint as /masterapi/employee for employee data and /payrollapi/ctcbreakup for employee CTC data.

   6. Click on Create.

For both APIs you’ll need to create separate API keys.

That’s it! Share the API keys , Dataset Keys for both modules, and Username & Password with your Drivetrain customer success manager.

Case Two: When you don't have access to Darwinbox Studio Module

Step 1: Contact your Darwinbox account manager

1. Initiate a request with your Darwinbox account manager regarding an integration with Drivetrain.

2. Ask Darwinbox team to create a user with name “Drivetrain Integration”.

3. Ask Darwinbox team to create API keys for below APIs:

   1. Employee Data
   2. Employee CTC Data

That’s it! Share the API keys , Dataset Keys for both modules, and Username & Password with your Drivetrain customer success manager.