From your PayFit account, you can now set up API access to seamlessly integrate PayFit with other software and tools.
Application programming interfaces (APIs) allow other software or tools to access certain data points within your PayFit account. It's sometimes referred to as an integration. An API is usually developed by an external software provider, or an internal developer within your organisation.
Your PayFit data can only be accessed with a unique code, known as an API key. As your PayFit account contains confidential information, it's important that you keep the key secure.
APIs offer a wide range of possibilities, from accessing employee names and email addresses for company training tools to retrieving payroll values directly from your accounting software.
You'll find everything you need about how to set up an API with PayFit in our PayFit API documentation. Then, when you're ready to get started, you can create your key.
Note: This feature is only available on Standard and Premium price plans. It's not available on our Light price plan. If you'd like to discuss upgrading your price plan, please get in touch.
Creating an API key
To set up an API key, you'll first need to log in to your PayFit account as an admin. Then:
From the left, choose Integration hub.
Choose the API access tab, then click Create a key.
Enter a name for the key. You might want to mention the name of the tool you'll use the key for.
Choose which fields you'll need your tool to read. You can use the checkbox against each heading to select the fields in bulk.
Click Create.
Click Copy, then store the API key securely. You won't be able to retrieve the key later.
Click I have placed my API key securely.
For further information about using the API, please refer to our PayFit API documentation.
Deleting an API key
If you need to update the permissions on an existing API key, or if you simply no longer need to use the API key, you can revoke it. To do this:
From the left, choose Integration hub.
Choose the API access tab.
Under the Your API keys, look for the relevant key, then click Details.
Under the Revoke key section, select the I understand that the revocation is final checkbox.
Click Revoke this key.
Any tools connected using this key will no longer be able to read data from your PayFit account.
FAQs
I've lost my API key. How can I find it again?
As the API key allows access to lots of confidential information, including company and employee information, the API key is only visible once on PayFit. It's important that the key is copied somewhere securely in case it's needed again. If the user who created the key forgot to copy the key, then you'll need to delete the old key, and create a new key.
Will my API key stop working if I leave the company?
It won't stop working, but you won’t be able to modify the access. If you need to choose different accesses, you’ll need to create a new key.
Can I create multiple API keys, with access to different data?
Yes! As a user, you can create an unlimited number of API keys for your company, each with different data access.
Which data fields or data points can I retrieve from PayFit?
The data points available in the API are updated regularly. To check which data points you can retrieve, please refer to our API documentation. Otherwise, please contact our integrations team.
Can I suggest more fields to be available through the API?
Yes! Please send your suggestions to our integrations team.
Can I disable API access on my PayFit account?
We can disable API access on your PayFit account for you, which means all admins on your PayFit account won't be able to access the API section. It's currently not possible to remove access for specific admins. If you'd like to disable API access on your PayFit account, please contact our integrations team.
If you can't find an answer to your question here, or in the PayFit API documentation, please contact our integrations team.