SAP Knowledge Base Article - Public

3159263 - Rate Limiting on SAP SuccessFactors APIs - FAQ on API Throttling

Symptom

With the 2H 2022 Release of the SAP SuccessFactors application, we announced the introduction of rate limiting on SAP SuccessFactors APIs in the SAP SuccessFactors HXM Suite. However, thanks to our customers' valuable input and as part of our constant efforts to minimize any potential disruption to our customers, we have decided to postpone the introduction of rate limiting indefinitely.

Environment

SAP SuccessFactors OData API
SAP SuccessFactors SFAPI

Resolution

1.    Is any action required by customers due to the announcement (postponement of rate limiting)?
1.    No action is required at this point.
2.    As a general best practice, we would always advise customers to work with your API implementation team to reduce the number of API calls made per second. When in doubt, please reach out to SAP SuccessFactors Product Support at LOD-SF-INT-ODATA or LOD-SF-INT-API

2.    Does this change impact LMS APIs?
1.    SAP SuccessFactors Learning OData APIs were already operating under API rate limits prior to this announcement and are not impacted. This announcement is specific to introducing rate limits to the rest of SAP SuccessFactors APIs. Please refer to the SAP SuccessFactors Learning OData APIs guide for more details

3.     What should I do if I have received a 429 – Too Many Requests error?
1.     Set your request to retry based on the recommended value, which currently is 300 seconds or 5 minutes (please note, this may change based on server capacity)
2.     If you are using Boomi or CPI to make the API call, no action will be needed, as both support http 429 and retry-after already.

4.      How could I check the API Usage in my SuccessFactors instance?
1.      You can refer to the API Insights section of SAP For Me, see example below:

NOTE: We always encourage our customers to review their usage of SAP SuccessFactors APIs and look for any optimization potential.

See Also

LMS OData APIs Throttling Limits

Guides:
OData v2 Developer Guide

OData v2 Reference Guide

LMS Guide
 

In the Communities:

Partner Delivery Community blog

Customer Community blog

Best Practices:
SFAPI Best Practices (chapter 9)
OData Best Practices (chapter 11)

 

Keywords

rate limit exceeded, the maximum allowed rate is, requests per minute, requests per second, throttling, API throttling, 40, 429, rate limiting, API-21198, INT-13843, SFS-209, SAP for Me, API Insights, usage , KBA , LOD-SF-INT , Integrations , LOD-SF-INT-ODATA , OData API Framework , LOD-SF-INT-API , API & Adhoc API Framework , LOD-SF-INT-CPI , Standard SF to 3rd Party CPI (HCI) Content , LOD-SF-INT-BPI , Dell & Boomi Infrastructure , LOD-SF-INT-CE , Compound Employee API , LOD-SF-INT-CPI-TPI , Standard SF to 3rd Party Integration using CPI , How To

Product

SAP SuccessFactors HCM suite all versions

Attachments

IDP SuccessFactors Integrations - Best Practices using SAP SuccessFactors APIs for Custom Integrations V1.22 (1).pdf
SAP SuccessFactors Employee Data - Integration Best Practices and Considerations.pdf
SAP SuccessFactors Employee Data - Integration Best Practices and Considerations.pdf