The following are prerequisites for deploying and using accoPLANNING API in a self-hosted environment.

This guide assumes a moderate knowledge and understanding of server management and commandline.

Tools used:

Powershell
- This guide expects the user to use Powershell terminal. Syntax for other terminals may look different.
OpenSSL
- This tool is used for generating certificate and keys if not supplied beforehand.
- Download Installer & execute file "Win64OpenSSL-3_4_0.msi" to install OpenSSL

Machine environment

Physical requirements for the server (can be a VM) hosting the API:

Recommended:
- 2 core, 4 GB ram, 100 Mbps
- Suggested Azure VM Size: B2als
High load:
- 4+ core, 8+ GB ram, 1+ Gbps
- Suggested Azure VM Size: B4als

Firewall

If using database external to the hosting server, these are the ports which need permission through firewall:

443 (inbound/outbound), TLS / Alternatively any custom port chosen
1433 (outbound), MSSQL TCP

Network (TLS/cert)

Certificate with a server matching Domain/IP is required for secured communication over TLS.

For guidance on creating and installing a supported TLS certificate, please see section "New Certificate" in this document.

When using Self-signed certs the user needs to import Certificate into their "Trusted Root Certificate Authorities" store on the device.
This is done by opening "Manage user certificates" and navigating to the "Trusted Root Certificate Authorities", right-clicking the Certificates folder within, then All Tasks -> Import, after which you follow the instructions in the new window.

Data Encryption

Encryption keys for data encryption both at rest and transport.

For guidance on creating and installing encryption keys, please see section "Data Encryption" in this document.

Distribution Package

Distributed package contains the following files:

(root)
- accoplanning_api.exe
- accoplanning_api_service.exe
- accoplanning_api_service.xml

Installation of accoTOOL Self-Hosted API