Prerequisites

Please carefully review the following requirements to ensure you can successfully complete the setup:

• You must be an Administrator of your SAP SuccessFactors instance. Without administrative privileges, you will not be able to locate or access the configuration pages described later in this guide.

  • Alternatively, please contact your SuccessFactors Administrator to perform the integration setup on your behalf.

• The OData v2 API must be enabled and accessible on your SuccessFactors instance. This is typically enabled by default and generally does not require additional configuration.

Overview

The integration setup involves three primary steps:

1. Create a new user and assign a permission group to this user.

2. Create a new permission role and assign it to the newly created permission group.

3. Generate API credentials for the permission role.

This document provides a detailed, step-by-step guide to complete the integration setup.

Find your API domain

Your API domain will depend on which region you are based in. To find it, you have to:

1. Open the SuccessFactors API URLs list.

2. Filter for production environments (unless you're trying to connect a preview instance) 

   

3. Once the filter is applied, find your location and select the API domain. If you are, for example, based in Germany, your production URL would be https://api012.successfactors.eu/

   

   
   Hint: The resulting “API Server” URL will often look quite similar to the SuccessFactors domain you log in on (the API for pmsalesdemo8.successfactors.com is, for example, located at apisalesdemo8.successfactors.com)

Find your Company ID

1. Click on the profile picture in the top right and then on "Show version information":

   

2. Copy the value right next to Company ID:

   

Create a new user

• In the admin center, go to the search console and type in "Import Employee Data"
  Click on the action that just appeared:

  

• Click on "Import data" and then select "Download Template":

  

• Click on the field next to "Select an entity" and then on "Basic Import":

  

• Click on the "Generate Template" button

  

• You will receive a .csv file to download. It likely contains two rows.

• Add an additional row and fill out at least these fields
  - Status: active
  - User ID: SFAPI_INTEGRATION (for example, any value possible)
  - Username: SFAPI_INTEGRATION (for example, any value possible)
  - First name: API (for example, any value possible)
  - Last name: Integration (for example, any value possible)
  - Email: integration+user@example.com (any value possible - doesn't have to be a valid email)
  - Manager: NO_MANAGER
  - HR: NO_HR
  - Default locale: en_US
  
  

  

  
  
  It's important that you generate your own .csv template and don't download this example as your SuccessFactors instance will be configured differently
   

• Now click on "Download Template" and then on "Import Data" to switch back

  

• Click on the field next to "Select an entity" and then on "Basic Import"

  

• Click on the "Browse" and select your .csv file to upload

• Click on the "Validate Import File Data" button

  

• If you see the "Validation Successful" dialog, click on the "Import" button

  

• You should now see this success dialog 

  

• Please keep the .csv file open in the background, as you will need to reference it later.

• You can ensure the creation succeeded by searching for the employee name (first name and last name) or username and seeing it under the "People" section. Don't be confused if the new user doesn't show up immediately, it can sometimes take a few minutes for the user to show up in the search!  

  

• Once the user shows up as described in step 12, you can move on to creating the permissions group. 

Create a permissions group

1. Go to your search bar and enter "Manage Permission Groups"
   Click on the Action

   

2. On the new page, click the "Create New" button

   

3. Give the group a "name" and click on "Pick a category"
   Select the category option "Username"

   

4. Search for your user by entering its username and tick the box next to it

5. Click "Done"

   

6. You should now see your user in the people pool

7. Click "Done"

   

Create a permission role

1. Go to the search bar and enter "Manage Permission Roles" 
   Then click on the action with the same name

   

2. On the new page, click on "Create New"

   

3. Enter a name for the permission role

4. Click on the "Permission" button

   

5. Now you have to assign the correct permissions to the permission group. To do this, go through the following steps:

   1. candidate.fyi team will tell you the required permission
       

   2. For each permission, find the permission category in the sidebar. I.e. for "Manage System Properties", find the corresponding permission group in the sidebar of the SF UI
      

      

   3. Now for each sub-bullet, click the right permission in the category

      

6. When you checked all necessary permissions, click "Done"

   

7. Now click on the "Add" button under section 3

   

8. In the new window, click on the "Select" button

   

9. Enter the name of your permission group

10. Click "Done"

    

11. You should now see your permission group

12. Click "Done" again

    

13. At last, click "Save Changes"

    

Generate new OAuth2 client credentials

1. Go to your search bar and enter "Manage OAuth2 Client Applications"
   Click on the action

   

2. In the new window, click on "Register Client Application"

   

3. In the new window enter a name and a valid URL (this can be literally any URL, you can enter any value you want - it should start with 'https://') for the application, then click the "Bind to Users" checkbox and click "OK"

   

4. Enter the USERID of the user that you created earlier   

   

5. Do not click "Generate X.509 Certificate" but instead, use the certificate provided by candidate.fyi

   
    

6. Paste the certificate and click "Register"

   

7. Now click on "View" in the row at the very top

   

8. Get the API key

   

9. Now provide the API key to candidate.fyi