PrismHR Integration Guide

Follow these steps to authenticate and connect your PrismHR account:

1. Enable PrismHR API and Set Up Web Service User

Before integrating, ensure API access is enabled in your PrismHR account. If not, contact PrismHR support to enable it.

Steps to Create a Web Service User:

1. Access System Parameters:

   • Navigate to: Back Office Menu > System | Change > System Parameters.

2. Open Web Service Users:

   • In the upper-right corner, click on the Actions menu.
   • Select Web Service Users. If this option isn't available, API access may not be enabled. Contact PrismHR support for assistance.

3. Create User Credentials:

   • Click on Add to create a new user.
   • Set a Username and Password for the Web Service User.

4. Configure Company Access:

   • In the Company Access dropdown, select Grant Access by Default, Deny Access to Specified to allow all clients access, excluding specific ones by entering their unique IDs.

5. Adjust Restrictions:

   • Disable IP Restrictions.
   • Disable Method Restrictions.

6. Save Changes:

   • Click Save to finalize the Web Service User setup.

2. Obtain API URL

The API URL is essential for integration. Contact your system administrator or PrismHR support to acquire the specific URL for your account. It typically follows this format:

https://[your-domain]/api

Replace [your-domain] with your actual PrismHR domain.

3. Find Your PEO ID

The PEO ID is located within the System Parameters:

• Navigate to: Back Office Menu > System | Change > System Parameters.
• Locate the PEO ID field within the parameters.

Ensure you have the Web Service User credentials, API URL, and PEO ID ready for a successful integration.