What is this change about?
Who does this apply to?
What needs to be changed technically?
Required header:
Shell
--header 'X-Api-Key: {instanceId}'
Show more lines
{instanceId} is replaced with your unique instance ID in 4human HRM.How to obtain instanceId/X-Api-Key?
The easiest way is to decode JWT Token and find instanceId property within his payload. This UUID should be used as X-Api-Key. The X-Api-Key will be validated to avoid using other instanceIds.
If you have any difficulties to obtain the instanceID, please ask support.
Why this is necessary
- identify traffic per customer instance
- apply the correct traffic limits (throttling)
- ensure stable, fair, and predictable integration
X-Api-Key may be limited or rejected when throttling is active.How to handle 429 response?
To properly handle the '429 response' any API Client can use
Exponential backoff algorithm
"An algorithm that uses feedback to multiplicatively decrease the rate of some process, in order to gradually find an acceptable rate."
How Exponential backoff algorithm works:
Exponential backoff factors:
Max number of request retries: e.g. 5
Delay of first request retry, e.g. 0.5 second
Max delay of retry, e.g. 12 seconds
Jitter (add some randomness between retries), e.g. [1.1, 1.2 … ]
Starting with first delay: 0.5s
What IT or technical responsible should do
- Review all custom-developed integrations towards 4human HRM
- Verify that
X-Api-Keyis sent in the request header - Verify that the integration handles a '429 respons'
- Test the integrations after changes
Please take a look at this webinar for more information on what and how to do this adjustment.
Comments
0 comments
Please sign in to leave a comment.