☰This site is intended for technical audiences who wish to carry out the work of building an integration between a software system and The Predictive Index® software. It is assumed that any developer utilizing this guide has the technical resources to build a custom integration without requiring assistance.
PI offers the ability to add custom integrations with your system which will allow access to PI Jobs, Behavioral Assessments and Cognitive Assessments through a RESTful interface. You can create and send out assessments to candidates or employees and retrieve reports and results about those assessments.
The Jobs and Assessments that are created and retrieved through the API’s will be the same data that appears within the PI Portal software.
Setting up and testing an API integration with a PI Production instance may require not only access to the API but also the ability to log into the PI instance as an admin user and configure certain settings and/or test certain outcomes. Implementing an integration with a Production account involves two preparation actions:
Admin user account creation
API Key generation
Your account must meet the minimum requirements to access PI’s APIs. Your account must either be on the Employee Plan with paid Hire module access (for Jobs, Candidates, BehavioralAssessments, and CognitiveAssessments operations) or have paid Inspire or Perform module access (for Behavioral Assessment Report or Employees operations).
To gain access to the API’s also requires your account be given access to them. If your account meets the minimum requirements, reach out to your CSM or Partner to request API access.
API access and configurations can be found within the Integration section of the Admin view within your PI portal that is accessible only by users with Org Admin access
To begin the process of integrating The Predictive Index with your custom integration, a specific user account needs to be created in The Predictive Index that will be used for integration purposes. Note: this user account must remain active in order for the integration to operate successfully. The user should be created for this specific purpose using a name and email address that will become the default contact for assessment takers who have questions about the assessment. The Org Admin user role in the PI Software has the authority to create such a new user and grant the correct permissions.
Start by creating a new user. We recommend giving this user org admin permissions to ensure there are no permission issues with the integration.
Once you have gained access to PI’s APIs, configured an Org Admin user and provisioned them an API Key you are ready to start interfacing with the APIs.
All API calls go through https://integrations.predictiveindex.com/ using the HTTP protocol
You can find a catalog of all available APIs here: https://developers.predictiveindex.com/apis
You can execute sample APIs through our developer portal by using a valid API key and payloads through the “Try It” feature found on each API URL detail page.
PI's APIs are designed to handle a high volume of requests, but it is important to monitor usage and ensure that you stay within the limits to avoid service disruptions. API requests for approved Predictive Index clients are subject to a rate specified in the X-RateLimit-Limit header, measured over a 60-second period. If you exceed this limit, the API will return an HTTP 429 response (Too Many Requests). You can track your remaining requests using the X-RateLimit-Remaining header. In case of an HTTP 429 response, the Retry-After header will indicate how many seconds to wait before retrying.
When you rely on automated integration between PI and an external system, it becomes more important to be notified about any interruptions in the PI software system/service because your users may not be seeing them occur with their own eyes. Several members of your team should subscribe to the notification service available on our Status site: https://status.predictiveindex.com
NOTE: Depending on your account size, you may be entitled to a pre-production environment. To see if you are eligible, please submit a case through our support form.