# Integrating with Darwinbox

[Prerequisites](#prerequisites)\
[Case One: When you have access to Darwinbox Studio Module](#case-one-when-you-have-access-to-darwinbox-studio-module)\
&#x20;  [Step 1: Creating a Studio User](#step-1-create-a-studio-user)\
&#x20;  [Step 2: Creating an API key](#step-2-create-an-api-key)\
[Case Two: When you don't have access to Darwinbox Studio Module](#case-two-when-you-dont-have-access-to-darwinbox-studio-module)\
&#x20;  [Step 1: Contact your Darwinbox Representative](#step-1-contact-your-darwinbox-account-manager)

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 <a href="#prerequisites" id="prerequisites"></a>

1. An active Darwinbox admin account.

## Case One: When you have access to Darwinbox Studio Module <a href="#case-one-when-you-have-access-to-darwinbox-studio-module" id="case-one-when-you-have-access-to-darwinbox-studio-module"></a>

### Step 1: Create a Studio user <a href="#step-1-create-a-studio-user" id="step-1-create-a-studio-user"></a>

1. Log into your Darwinbox account with super admin role, and go to the modules page.
2. Click on **Darwinbox Studio.**

<figure><img src="/files/nW3MXE1jJ3QIE14Cs2Mz" alt=""><figcaption></figcaption></figure>

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.

{% hint style="info" %}
Username and Password are needed for authentication.
{% endhint %}

<figure><img src="/files/MTB646UlPkxft2NzVC8G" alt=""><figcaption></figcaption></figure>

### Step 2: Create an API key <a href="#step-2-create-an-api-key" id="step-2-create-an-api-key"></a>

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](https://api-docs.darwinbox.com/#e3afba06-d4cf-479e-8605-26388b14eda3)
   2. [Employee CTC Data](https://api-docs.darwinbox.com/#981af6ff-0fac-42f2-bec4-78b8466260aa)
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.

{% hint style="info" %}
For both APIs you’ll need to create separate API keys.
{% endhint %}

<figure><img src="/files/4HhEOstgBT0Idj9SXsJS" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
That’s it! Share the API keys , Dataset Keys for both modules, and Username & Password with your Drivetrain customer success manager.
{% endhint %}

## Case Two: When you don't have access to Darwinbox Studio Module <a href="#case-two-when-you-dont-have-access-to-darwinbox-studio-module" id="case-two-when-you-dont-have-access-to-darwinbox-studio-module"></a>

### Step 1: Contact your Darwinbox account manager <a href="#step-1-contact-your-darwinbox-account-manager" id="step-1-contact-your-darwinbox-account-manager"></a>

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](https://api-docs.darwinbox.com/#e3afba06-d4cf-479e-8605-26388b14eda3)
   2. [Employee CTC Data](https://api-docs.darwinbox.com/#981af6ff-0fac-42f2-bec4-78b8466260aa)

{% hint style="info" %}
That’s it! Share the API keys , Dataset Keys for both modules, and Username & Password with your Drivetrain customer success manager.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://integrations.drivetrain.ai/integration-guide/integrate-with-drivetrain/hris-and-ats/integrating-with-darwinbox.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
