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
4.8 HTTP Activation
ASP
ISAPI Extensions
ISAPI Filters
Server Side includes
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.
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 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 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
Synergy IP's
The port will also need to be opened on the server’s Windows Firewall Rules.
IP Whitelist Reference
Synergy IP's
| 216.52.172.204 66.150.142.84 |
UNILINK IP's
74.209.240.84
Tray.IO IP's
Tray.IO IP's
52.40.200.248
52.39.10.61
52.26.59.155
Web API Methods
CustomerService
GetCustomerList
This API curl statement should look similar to the following:
curl -X 'POST' \
-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:
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
RESTful Web API (DERP) - Release Notes
1100.1004 - Beta Version Identified an issue where sell rate and buy rate were both defaulting to 1 in the DERP integration. This caused currency exchange calculations to be skipped, as no actual rate conversion occurred. In SBO, exchange rates were ...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, ...Tax - Maximum Message Size Quota Has Been Exceeded
You may receive the following message after running the Tax macro on an order with a lot of lines: "'The maximum message size quota for incoming messages (65536) has been exceeded. To increase the quota, use the MaxReceivedMessageSize property on the ...Bom Xploder Network Requirements
WM-Synergy Business Objects SDK Information
WM-Synergy Business Objects WM-Synergy Business Objects, SBO, is a comprehensive transaction library built on the both the .net standard and .net framework platforms. This library allows the developer to quickly read/write/update transactional data ...