Completing the Partners page

This article provides information about the Settings/Environment/Partners page. The Partners page is used to provide API connectivity from EPR to 3rd party back office solutions.


Prerequisites:

  1. The 3rd party application has been deployed and is ready to connect to EPR.
  2. You have access to the administrative level user credentials on the Partner's system.


In this article:



Connecting EPR to a 3rd party application

  1. Login to EPR as an Administrator.
  2. Navigate to Settings/Environment/Partners.
  3. Enter the Partner Name as provided by e-PlanSoft. 
  4. Ensure Partner is Active is toggled to the on position.
  5. Under Incoming API Integration:
    1. Enter the Partner's username and password.
    2. These credentials will grant administrator-level access from the Partner's system to EPR.
    3. Confirm these credentials match those configured in the Partner's system.
  6. Under Outgoing API Integration:
    1. Enter the email address and password of an administrator-level user account on the Partner's system. These credentials grant access from EPR to the Partner's system.
    2. Enter the EndPoint/URL, (including 'https://') to the Partner's system.
      1. Do not include a trailing '/' at the end of a url. Example: https://eplansoft.com , not https://eplansoft.com/.
      2. Note that the route is not needed and should not be provided. 
    3. Under Retry Attempts, enter a number between 1 and 5. (The default retry attempts is 3.)
      1. The Retry Attempts value defines the number of times EPR will 'call out' to the Partner for a login token before giving up.
    4. Under Timeout(ms), enter a number in milliseconds. (The default is 500 ms).
      1. The Timeout value defines the number of ms to pause between attempts to contact the Partner.
  7. If the Connection Status is flagged with a red X validate steps 4 and 6 again.
  8. If the Outgoing API Integration section contains the correct information the Connection Status will display a green check.
  9. Select the Save button (required).



Connecting EPR to goPost

See the goPost article Complete the Back Office Config page.

goPost Back Office Config

EPR Environment / Partners