Configuring the PrismHR API for Initial Imports

This section describes the PrismHR API Initial Import process with step-by-step configuration information. Before you start, you need to create a case with PrismHR to request access for ClientSpace to the API interface.

The Initial Import process, pulls all Client and related data from the PrismHR system into a ClientSpace installation. You must test the validity of the data retrieved by the API against existing data being imported into ClientSpace. This is crucial to ensure a smooth transition to API imports. See Before Go Live.

If you try to configure this on your own and are not sure of your configuration or next steps, STOP, and log an Extranet case. When enabled, the API overwrites existing data values, potentially leading to data loss if not properly configured.

To get started, you need the following:

• HRP API URL
• HRP Callback URL
• HRP Username
• HRP Password
• HRP PEO ID

Also ensure that when setting up the PrismHR API for a Client, always request that the API account has access to the following API services:

• Login Service
• Subscription Service
• ClientMaster Service
• Employee Service

Topics in this section