This article provides instructions for utilizing EPR's Connect API to integrate external applications to eplansoft REVIEW.
For additional information, we recommend Project Management for Standalone and Integrated Environments.
Prerequisites
- A user account with administrator privileges for an EPR website.
- Login to the EPR domain as a user with administrator privileges.
- See Completing the Partners page for managing the incoming API credentials.
Opening the EPR Schema
- Login to the EPR domain as a user with administrator privileges.
Modify the URL as follows: https://[domainName].eplansoftreview.com/docs
Accessing the Connect API for partner integration via Swagger
- Login to the EPR domain as a user with administrator privileges.
Modify the URL as follows: https://[domainName].eplansoftreview.com/api/partner
The Partner API page will load, as shown below:
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.
- Provide the partner name, username and password as configured on the EPR Environment/Partners page.
- Do not provide an email.
Example:
{
"name": "Accela",
"username": "administrator",
"password": "*************"
}Obtain a token for an EPR user (SSO).
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'.
- Use this option to login an EPR user using single-sign-on.
- Typically, the user's is then 'directed' to an EPR URL, for example, to the Assignments page, the Review Page, the Project Intake or Project Deliverables page, etc.
Example:
{
"name": "Accela",
"username": "administrator",
"password": "*************",
"email": "john.doe@domain.com"
}ALERT!
Tokens automatically expire after 3 hours.
Related articles