Accessing EPR's API and Documentation

Owned by Stacy Reno (Unlicensed)
Last updated: Oct 28, 2021 by Colin Warren

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

For various options, please see Project Management for Standalone and Integrated Environments.

Prerequisites


In this article

Accessing EPR's API documentation page

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

Download EPR's Postman collection API

  1. EPR Getting Started Postman Collection
  2. Full Postman Collection: https://documenter.getpostman.com/view/7740484/Szf82TsY


Sample API Usage Tutorial

Obtaining a Token, the POST/Login Method

Prerequisites

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

Obtain a token as an Administrator to call Connect API methods.

  1. 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.)
  2. Do not provide a value in the email.

Example: 

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

Obtain a token for an EPR user (SSO)

  1. Provide the partner name, username and password as configured on the EPR Environment/Partners page.

  2. 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


Next Steps:

3 Easy Steps for a Light Integration to EPR