You are using an unsupported browser. Please update your browser to the latest version on or before July 31, 2020.
close
Home > Premier Integrations > PrismHR Premier Integration > Configuring an Web Service/API User in PrismHR
Configuring an Web Service/API User in PrismHR
print icon

To configure a PrismHR Web Service/API User for detamoov, follow the steps below. 

 

  1. Gather the required information needed in Prism
  2. Create the Web Service User in Prism
  3. Create an integration service in detamoov

 

Gather the required information needed in Prism 

API URL

https://api.prismhr.com/prismhr-api/

 

Above is the standard PrismHR API url to enter in detamoov unless you are self-hosted. Self-hosted PEOs should contact detamoov for support in identifying your Prism API URL.

 

PEO ID

To find your PEO ID, log into PrismHR. The PrismHR PEO ID is found in the System Parameters through the click-path: Back Office Menu ⇒ System | Change ⇒ System Parameters.

 

Halfway down on the right column you'll find the PEO ID value for your PrimsHR instance.

 

Create the Web Service User in Prism

To create a web service user for detamoov, follow this click path within PrismHR:

 

  1. From the Back Office menu in PrismHR, go to System | Change ⇒ System Parameters.
  2. In the Actions menu in the upper-right corner, select Web Service Users. If Web Service Users is not listed, then you likely don't have API access enabled for your account. Contact detamoov for support.

 

When creating the web service user, we recommend the following:

  1. UserID and Username: detamoov (this is case sensitive)
  2. Password: set a secure password with at least one uppercase character, one lowercase character, one special character, one digit and a minimum of 10 characters.
  3. Account disabled: leave unchecked
  4. Company Access: select 'Grant Access by Default, Deny Access to Specified' and leave the Company Access grid empty
  5. IP Restrictions - you have two options:
    • Option 1
      • Disable IP Restrictions: check this checkbox
      • Allowed IPs: leave the grid empty
    • Option 2
      • Disable IP Restrictions: leave this checkbox unchecked
      • Allowed IPs: add 3.12.247.53 to the grid
  6. Disable Method Restrictions: check this checkbox
  7. Allows Methods: add the following methods:
    • For GL Integrations
      • GeneralLedgerService.getClientGLData
      • GeneralLedgerService.getGLDetailDownload
      • PayrollService.getBatchListByDate
      • PayrollService.getBatchInfo
    • For 180 Retirement Integrations
      • PayrollService.getBatchListByDate
      • PayrollService.getBatchInfo
      • EmployeeService.getEmployee#NOMASKSSN|NOMASKDOB
      • PayrollService.getEmployee401kContributionsByDate#NOMASKSSN|NOMASKDOB
      • BenefitService.retirementCensusExport#NOMASKSSN|NOMASKDOB
      • ClientMasterService.getClientMaster#NOMASKDOC
  8. Minimum API Version: select All
  9. Contact Information: leave blank

 

Once you have all the information above, you'll next want to enter the values into detamoov.

 

Create an integration service in detamoov

In detamoov, click on the Tools left hand menu and access the Integration Services tab. Click the Add button to create your PrismHR API integration for detamoov to utilize.

 

 

Select the PrismHR API option from the Premier Service dropdown. From there, enter the values you've collected from above within PrismHR and click the Save Changes button.

scroll to top icon