The EPR Partner API is designed to allow third-party applications to fully integrate with e-PlanSoftReview (EPR), facilitating extensive interactions such as document management, project tracking, and review processes. This REST-based API provides a robust set of functionalities, ensuring external systems can effectively interact with EPR's core features.
The EPR Partner API is designed to allow third-party applications to fully integrate with e-PlanSoftReview (EPR), facilitating extensive interactions such as document management, project tracking, and review processes. This REST-based API provides a robust set of functionalities, ensuring external systems can effectively interact with EPR's core features.\uD83D\uDCD8 Capabilities
Upload and download documents for plan review.
Create, retrieve, update, and delete project data.
Manage assignments and collect feedback through comments and markups.
Versioning of documents to track changes and updates during the review cycle.
This is Minimum Viable Product overview. Review the Related articles for more advanced API integration Capabilities.
High-Level Workflow
The interaction with the EPR system through the API typically follows this process:
Project Creation: Initiating a new plan review project.
Document Management: Uploading and managing documents related to the project.
Review Assignments: Assigning documents for review and tracking the review progress.
Completion and Closure: Finalizing reviews and closing the project after achieving an end result.
Retrieval of Deliverables: Accessing completed plan review files through the deliverables method.
Comment Reporting: Retrieval of comments as well as creating and managing comment reports that compile key project information, agency instructions and configured requirements of the report for the project.
🌐 Base URL and Media Types
The API is accessed via the base path: /partner, /resources
Consumes: application/json, multipart/form-data, application/x-www-form-urlencoded
Produces: application/json, application/octet-stream, application/pdf, image/jpeg, image/png
▶️ Getting Started
Initial Setup and Access
To start using the EPR Partner API effectively, follow these steps to ensure proper setup and access:
Access to an EPR Environment
Ensure you have access to an EPR environment. This is the foundational step where all your API activities will be hosted and managed.
Configuration of the Partner Page
Once access is granted, configure the Partner Page in your EPR environment. This configuration is crucial for setting up how the API will interact with your specific data and processes.
Following the Authorization Guide
Refer to the Authorization Guide provided in the API documentation. This guide will walk you through obtaining and managing the necessary API tokens needed for authenticated interactions with the API.
Note for New Users
If you do not have access to an EPR environment or are unsure about how to proceed with the configuration, please contact the Channel Partner or the Integration Manager. They will provide you with the necessary support and guidance to get started.
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