Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 7 Next »

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

  1. Login to the EPR domain as a user with administrator privileges. 

  2. Modify the URL as follows: https://[domainName].eplansoftreview.com/docs

Accessing the Connect API for partner integration via Swagger

  1. Login to the EPR domain as a user with administrator privileges. 

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

  1. Provide the partner name, username and password as configured on the EPR Environment/Partners page.
  2. Do not provide an 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'.

Example: 

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


ALERT!

Tokens automatically expire after 3 hours.





  • No labels