Welcome to our integration guide! We are thrilled to collaborate with you in building a seamless integration with Factorial. This document is designed to provide you with a comprehensive blueprint for creating an integration that maximizes value for our mutual users.
By following these guidelines, you'll make the development process smoother and create a more user-friendly integration. It's important to follow these steps to ensure we deliver the best possible experience for our shared clients. Let's team up to create something amazing that boosts productivity and satisfaction for everyone!
We want to provide the best experience possible to our users who are benefiting from a payroll integration with their payroll provider. To achieve this, it is important for users to understand all the integration details: what is being synced, how it is being synced, and when it is synced. They want to be in control and decide what data to sync and when.
That’s why we need external partners to build payroll integrations following these guidelines and using the employee updates endpoints that we have exposed on our public API. This approach aims to streamline the synchronization of payroll data between Factorial and the payroll software used by our partners, ensuring accurate and timely data exchange.
There are several points to consider regarding the onboarding of the user: authentication and configuration of the integration.
The recommended authentication method for payroll integrations is OAuth company token.
OAuth company token allows developer partners to get a token per company that does not expire, and currently grants all permissions at the company level. We are working on setting OAuth scopes, that will allow payroll integrations to ask for specific payroll-related permissions.
<aside> ⚠️ Integrators can create a new OAuth application in the demo environment. However, in production, an official client id and client secret will be provided by the Factorial team.
</aside>