e-Boks prerequisites

Before you can start using the SmartPost process, you need to complete some configuration tasks for SmartPost to be able to communicate with e-Boks.

  1. e-Boks opens for the organization's IP addresses
  2. Agreement on provision of NemID services (tilslutningsaftale)
  3. Retrieval system
  4. Configure e-Boks


e-Boks opens for the organization's IP addresses

A prerequisite for SmartPost to be able to communicate with e-Boks through the REST interface is that e-Boks knows the IP addresses of the systems that use the services of e-Boks. These are typically registered at Digitaliseringsstyrelsen (Danish Agency for Digitisation) from where e-Boks usually gets the information.

Important: If the information about e-Boks addresses is not up-to-date, SmartPost will not be able to contact the services of e-Boks.

The IP address is the IP address(es) that is known from the WAN (typically the Internet).

Tip: From the organization’s network, you can determine the IP address by using the website: http://www.myip.dk.


Agreement on provision of NemID services (tilslutningsaftale)

The LRA administrator makes an agreement with e-Boks. See instructions Tilslutning til Digital Post Administrationsportalen from Digitaliseringsstyrelsen.

The agreement must be completed before the configuration of e-Boks can start.


Retrieval system

This sections describes the configuration tasks in connection with setting up a retrieval system in the e-Boks administration portal. The retrieval system allows the SmartPost process to retrieve messages from a mailbox in e-Boks. SmartPost retrieves the messages, such as replies from citizens and organizations to messages in e-Boks and unsolicited messages, and saves them automatically in WorkZone.

Create a retrieval system

Before you start this process, make sure that the organization's IP address is known by e-Boks and that an agreement has been made so that the REST service and the e-Boks administration portal are available. You can verify IP address and the agreement are in place it by logging into the e-Boks administration portal using this link: http://ekstranet.e-boks.dk/. If clicking the link results in a page with a text saying “Kun adgang for myndigheder” (Only accessible for authorities), the organization is either not an authority, or the agreement has not yet been concluded.

See e-Boks opens for the organization's IP addresses and Agreement on provision of NemID services (tilslutningsaftale).

