How to connect to Applied Epic SDK

One of the ways in which Synatic can access data from Applied Epic is through the using Applied Epic SDK.

This will require you to install and cofigure the Applied Epic SDK.


To install the Epic SDK, there are two main steps which are the following:

  1. Install and configure IIS on your server.

  2. Run the actual Epic SDK installation.

The link below from Applied Epic has detailed instructions now how to install and configure IIS and Run the actual Epic SDK on various versions of Windows.

Applied Epic Installation

Synatic Requirements:

In order to retrieve your data, Synatic requires the following:

1. URL (Required)

The following are examples of required URLs:

Service URL:


2. DatabaseName (Required)

The name of the current database.

3. AuthenticationKey (Required)

The AuthenticationKey is required and will be validated against the Agency licence to allow the agency access to SDK.

4. Culture (Optional)

The Culture parameter is needed when the user wishes to use a language other than US english for their lookups, or their Attachments in SDK. Currently the valid values are ‘en-US’, ‘en-CA’, ‘fr-CA’ and ‘en-GB’ for use in respectively United States, English speaking Canada, French speaking Canada, and the United Kingdom.

5. IntegrationKey (Optional)

The IntegrationKey parameter is only needed when tracking the Integrations changing data is required. The value will be a guid, to which the client has associated the current integration. This will be validated against a list of valid guids. The valid guids for use by all external clients can be found in the IntegrationKey section of the MessageHeader document. This IntegrationKey will be translated by SDK and stored in the database as the human readable code associated with the key. If the IntegrationKey guid is entered, it must match one of these lists, otherwise access will be denied.

6. UserCode (Optional)

The UserCode parameter is the name of the Epic user who is using the Integration to make the SDK call. It is only necessary when it is desirable to track which user has made changes to the data. This user will be validated against valid active users in the current database. If this validation fails, access to the SDK call will be denied.


Correctly Configured SDK:

When the SDK is correctly configured, the service URL will look like the image below:

Incorrectly Configured SDK:

When the SDK is incorrectly configured, the service URL will look like the image below:

How to share credentials with Synatic:

Use the template below to share the Applied Epic SDK credentials.

Account: XXXX
Service URL :
DatabaseName : DBXXXX
AuthenticationKey : XXXX
Culture : en-US
IntegrationKey : XXXX
UserCode : XXXX