Getting started
      Back to home
      1. Support Centre
      2. Postworks Software Downloads
      3. Getting started

      An introduction to PostboxServer™

      PostboxServer™ is for IT Administrators utilising server document systems.

       

      PostboxServer™ Download

      Introduction

      PostboxServer™ is the newest member of the Postworks software suite. Built on .NET Core, the application operates across Windows, OSX and Linux and utilises the latest iteration of our REST API. It is well suited for both on-site and hosted server configurations. 

      How it works

      PostboxServer™ creates a service (e.g. Windows Service) to monitor predefined folders for new files. Clients direct their document output systems to save to these folders where they are picked up and securely transferred to our server.

      Security

      PostboxServer™ uses the same API as the Postworks API, our public API which offers end-to-end encryption and authentication using JWT.

      How to configure

      PostboxServer™ runs as a windows service and installs itself to “C:\Program Files\PostboxServer\”. All configuration is done through a single file that has the following format:

      {

        "PostworksAPISettings": {

          "ApiAddress": "https://api.postworks.co.uk/",

          "ApiKey": "API-KEY-HERE"

        },

        "MonitorSettings": {

          "Folders": [

            {

              "FolderFullPath": "C:\\temp\\1",

              "PostboxId": "POSTBOX-ID-HERE"

            },

            {

              "FolderFullPath": "C:\\temp\\2",

              "PostboxId": "POSTBOX-ID-HERE"

            },

          ]

        }

      }

      The PostworksAPISettings section holds the API address and your API Key.

      MonitorSettings contains all folders that are monitored by the Service, which can range from 1 to the maximum number of handles per process for your OS. Each folder configuration has 2 properties:

      • FolderFullPath - The full path to the folder
      • PostboxId - The ID of the Postbox that will be used for uploading documents. These will need to be created first.
        • To get the PostboxID, go to PostworksHUB, click the image-png-4  of the Postbox and in Advanced Settings click the “Copy to clipboard” button.

      Please note that the PostboxID needs to be from a Postbox that belongs to the user which the API key is attached to.

      How to access

      As PostboxServer™ requires an API Key, please contact us for support on getting up and running.