> ## Documentation Index
> Fetch the complete documentation index at: https://stackone-hub-docs-confluence-api-token-update.mintlify.site/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-docs-confluence-api-token-update/6QOxZsBfCtSHWqb3/images/eploy/image1.png?fit=max&auto=format&n=6QOxZsBfCtSHWqb3&q=85&s=7c595c20ad1c0f498035e7d7ed869fc1" 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-docs-confluence-api-token-update/6QOxZsBfCtSHWqb3/images/eploy/image2.png?fit=max&auto=format&n=6QOxZsBfCtSHWqb3&q=85&s=dde09631a468c9ab74299ef432d6f29a" 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-docs-confluence-api-token-update/6QOxZsBfCtSHWqb3/images/eploy/image3.png?fit=max&auto=format&n=6QOxZsBfCtSHWqb3&q=85&s=fed57cf00bebf56e6363fe77d8064025" 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-docs-confluence-api-token-update/6QOxZsBfCtSHWqb3/images/eploy/image4.png?fit=max&auto=format&n=6QOxZsBfCtSHWqb3&q=85&s=192be6837c55ffc67e12d32a0690e4db" 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-docs-confluence-api-token-update/6QOxZsBfCtSHWqb3/images/eploy/image5.png?fit=max&auto=format&n=6QOxZsBfCtSHWqb3&q=85&s=d9b6c5be3ccf8240725a0d8bffb63c4f" 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-docs-confluence-api-token-update/6QOxZsBfCtSHWqb3/images/eploy/image6.png?fit=max&auto=format&n=6QOxZsBfCtSHWqb3&q=85&s=42d709bfaf45a8ffed0e6f12338b4e1b" 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-docs-confluence-api-token-update/6QOxZsBfCtSHWqb3/images/eploy/image7.png?fit=max&auto=format&n=6QOxZsBfCtSHWqb3&q=85&s=9d79ff7894a2a79c5a5bfda3ddc068b9" 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-docs-confluence-api-token-update/6QOxZsBfCtSHWqb3/images/eploy/image8.png?fit=max&auto=format&n=6QOxZsBfCtSHWqb3&q=85&s=569a09f528ccd166f196acde82f5a8dd" width="1062" height="1348" data-path="images/eploy/image8.png" />
    </Frame>

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

<br />

Congratulations, you're all set! If you face any issues with the steps mentioned above,
please contact us by emailing [integrations@stackone.com](mailto:integrations@stackone.com). We're always here to assist you!

## 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>