Visual Connect RESTful Web API (DERP) - Technical Requirements

Visual Connect RESTful Web API (DERP) - Technical Requirements

VISUAL ERP integration with DERP

Compatability
Visual 9.x.x - Visual 11

Server Requirements 
Windows Server 2019
4 cores
8gb of ram
Recommend 4gb of free disk space (install files + logs)

Prerequisites
.Net Framework 4.8 
Installation of Default IIS Components 
4.8 HTTP Activation
ASP
ISAPI Extensions
ISAPI Filters
Server Side includes

Summary

WM-Synergy Resources requires a dedicated Web Services application installed on Internet Information Services (IIS) of an application server (not the VISUAL Database Server). 
The new server will need to be accessible from the internet, but only from a select set of IP addresses this will vary by project. 
We typically recommend to customers that this new Web Services API Server be placed in the DMZ of your network, but it must also have local network access to the VISUAL database server.



Once the server is provisioned, the WM-Synergy Resources Systems Architect will require Remote Desktop Access (either 
direct, via a VPN connection, or other customer provided remote session). The Systems Architect will install WM-Synergy’s 
Distributed ERP, configure the new web application, and test connections locally. Once SSL certificates are available 
and firewall rules are created, the Systems Architect will also test access from the integration platform. 

The solution also requires an A Record created in your DNS so an SSL certificate can be applied to IIS on this new 
server. This Host record can be something like visualapi  Public IP address. The certificate request can be made 
through IIS once the server is provisioned unless an SSL certificate is already available.
The new or existing SSL certificate (or a wildcard certificate) for the host’s name will allow the integration platform 
to communicate with the Web Services API via the secure URL. The Web Services API link would be similar to:
For firewall rules, direct https traffic on Port 443 to Port 443 on that server. You can choose to use another port if desired. 
The port will also need to be opened on the server’s Windows Firewall Rules.

IP Whitelist Reference

WM-Synergy IPs
216.52.172.204
66.150.142.84

UniLink IPs
74.209.240.84

Tray.IO IPs
52.40.200.248
52.39.10.61
52.26.59.155
52.8.7.130
18.144.153.142

Web API Methods

CustomerService

GetCustomerList

This API curl statement should look similar to the following:
curl -X 'POST' \
  'https://localhost:44300/CustomerService.svc/GetCustomerList' \
  -H 'accept: application/json' \
  -H 'ApiKey: 1E-CA-0C-79-65-BE-C4-66-9D-E9-6D-30-54-1D-49-8F' \
  -H 'Content-Type: application/json' \
  -d '{
  "SiteId": "101AMC",
  "ListOnly": "",
  "Start": 0,
  "Count": 0,
  "ReverseSort": "",
  "CustomerId": "",
  "Modified": "",
  "StartDate": "",
  "EndDate": "",
  "ActiveFlag": "Y",
  "Territory": "",
  "MarketId": ""
}'

In order to return any information any one or more of the following must have a value:
StartDate, Enddate, ActiveFlag*, Territory, MarketId, CustomerId, and or Modified date

*ActiveFlag is a 'Y' or 'N' field.

Swagger

The DERP web site supports SWAGGER, if you wish to see what is expected of the web methods, you can use Swagger to determine your curl interface:
sample site:  https://localhost/swagger/index.html  or http://localhost/swagger/index.html

The key used by swagger may be the name or the physical key, or the name, depending on your configuration setup as found in SRIMacroServer Configuration.config:


Or



    • Related Articles

    • Visual Connect RESTful Web API (DERP) - Release Notes

      1100.1007 - (4/9/2026) Added support for Oracle 9.0.8 Fixed Backflush to ensure Backflush location is valid for current site_id 1100.1006 - (3/24/2026) Add the following features SalesOrderService When creating a customer order line, the code should ...

    • SmartViews - Network Requirements

      In addition to connecting to other databases to view their data, SmartViews also needs to be able to connect to a designated SmartViews database in order to run. This SmartViews database stores the data in SmartViews, such as user accounts, Views, ...

    • Credit Card Bridge API - SDK

      1. Overview CC.Bridge.Server is an ASP.NET ASMX Web Service that provides a SOAP-based bridge between client applications and the Synergy credit card processing back-end. It exposes database-authenticated methods for retrieving transaction history, ...

    • LMS Plugin Settings - Change Visual Connection

      Synergy LMS Plugin – Change Visual Database Follow these steps to change your connection to another Visual database. Run the LMS Management Console (shortcut can be found on the desktop of the server where LMS is installed Log in: (sysMgr is the ...

    • Use Single Sign On in Visual

      If you get the above error when trying to log into Visual, create a shortcut pointing to VM.exe (or copy an existing shortcut to it). Right-click the shortcut and go to Properties, and at the end of the Target field, add a space and "-SYSADM" (no ...