Exact Synergy Enterprise Integration

Portway provides selective integration with Exact Synergy Enterprise through proxy endpoints, enabling controlled access to specific Synergy data and services. While Synergy Enterprise has a native REST API, Portway is particularly useful when you need to expose only specific database sections or when Synergy is deployed behind a firewall within your internal network.

Overview ​

Portway proxies requests to the internal Synergy REST API, useful when Synergy is behind a firewall or you need to expose only a subset of its API surface through a controlled gateway.

Configuration Requirements ​

Environment Headers ​

Synergy Enterprise uses standard HTTP authentication and doesn't require special environment headers like Globe+. Authentication is typically handled through Windows Authentication, since all environments are domain-integrated. You should have this set-up as mentioned in the installation instructions of Exact Synergy Enterprise.

Environment Settings ​

Each environment must be properly configured in the settings:

// environments/Synergy/settings.json
{
  "ServerName": "YOUR-SERVER",
  "ConnectionString": "Server=YOUR-SERVER;Database=Synergy;Trusted_Connection=True;",
  "Headers": {
    "Origin": "Portway"
  }
}

Available Synergy Endpoints ​

Proxy Endpoints ​

You can selectively configure which Synergy endpoints to expose through proxy endpoints:

Accounts (Selective Exposure) ​

{
  "Url": "http://YOUR-SERVER/Synergy/services/Exact.Entity.REST.svc/Account",
  "Methods": ["GET"],
  "IsPrivate": false,
  "AllowedEnvironments": ["Synergy"]
}

Composite Endpoints ​

These endpoints handle complex operations that require multiple related Synergy API calls:

Project Creation with Resources ​

POST /api/Synergy/composite/ProjectSetup
Content-Type: application/json

{
  "Project": {
    "Code": "PRJ-2025-001",
    "Description": "Website Development Project",
    "StartDate": "2025-08-18T00:00:00",
    "Type": 2
  },
  "ProjectWBS": [
    {
      "Code": "DEV001",
      "Description": "Development Phase",
      "Project": "PRJ-2025-001"
    },
    {
      "Code": "TEST001",
      "Description": "Testing Phase", 
      "Project": "PRJ-2025-001"
    }
  ]
}

This composite endpoint:

1. Creates a project in Synergy using the Project entity
2. Creates associated project WBS elements
3. Links WBS elements to the project with proper hierarchy

Binary Data Upload ​

POST /api/Synergy/composite/BinaryUpload
Content-Type: application/json

{
  "Binary": {
    "Data": "UERGLTEuNCBmaWxlIGNvbnRlbnQ=",
    "Encoded": true,
    "DataString": "Sample PDF document"
  },
  "Document": {
    "Subject": "Project Documentation",
    "Type": 1,
    "Category": "Technical"
  }
}

This composite endpoint:

1. Creates binary data entry in Synergy
2. Creates associated document record
3. Returns the MessageID for future reference

Error Handling ​

Synergy specific error responses are preserved and forwarded:

// Synergy validation error
{
  "error": {
    "code": "ValidationError",
    "message": "Account {UUID} does not exist",
    "details": {
      "entity": "Accounts",
      "field": "ID",
      "value": "c91ca921-86e7-47d1-b52a-d3e41ab295a6"
    }
  }
}

URL Rewriting ​

Portway automatically rewrites Synergy URLs in responses to maintain proxy routing:

• Original: http://YOUR-SERVER/Synergy/services/Exact.Entity.REST.svc/Account(guid'12345')
• Rewritten: https://api.company.com/api/Synergy/Account(guid'12345')

This ensures that related links in responses continue to work through the proxy.

Troubleshooting ​