Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

In case of token-related errors (such as 401 Unauthorized or token expiry indications), immediately initiate a token refresh sequence to maintain API access continuity.

4️⃣ Constructing Single Sign-On (SSO) URLs

To direct a user to a specific project page via SSO, you must construct a URL that includes the generated user token and the project ID.

Steps to Construct the URL:

  • Authentication API /login endpoint.Include the user’s email in the payload. The user must have an active license in the EPR environment.

Code Block
languagejson
{
  "name": "your_partner_name"
  "username": "your_username",
  "password": "your_password"
  "email": "active user's email"
}
  • Generating the URL to the specific project they are launching from your platform is recommended for a seamless experience. If Project ID is not stored on your system, you will need to retrieve it via /projects?applyFilter=true&vendor_id= endpoint to locate the proper Project ID.

  • Construct the URL:

    1. URL Template:

      {baseUrl}/#!/projects/{projectId}/details/info?token={authToken}

    2. Example URL:

      http://apidemo.eplansoftreview.com/#!/projects/1/details/info?token=c5f28048d3ff6bb263c4aace5d2019c9e2b9205b5d56f772

Example End Result

The constructed URL directs the user to the project details page within the e-PlanSoft system, leveraging the SSO functionality.

Info

Please refer to Beyond the MVP documentation for additional Construction URL examples ( assignment page, document page, review page, etc).

Conclusion

This document provides a comprehensive overview of the essential API endpoints necessary for the Minimum Viable Product (MVP) integration with the EPR system. By following the outlined steps and utilizing the provided endpoints, partners can effectively manage project creation, contact and address management, document uploads, and deliverables within the EPR platform.

Next Steps: Beyond the MVP

As you become more familiar with the EPR API and its capabilities, you may find the need to extend beyond the MVP functionalities. For advanced features such as automated document intake, versioning, and assignment management, please refer to our "Beyond the MVP" documentation. This extended guide will provide deeper insights and additional tools to streamline your integration further and enhance the overall efficiency of your workflows.

For detailed guidance on advanced features, visit the "Beyond the MVP" documentation

(blue star) Need Help?

For support and inquiries, reach out to:
Channel Partner - Scott Garner sgartner@eplansoft.com
Integration Manager - Eric Niday eniday@eplansoft.com
General Support - support@eplansoft.com

...