The customer needs to create a retrieval system at e-Boks. This can be done via e-Boks administration portal (http://ekstranet.e-boks.dk/).

The table below describes the values that must be applied to the retrieval system.

Value name Value Description

Name

Suggestion: ”KMD SmartPost Retrival”

The name by which the retrieval system can be recognized.

EAN no.

Customer specific

The EAN number of the authority.

Delivery type

Pull

Specifies whether e-Boks needs to “push” messages into the customer’s system, or whether SmartPost needs to request e-Boks’s service in order to retrieve the messages (pull). SmartPost only uses pull.

API Version

v1

Currently, SmartPost only supports v1.

Certificate

Customer specific

The certificate to e-Boks is uploaded here.

Name of contact person

Customer specific

The name of the person at the customer's business who e-Boks must be able to contact in connection with questions and handover of commercial information. This will typically be a manager in the customer’s organization.

Email address of contact person

Customer specific

The email address on which the contact person can be contacted.

Phone number of contact person

Customer specific

The phone number on which the contact person can be contacted.

When the values have been entered, and the retrieval system is created, e-Boks automatically assigns an ID to the retrieval system. This ID must be used in connection with the configuration of SmartPost so that SmartPost knows which retrieval system to use.

See Configure SmartPost for receiving messages.

Create mailboxes

The organization needs to create at least one mailbox at e-Boks in which messages from citizens or an organization can be gathered, before they are collected by the SmartPost retrieval service. Subsequently, the mailbox needs to be connected to the Retrieval system.

Depending on the size of the organization and how it is organized, the organization can decide whether more than one mailbox needs to be configured. As SmartPost applies to a retrieval system and not to a specific mailbox, the customer can decide the number of mailboxes independently of SmartPost. In connection with the configuration of individual mailboxes in e-Boks, the customer can choose if the mailbox should be emptied by a retrieval system and, in that case, by which one. The diagram below shows an example of mailboxes and retrieval systems that are configured in e-boks and SmartPost.

Mailbox A is connected to retrieval system A. If necessary, an alternative system can retrieve messages from Retrieval system A.

Mailbox B and Mailbox C are connected to Retrieval system B. As SmartPost has been configured to retrieve messages from Retrieval system B, Mailbox B and Mailbox C are emptied by SmartPost.

Mailbox D is not connected to any retrieval system. As a result, SmartPost (or an alternative system) cannot retrieve messages from this mailbox via the REST interface.

The table below describes the values with which an e-Boks mailbox can be configured.

Value name Value Description
Name For example: ”Mail for organization” The name of the mailbox as the end user sees it.
Description This mailbox is used for replying to messages sent by SmartPost as well as unsolicited messages. A description of the mailbox for users who later use the administration portal.
Instructions Send mail to this mailbox if you want to contact the organization. Description of the mailbox that the end user sees.
Select folder for placing the mailbox See notes In a minimum configuration, there will only be one mailbox, and this mailbox will be the root mailbox. In such a case, the selection must be empty. In cases of more complex configurations with more mailboxes, the selection is based on the planned mailbox hierarchy.
Activation date Now Specifies the date where the mailbox will be active, that is visible to the end user.
External code can be used freely by suppliers and is available via system call Empty Not used.
This mailbox must be used by default for reception of mail, in cases where the end user makes a direct request Selected

In the minimum configuration, the same mailbox will be used for both end user requests and unsolicited requests. In this case, the mailbox must be the default mailbox, for which reason the field must be selected.

In cases of more complex configurations with more mailboxes, this mailbox is not necessarily selected by default.

The mailbox must be visible to the end user Selected

In the minimum configuration, the same mailbox will be used for both end user requests and unsolicited requests. In this case, the mailbox must be visible so that the end user can use it for unsolicited requests.

In cases of more complex configurations with more mailboxes, this mailbox is not necessarily visible.

Create subject

A minimum of one subject for one of the mailboxes connected to the retrieval system from which SmartPost is to retrieve messages must be configured.

Value name Value Description
Subject name For example: “Contact to organization” The subject that the end user can choose in connection with sending in an unsolicited message for an authority.
Form Empty Not supported by SmartPost.

See also e-Boks and Strålfors certificates


Configure e-Boks

SmartPost uses e-Boks to implement digital mail (Digital Post). For SmartPost to be able to communicate with e-Boks, the organization must make an agreement (tilslutningsaftale) with e-Boks first.

To configure digital mail using e-Boks, you need to complete the following steps.

  1. Acquire and install a certificate.
  2. Ensure Internet access.
  3. Configure the dispatch system.
  4. Configure the retrieval system.

You need to complete all steps for both test and production environments.

Certificate

The organization must acquire and install a certificate (funktionscertifikat) with a password. See Acquire and install the e-Boks Certificate.

Apply the certificate to the SmartPost process

You must add the private key of the IIS user that runs the WzpSvc app pool to the e-Boks certificate and set up the e-Boks dispatcher to run with this certificate. See Apply the certificate to the dispatcher.

Internet access

For SmartPost to be able to communicate with e-Boks, it is required that the server that runs SmartPost has Internet access to e-Boks.

Environment URL Port
Test https://demo-rest.e-boks.dk/V1.svc 443
Production https://rest.e-boks.dk/v1.svc 443

Note: For Microsoft Windows Server 2008 R2, you must make TlS 1.2 available to the operating system. See Add the TLS 1.2 key to Registry (Windows Server 2008 R2).

As SmartPost is deployed on the web servers, it is only required to open for access to e-Boks from the web servers.

Configure the dispatch system

When you have uploaded the certificate and configured a dispatch system using the e-Boks Administration portal, you need to configure SmartPost to reflect the configuration of the dispatch system. See Configure SmartPost for sending messages.

Configure the retrieval system

When you have uploaded the certificate, you can start configuring a retrieval system using the e-Boks Administration portal. The minimum configuration of a retrieval system consists of a mailbox and a subject, to which you attach the retrieval system. Next, you need to configure SmartPost to reflect the configuration of the retrieval system. See Configure SmartPost for receiving messages.