This document describes the various categories of the API endpoints and provides a workflow sequence for how these endpoints are typically used within the EPR Partner API. Each category is broken down into specific processes or actions.

Authentication

Authentication endpoints secure a token necessary for authorizing subsequent API calls. Refer to Authentication and Partner Configuration for proper steps for authentication to EPR.

...

{
    "project_id": "123",
    "filename": "my_document.pdf",
    "vendor_id": "456",
    "filePath": "tmp/documents/1706565016288/my_document.pdf"
}

Attachment Upload Process

Step 1: Obtain Attachment Upload URL

Endpoint: GET /partner/attachmentUploadUrl

• Description: Retrieves a pre-signed URL for uploading the attachment to the file storage.

Request Parameters:

• filename (required): The name of the attachment to be uploaded.

Example Request:

GET /partner/attachmentUploadUrl?filename=my_attachment.docx

Response:

...

Attachment Upload Process

Step 1: Obtain Attachment Upload URL

Endpoint: GET /partner/attachmentUploadUrl

• Description: Retrieves a pre-signed URL for uploading the attachment to the file storage.

Request Parameters:

• filename (required): The name of the attachment to be uploaded.

Example Request:

GET /partner/attachmentUploadUrl?filename=my_attachment.docx

Response:

{
    "success": true,
    "message": "Use the method and URL to put object to S3",
    "data": {
        "method": "PUT",
        "url": "<S3 pre-signed URL>",
        "contentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
        "filename": "my_attachment.docx",
        "filePath": "tmp/attachments/1706565016288/my_attachment.docx"
    }
}

...

1. Retrieve Configuration Data:

   • Fetch list types and corresponding list items to populate fields like contactType.

2. Document Upload:

   • Obtain a pre-signed URL for the document.

   • Upload the document to S3 using the pre-signed URL.

   • Confirm the upload using the POST /partner/uploadDocument endpoint.

3. Attachment Upload:

   • Obtain a pre-signed URL for the attachment.

   • Upload the attachment to S3 using the pre-signed URL.

   • Confirm the upload using the POST /partner/projectAttachments endpoint.

Step 6: Document Intake, Document Versioning and Assignment Management

MVP Scope:

Document intake, document versioning, and assignment management are critical processes that the end user will handle manually during the MVP phase. This approach ensures the essential functionality is validated and approved before automating these processes.

...

Document Management

Performing Intake

Step 7: Deliverables

This section explains how to handle deliverables within the EPR system during the MVP phase. Deliverables typically include documents, attachments, and comment reports. Users can retrieve these items individually or as a ZIP package.

...

{
  success: true,
  message: 1 record(s) found,
  data: 
{
    link: linkvaluehere,
    isActive: true,
    hash: e4e24204d45e24dc0ffa3dcda15d66d8c7a689237ed6088ed8834afab4e2d44bdd8982ade0f664e3f6f7d5723f08f0a1e70f79739fb67b8f0f56ad07134c50bc,
    id: 190,
    project_id: 233,
    filename: Test.zip,
    updatedAt: 2024-06-17T16:47:21.474Z,
    createdAt: 2024-06-17T16:47:16.818Z
  }
}Copy code

Step 2: Download the ZIP

...

:47:16.818Z
  }
}Copy code

Step 2: Download the ZIP

Use the provided method and URL to download the ZIP package to the S3 storage. base URL + link value from the previous call’s response body.

Conclusion

This document provides a comprehensive overview of the essential API endpoints 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.

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