> ## Documentation Index
> Fetch the complete documentation index at: https://hub.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Eploy

> Follow these steps to connect Eploy with StackOne Hub successfully.

<Warning>
  Ensure you have Admin privileges for your Eploy account.
</Warning>

If you've been directed to StackOne to integrate with Eploy, the following steps will help you understand the process and any necessary actions to configure successful integration.

## Getting your Subdomain

<Steps>
  <Step title="Find the Subdomain">
    You can find the subdomain in the URL of your Eploy account by taking the portion that appears before `.eploy.net` and after `https://`.

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Subdomain Example" src="https://mintcdn.com/stackone-hub/u-H1QhLRqf-fRM_1/images/eploy/image1.png?fit=max&auto=format&n=u-H1QhLRqf-fRM_1&q=85&s=b849c32d26a90600d2b59a99d56dc463" width="1918" height="912" data-path="images/eploy/image1.png" />
    </Frame>
  </Step>
</Steps>

In this example, the value would be: stackoneapidemo

## Generating Client Id and Client Secret

<Steps>
  <Step title="Navigate to API Keys">
    In the top navigation bar go to `Admin` → `System / Security Settings` → `API Keys`.

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Create API Key" src="https://mintcdn.com/stackone-hub/u-H1QhLRqf-fRM_1/images/eploy/image2.png?fit=max&auto=format&n=u-H1QhLRqf-fRM_1&q=85&s=c11e7de1348deb104410208c31db3898" width="962" height="781" data-path="images/eploy/image2.png" />
    </Frame>
  </Step>

  <Step title="Create a New API Key">
    On the top-right select `New` → `Rest API`.

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Create API Key" src="https://mintcdn.com/stackone-hub/u-H1QhLRqf-fRM_1/images/eploy/image3.png?fit=max&auto=format&n=u-H1QhLRqf-fRM_1&q=85&s=b4b8231511cdbfefb9ce38daf611da52" width="763" height="764" data-path="images/eploy/image3.png" />
    </Frame>
  </Step>

  <Step title="Name the API Key">
    Enter `title` for the API Key, for example: `StackOne`.

    Select an `API User` for your API Key to use and click `Save`.

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Create API Key" src="https://mintcdn.com/stackone-hub/u-H1QhLRqf-fRM_1/images/eploy/image4.png?fit=max&auto=format&n=u-H1QhLRqf-fRM_1&q=85&s=9a1421148331cc35e7fb91d4e94acaa7" width="860" height="504" data-path="images/eploy/image4.png" />
    </Frame>
  </Step>

  <Step title="Record Client ID, Client Secret and Assign Permissions">
    Your `Client ID` and `Client Secret` will be generated and displayed to you. Copy them to a safe place.

    Assign API permissions based on the integration requirements by clicking on `Add` button.

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Generated API Key" src="https://mintcdn.com/stackone-hub/u-H1QhLRqf-fRM_1/images/eploy/image5.png?fit=max&auto=format&n=u-H1QhLRqf-fRM_1&q=85&s=144436be9c35019125a10c6fcbf1ce9e" width="889" height="874" data-path="images/eploy/image5.png" />
    </Frame>

    Select and enable each of the API permissions below used in this integration, and click `Save` for each.

    <Accordion title="API Key Permissions">
      * **Actions**
        * Insert
        * View
        * Update
      * **Applications**
        * Insert
        * View
        * Update
      * **Candidates**
        * Insert
        * View
        * Update
      * **Companies**
        * Insert
        * View
        * Update
      * **Contacts**
        * Insert
        * View
        * Update
      * **Export**
        * View
        * Insert
      * **Files**
        * View
      * **Pay Rates**
        * View
      * **Pay Salaries**
        * View
      * **Placements**
        * Insert
        * View
        * Update
      * **Purchase Orders**
        * View
      * **Timesheets**
        * Insert
        * View
        * Update
      * **Users**
        * Insert
        * View
        * Update
      * **Vacancies**
        * Insert
        * View
        * Update
      * **Vacancy Templates**
        * View
      * **Workflows**
        * View
    </Accordion>

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Generated API Key" src="https://mintcdn.com/stackone-hub/u-H1QhLRqf-fRM_1/images/eploy/image6.png?fit=max&auto=format&n=u-H1QhLRqf-fRM_1&q=85&s=1454f18f053b9b68bd01db412bf441d3" width="888" height="868" data-path="images/eploy/image6.png" />
    </Frame>

    Click `Save`.
  </Step>
</Steps>

## Connecting with StackOne

<Steps>
  <Step title="Enter the Details">
    Upon reaching the Link Account page, enter the `Subdomain`, `Client ID`, and `Client Secret` gathered from the steps above.

    Enter `scopes` to optionally restrict this API key's access.

    Only the scopes assigned above during API key configuration will be allowed — see the full list <a href="https://support.eploy.co.uk/hc/en-gb/articles/14711773981853-Eploy-RESTful-API-Full-Developer-s-Guide#:~:text=A%20full%20list%20of%20Scopes%20are%20as%20follows">here</a>.

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Link Account" src="https://mintcdn.com/stackone-hub/u-H1QhLRqf-fRM_1/images/eploy/image7.png?fit=max&auto=format&n=u-H1QhLRqf-fRM_1&q=85&s=2f7af908a5956b2a42d99f6fae59550c" width="1046" height="1342" data-path="images/eploy/image7.png" />

      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Link Account" src="https://mintcdn.com/stackone-hub/u-H1QhLRqf-fRM_1/images/eploy/image8.png?fit=max&auto=format&n=u-H1QhLRqf-fRM_1&q=85&s=2b62f61a00818454050ee9b8c1fa7a96" width="1062" height="1348" data-path="images/eploy/image8.png" />
    </Frame>

    Click `Connect`.
  </Step>
</Steps>

## Useful Links

<Card title="API Reference" icon="link" href="https://support.eploy.co.uk/hc/en-gb/categories/14740107974941-Eploy-RESTful-API">
  [https://support.eploy.co.uk/hc/en-gb/categories/14740107974941-Eploy-RESTful-API](https://support.eploy.co.uk/hc/en-gb/categories/14740107974941-Eploy-RESTful-API)
</Card>