|
|
|
|
|
Configuration Requirements
Your domain name will need to be configured to point at your Accredo server and the SSL certificate will need to be bound to the ports configured for the service. For ease of configuration, we recommend IIS (Microsoft Internet Information Services) be used to install the certificate and bind it to the Web Service ports.
Depending on whether you will be configuring mixed internal and external, or internal only access to the Web Service, you will need to configure the appropriate internal and/or external DNS entries so that the service is reachable with your domain.
For external use you will also need to ensure that web traffic is allowed though your network boundary in a secure manner. In this instance we strongly recommend the use of a reverse proxy server or other secure transport methods to help prevent unauthorised access to your server. Both Nginx as an appliance or server, or IIS as a server are suitable for use as a reverse proxy. When using a reverse proxy, you will need to ensure the X-Forwarded-Host header is being set and forwarding the external host to the web service, in IIS this is a Server Variable that is added to the inbound rewrite rule. Otherwise you need to configure the Web Service to rewrite this, see the Service Configuration Section of the Web Service Installation and Initial Configuration.
Accredo Business Software Ltd makes no recommendations on specific network configuration and you should consult with an experienced and qualified IT professional.
In this guide, demo.accredo.co.nz is used to represent the domain you will have set up for use with the Web Service.
Web Service Installation
See the installation guide for steps to install the service and perform the initial configuration.
Note: The server installation of the Accredo has OAuth2 enabled, while the demo system does not.
Note: If you intend to access the Accredo COM object via scripting triggered from the Web Service, you will need to change the AccredoSaturnWeb or AccredoMercuryWeb Windows Service to run as a Domain user with appropriate permission. However this has security implications and you should consult your IT provider / specialist before doing this.
Windows Regional Settings
Ensure that date settings for the Windows system accounts are set to dd/MM/yyyy. You can do this by correctly setting the date format for the current user and then copying it to the system accounts:
Windows Control Panel > Region > Administrative Tab > Copy Settings > Check both check boxes > OK
Testing the Web Service
To access your own server, use the following links. Replace demo.acredo.co.nz with your domain, and DEMO with the Company Code of the Accredo company you are connecting to.
For Saturn: https://demo.accredo.co.nz:6569/saturn/odata4/v1/company('demo')/developerdoc
For Mercury: https://demo.accredo.co.nz:6569/mercury/odata4/v1/company('demo')/developerdoc
This should display an error message of "invalid access token". This means you are successfully able to communicate with the Web Service. The OAuth2 token end point will be located at:
For Saturn: https://demo.accredo.co.nz:6569/saturn/oauth2/v1/token
For Mercury: https://demo.accredo.co.nz:6569/mercury/oauth2/v1/token