Versions Compared

Key

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

Step-by-step guide

...

...

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. Obtain the 3rd party applications' URL/Endpoint and login credentials.


In this article:

...

Table of Contents


Connecting EPR to a 3rd party application

  1. Login to EPR as an Administrator.
  2. Navigate to Settings/Environment/Partners page.
  3. Enter the Partner name as provided by e-PlanSoft. 
  4. 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.
  5. Under Outgoing API Integration:
    1. Enter the email address 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 password for the administrator account.
    3. Enter the EndPoint, (including 'https://') to the Partner's system. 
    4. 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.
    5. 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.
  6. Toggling Partner is Active to the On position to test the connection status.
  7. If the Outgoing API Integration section contains the correct information the Connection Status will display a green check.
  8. Select the Save button.
  9. If the Connection Status is flagged with a red X, validate steps 5 and 6.


...

Connecting EPR to goPost

See the goPost article Complete the Back Office Config page.

partners.pngImage Added





Page Properties
hiddentrue


Related issues