Integrations Overview

Intended Audience

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. 

If you are looking for a non-technical explanation of this subject, see the Catalyst article API Integration Guide.

Two Categories of Integration

Predictive Index software supports two integration options that can be used to create seamless and powerful processes across the hire-to-retire life cycle:
  1. REST API - An extremely powerful and flexible REST API interface can be used to tightly integrate your PI assessment administration within a separate application or as part of an existing process that may be included in your Applicant Tracking System (ATS), Human Capital Management (HCM), Human Resource Information System (HRIS), or other related external system. You can retrieve Assessment Results, Reports, Pattern Numbers, Personal Development Charts, Analytics, and other key results from an external system through the API.  Access to the REST API is included with the PI Enterprise Software Subscription.
  2. Open Invitation - Functionality that allows you to create standalone web pages that can be linked from any system or process and can optionally accept simple form parameters to reduce data entry for assessment takers and administrators.  Open Invitation is included with both PI Professional and Enterprise Software Subscriptions.  Learn more about Open Invitation.

Which integration option is right for me?

The key functional difference between the two options above is that the REST API allows more assessment delivery and data retrieval options, while Open Invitation is strictly for initiating assessments.  Below is a breakdown of key functionality:


Capability

REST API 

Open Invitation

Administer Assessments

X

X

Check Status of Assessment

X

Email Assessment Invitation from PI Software

X

Get link to PI Results in PI Software

X

Get Notification of Assessment Completion (to an External System)

X

Get Notification of Assessment Completion (via Email)

X

X

Get Pattern Number

X

Get PI Report

X

Modify Assessment Configuration

X

Reduce Manual Entry by Assessment Taker

X

X

Reduce Manual Entry by Survey Administrator

X

X

Secure

X

X



Step-by-step guide to getting started with your PI integration.


See typical integration use cases and best practices.


Read all about the REST API specifications.


Examine all the API methods' request parameters and response properties, and test them if you have an API Key.