Introduction
The Humanforce WFM open API enables seamless integration with third-party or bespoke systems. This could be used for items like:
- Data maintenance
- Bi-directional data imports or exports with payroll or HR systems
- Reporting and analytics
The Humanforce WFM REST API was introduced in version 4.8.2 (with limited endpoints) and is available to all Humanforce WFM Cloud customers. New endpoints have been added with subsequent versions. If you're interested in using the REST API, talk to your Account Manager about upgrading to the Humanforce WFM Cloud, which also includes the benefit of automatic upgrades.
Authentication
A valid API key and API secret is required to access the API. Learn how to generate those with How do I set up a Humanforce WFM REST API Key?
All requests to the Humanforce WFM REST API must be authenticated using Basic Authentication. Basic authentication is a simple authentication scheme built into the HTTP protocol. Every request requires an Authorization header that contains the word Basic followed by a space and a base64-encoded string apiKey:apiSecret. Because base64 is easily decoded, it is recommended that security mechanisms such as HTTPS/SSL are enabled for the host.
e.g.
| Key | Value |
|---|---|
| Authorization | Basic YXBpS2V5OmFwaVNlY3JldA== |
API Rate Limits
There are limits to the number of API calls that you can make. By default, requests are restricted to 60 calls per minute. Exceeding the rate limit will result in an HTTP 429 (Too many requests) response. You will also receive a Retry-After http header that tells you how many seconds to wait before making another request.
REST API Use Documentation
To view additional details about using the API as well as see which endpoints are available for your version of Humanforce WFM, add "/apihelp" to the end of your Humanforce WFM WFM URL e.g. https://businessname.humanforce.com/apihelp
If you are not on the latest version, you can view the latest release API documentation from this site: https://apidemo.humanforce.com/APIHELP
You may also like to use an XML version of the details of the API Endpoints that can be imported into your API client software (such as Postman) by adding "/swagger/docs/restapi" to the end of your Humanforce WFM URL e.g. https://businessname.humanforce.com/swagger/docs/restapi