Eclipse Contact Sync Integration Overview

About the Integration: 

Target System: Epicor Eclipse  - On-Prem, API enabled

Directionality: Eclipse <-> Prokeep 

Functionality: Sync Contact and Company Information between the systems
System Requirements: API Access, External Access to Eclipse Port 

Overview: 

• The Eclipse to Prokeep Integration is not instantaneous, as it runs on a 15-timer. Every 15 min, the integration will scan for new contact information and port that information over to Prokeep. 
• The Prokeep to Eclipse integration is instantaneous. As soon as a contact is created or updated in Prokeep, that information will be ported down to Eclipse. 
• Requires configuring and testing with the Prokeep team. We will work with customer IT to set up and test. 
• There is room for configurability on the directionality, and the wish to sync Companies or Contacts or Both. Talk to your Prokeep rep during setup for more information. 

Integration Key

What information is passed along in the integration and where does it end up? 

Contact Fields

The following is the field key for contacts

*Company relationships will be determined by EntityID.

**will be set during the onboarding of the integration (applies to all contacts synced)

Company Fields

The following is the field key for Companies (Customers in Eclipse) 

Setting up the integration:

Most of the setup for this integration will be done on the Prokeep side, but there are some critical pieces of information that we will need from the customer in order to set up the integration properly. 

The general setup process is: 

1. The customer provides Prokeep with their Eclipse API credentials and other information 
2. Prokeep sets up and turns on the integration 
3. Verify integration works 

Getting the proper credentials for the Eclipse API is the most critical step in setting up the integration, and is something that we rely on Eclipse Admins for.  There are some other key pieces of information we need from customers, but credential issues are the number one reason why integrations get delayed. 

The following is a list of the information we need from the customer: 

1. Bi-directional or Uni-directional - We need to know if the integration should be set up to sync contacts back and forth between Prokeep and Eclipse or only from Eclipse into Prokeep. 
2. API endpoint URL - this should include the port we can call, and should look something like https://portal.fakecompany.com:5000  (port with access to middleware is probably your best bet). Please ensure the endpoint is either publicly accessible or whitelist our IP address of 52.32.60.21. 
3. A Password and Username for Eclipse - we will need this to generate an API token. This user needs read and write permissions to Contacts and Customers. It will also need API access. 
4. Ship To Default - We need to tell Eclipse if this is a “Ship to” customer. Just let us know if we should default to Yes or No for this.  (only applicable to sync from Prokeep to Eclipse)
5. Bill To - - We need to tell Eclipse if this is a “Bill to” customer. Just let us know if we should default to Yes or No for this.  (only applicable to sync from Prokeep to Eclipse)
6. Default City -We need to have a default city for all customers created. Let us know what state we should use.  (only applicable to sync from Prokeep to Eclipse)
7. Default State - We need to have a default state for all customers created. Let us know what state we should use. (GA, NY, etc)  (only applicable to sync from Prokeep to Eclipse)
8. Postal Code - We need to have a default postal code for all customers created. Let us know what postal code we should use.  (only applicable to sync from Prokeep to Eclipse)