Prerequisites
Before you can authenticate to using OAuth, you must first obtain API access. To request access, contact service@paylocity.com or sales@paylocity.com. Once your request is reviewed and approved, provides OAuth credentials and grants you access either to a Sandbox or Production account. This access is required in order to authenticate your API requests. Paylocity issues the following OAuth credentials:- client_id—The identifier (Id) that is assigned to your registered OAuth application in the Developer Portal. Use this value to set the OAuth client Id.
- secret—The secret that is assigned to your registered OAuth application. Use this value to set the OAuth client secret. requires secrets to be rotated every 365 days. You will receive reminder emails ten days and five days prior to expiration.
Add the Paylocity Connector
Authenticate to Paylocity
After you add the connector, you need to set the required properties.- OAuth Client Id: Enter the client Id that you were assigned when you registered your application with an OAuth authorization server.
- OAuth Client Secret: Enter the client secret that you were assigned when you registered your application with an OAuth authorization server.
Complete Your Connection
To complete your connection:-
Specify the following properties:
- (Optional) Company Id: Enter your company identifier.
- (Optional) RSA Public Key: Enter the RSA key that is associated with your account.
- (Optional) Key: Enter the Base64-encoded AES symmetric key that is encrypted with the public key.
- IV: Enter the Base64-encoded AES initialization vector (IV) that is used when content is encrypted.
- Use Sandbox: Select whether you want to enable the sandbox. By default, the Enable checkbox is not selected.
- Use Pay Entry API: Select whether you want to use the Pay Entry API, which enables you to submit payroll information automatically for individual employees. By default, the Enable checkbox is not selected. If you do not enable this property, uses the standard API.
- Define advanced connection settings on the Advanced tab. (In most cases, though, you should not need these settings.)
- Click Create & Test to create your connection.