Synergize Integration API

Explorer has an integration scheme that works from either a Windows desktop or a web browser (or control). It provides secure, reliable access to data in a Synergize repository. This guide is intended to help developers of third-party systems (like transportation management systems) write the code that is needed to ensure the security and reliability of the integration.

There are two types of integration: Desktop-based and Web-based. First, to understand how Synergize Integration Configurations are created, see Configure a Synergize Explorer Integration

The information in a Synergize repository is protected so that only trusted agents can request data and the actual signed-in users are identified so they see only the documents that they are allowed to see. To accomplish this, there are three configurable elements to integration:

  • Server identity (where the Explorer application is set up and identified with a base URL)

  • Customer ID (which company is making the request)

  • Encryption key (the private key that is paired with the customer ID to determine whether the request is coming from a trusted source)

A URL for Synergize Explorer integration is created using a single API call. Behind the scenes, the following occurs:

  • Starting with the base URL

  • Encrypting and appending the query portion of the URL

  • Digitally signing the URL

  • Returning the fully-encrypted and signed URL

For security reasons, the URL can be used only once, to execute the initial search through the Synergize repository. A second attempt to use the URL (for example, by a copied and pasted URL or refreshing the browser) will not be allowed. However, you can refresh the data in an existing window, by coding a conditional check to see if the window still exists and sending it a command.

As a prerequisite, you must use .NET Full, until we support .NET Core alone.

There are two integration types; one builds on the other. Once you have configured the web-to-web configuration, you can build on that to accomplish the Windows desktop to web integration.

1. Basic JavaScript integration (all implementations): Web to Web

2. Windows integration (extra steps): Windows Desktop to Web