SAP SuccessFactors Steps

This guide will walk you through the steps to Retrieve Integration Details from SAP SuccessFactors. Once done, you will be able to quickly integrate the SAP SuccessFactors with Testlify.

Prerequisites

Please carefully read the following to make sure you are able to complete the setup:

• You are an Admin of your SAP SuccessFactors instance. If you are not an admin, you won't even be able to search for and access the configuration pages that are described later on.
• Alternatively: Please contact your SuccessFactors Admin and have them take over the integration setup process.
• The OData v2 API is available and enabled on your SuccessFactors instance (it is by default, so this is usually not something to worry about).

Step 1: 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)

4. Please note that this is a workaround as there is no direct way to get the API domain via the SuccessFactors UI on your own. SAP shares in their help center that you should reach out to your SAP consultant to get the proper API domain. Your API endpoint will depend on where your SAP SuccessFactors instance is located. It can be in one of several data centers. Please contact your SAP SuccessFactors representative if you are unsure of which data center to use. You'll find the endpoints in the Related Information section.

Step 2: 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 Permissions Group

1. Go to your search bar and enter "Manage Permission Groups"

   

2. On to 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

Create Permission Role

1. Go to the search bar and enter "Manage Permission Roles"

   

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

   

3. Enter a name on permission role.

   

4. Click on Next Button and give the required Permission.

   

   and also give all these Permissions.

   

5. Click on save and add the permission groups to it and grant access.

   

6. Click on save.

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 ) for the application, then click the "Bind to Users" checkbox and click "OK"

   

4. Enter the USERID of the admin user.

   

5. Do not click "Generate X.509 Certificate" but instead, "Copy" the certificate from the connection flow on Testlify.

6. Paste the certificate from Testlify Integration Page and click "Register"

   

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

   

8. Get the API key

   

9. Now paste the API key and the name of the API user into the connection flow.