Overview

To authenticate Eploy, you will need to provide an API key. This guide will walk you through finding or creating the API key within Eploy.

Instructions

Step 1: Create your API key

1. In your Eploy account, go to Admin > Security Settings > API Keys

   

2. Click New > REST API

   

3. Give your API Key a name

4. Select your user account "Run As User"

   

5. Click Save

Step 2: Retrieve credentials

1. Copy the Client ID and Client Secret, which will be used to authenticate your account in Step 4

   

Step 3: Add API Permissions

1. Click "Add API Permissions"

2. Add the following View Permissions(note: if your use case requires creating or updating information in Eploy, select Insert and Update permission accordingly):

   • Actions

   • Applications

   • Candidates

   • Contacts

   • Export

   • Placements

   • Users

   • Vacancies

   • Vacancy Templates

   • Workflows

     

Step 4: Enter your credentials

Copy the Client ID and Client Secret from Step 2 into the linking flow