This article provides instructions for utilizing e-PlanREVIEW® (EPR)'s RESTful API to integrate external applications to EPR.

Prerequisites

In this article

Accessing EPR's API documentation page

Login to EPR and checkout the image below to see how to get to the API documentation

Download EPR's Postman collection API

Prerequisites

See Completing the Partners page for managing the incoming API credentials.

Provide the partner name, username and password as configured on the EPR Environment/Partners page.
1. 'Name' = the company name of the integrated application (Accela, CSDC, MaintStar, BSA, MitchellHumphrey, etc.)
Do not provide a value in the email.

Example:

{
  "name": "Accela",
  "username": "administrator",
  "password": "*************"
}

Provide the partner name, username and password as configured on the EPR Environment/Partners page.
Provide the user's email address to obtain a token for the user. The user's account must be 'active'.
1. Use this option to login an EPR user using single-sign-on. The user's permissions are then obtained, based on their 'user role'.
2. The user can then be 'navigated' to the Assignments page, the Review Page, the Project Intake or Project Deliverables page, etc simply passing the token via url. For example to go to projects page https://epr-dev.eplansoftreview.com/#!/projects?token=8305da9b9c7b4b6a333e9123353a038ec5c7e4ad347e9e36.

Example:

{
  "name": "Accela",
  "username": "administrator",
  "password": "*************",
  "email": "john.doe@domain.com"
}

ALERT!

Tokens expire after 3 hours of inactivity