Overview

To authenticate your SAP SuccessFactors account, you will need to provide the following information:

• API Server URL

• Username

• Company ID

• OAuth Credentials

This guide will walk you through finding or creating those credentials within SAP SuccessFactors and entering it into the linking flow.

Prerequisites

Please ensure you fulfill all the requirements to set up the integration:

• You are an Administrator in your company's SAP SuccessFactors instance, or someone has shared their access with you.

Instructions

Step 1: Find your API Server URL

1. Your API domain depends on your region. To locate it

   1. Navigate to the SAP SuccessFactors API Servers list

   2. Filter for your environment (typically production unless using preview/demo instances)

      

   3. Find your location and corresponding API Server URL.

      • Example: Brazil users would use https://api19.sapsf.com/

        

   4. Unofficial Workaround: Your API server URL typically mirrors your SuccessFactors login URL. For example, this is how your login and api server URLs would look like

      • Login URL: https://hcm68sales.successfactors.com

      • API Server URL: api68sales.successfactors.com

      Need Help?

      If you're unsure of your API Server URL or experiencing connection issues, contact your SAP Support team. SAP recommends this approach to ensure you receive the correct API server URL for your instance.

Step 2: Enter the URL into the linking flow

1. Copy the entire URL. In this example, it would be: apisalesdemo4.successfactors.com

2. Enter your SAP SuccessFactors API Server URL into the integration authorization component as shown below

   

Step 3: Find your SAP Username and Company ID

1. To find your SAP SuccessFactors username, go to the upper right hand side and click on your profile image to view your username.

   

2. To find your SAP SuccessFactors Company ID, in the same dropdown menu, click "Show version information." Locate Company ID in the modal that pops up:

   

3. Once you obtain your username (not email) and company ID, enter them in the linking flow as shown:

   

Step 4: Find your SAP SuccessFactors Client ID and Secret by generating a certificate

1. In your Admin Center, go to Tools, and search Manage OAuth2 Client Applications (If your page looks different, search for Manage OAuth2Client Applications in the search tool on your homepage)

   

2. Click Register Client Application

   

3. Fill out Application Name & Application URL (what actually goes in these fields is not important, except that the URL has to begin with https://)

   

4. Click Generate X.509 Certificate. Fill out Common Name (the name doesn't matter) and hit Generate

   

5. Once the certificate populates, download and save it. You will have downloaded a file called Certificate.pem

   

6. Click Register (it will have replaced the Generate button)

7. Back on your Manage OAuth2 Client Applications, go to the application you just created and click Edit

   

8. You will now see an API key listed - this is your Client ID. Copy and save this Key.

   

9. Open up the "Certificate.pem" file that you downloaded previously in a text editor. The string between ——BEGIN ENCRYPTED PRIVATE KEY——- and —-END ENCRYPTED PRIVATE KEY——- is your Client Secret. Copy the Client Secret and save

   

10. Enter your Client ID and Secret into the integration authorization component as shown below:

    

Troubleshooting tips

If the account fails to link, it could be due to one of the reasons below:

1. The URL input in Step 1 was incorrect. Make sure that the URL entered is the API Server URL not the Web URL.

2. The full URL was not pasted correctly in Step 2. Make sure the entire URL is pasted into the linking flow.

3. The API Key was not input correctly in Step 4. Make sure the Client ID field in the linking flow is the API Key.

4. The Client Secret was not input correctly in Step 4. Make sure the Client Secret input is the string between ——BEGIN ENCRYPTED PRIVATE KEY——- and —-END ENCRYPTED PRIVATE KEY——- in the X.509 Certificate.

5. If your SAP SuccessFactors instance has IP restrictions enabled, the connection may fail to link unless our IP addresses are allowlisted. To see if there are IP restrictions:

   1. Go to Admin Center → IP Restriction Management.

   2. Check whether any IP addresses are listed:

      1. If IPs are listed: Your instance is restricted to those IPs for both UI and API access. Contact your integration representative to share the list of IPs to add to your SAP IP allowlist, then try linking again.

      2. If no IPs are defined: SAP indicates the instance should allow access from any IP (as long as valid credentials are used).