Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This article describes how to connect Smart ID Digital Access component to Smart ID Messaging that can either be installed on-premises or consumed as a service via Nexus GO Messaging.

Smart ID Messaging is a web-based service for online authentication and signing using Smart ID Mobile App or Smart ID Desktop App with certificates. 

For more information on the communication between Digital Access component and Smart ID Messaging, see Architecture overview - Smart ID Messaging and Digital Access

Expandall

Prerequisites

Expand
titlePrerequisites

The following prerequisites apply:

Step-by-step instructions

Expand
titleLog in to Digital Access Admin
  1. Log in to Digital Access Admin with an administrator account.


Expand
titleOnly for Nexus GO Messaging: Request API key from Nexus

If you use Nexus GO Messaging, then you first need to request an API key from Nexus.

To request a Nexus GO Messaging API key:

  1. Find your Nexus GO Messaging callback URL:

    1. In Digital Access Admin, go to Manage System > Policy Services.

    2. Click Manage Global Policy Service Settings....
    3. Copy Personal Messaging Callback URL, and replace <access-point-public-host> with your DNS name.

      Panel
      titleDefault: Personal Messaging Callback URL

      https://<access-point-public-host>/https/api/rest/v3.0/personalmessaging


  2. Request an API key from Nexus by sending an email with the callback URL to Nexus support: support@nexusgroup.com.

    When you have received a reply, you can go on to the following tasks.


Expand
titleConnect Smart ID Messaging to Digital Access

To set up the connection to Smart ID Messaging (Personal Messaging):

  1. In Digital Access Admin, go to Manage system > Policy Services.
  2. Click Manage Global Policy Service Settings....
  3. Check Enable Provisioning.
  4. Enter Provisioning Settings, that will apply to all policy services. Click the ?-sign for more information.

    1. In Personal Messaging URL, enter a valid URL:

      1. For Smart ID Messaging on-premises, enter the URL as it has been configured in Smart ID Messaging.
        In this example, the default path is shown. If you have changed the path when you installed Smart ID Messaging, enter your configured path here. For more information, see Install Hermod:see Deploy Smart ID: 

        Panel
        titleExample: Personal Messaging URL for Personal Messaging on-premises

        https://<personalmessaging-public-host>/hermod/rest/command


      2. For Nexus GO Messaging, enter the following URL:

        Panel
        titleExample: Personal Messaging URL for Nexus GO Messaging

        https://messagingservice.go.nexusgroup.com/command


    2. In Image API URL, replace <access-point-public-host> with your DNS name.

    3. Enter an X API Key:
      1. For Smart ID Messaging on-premises, enter an API Key that has been generated in Smart ID Messaging. For more information on how to generate a key, see Add API user and callback URL in Hermod.
      2. For Nexus GO Messaging, enter the X API key as received by Nexus.
    4. If required, enter your own Attestation Key, whichis used to sign provisioning responses.
      There is a default Attestation Key stored, but it can be required to upload your own key, for example if you use the Smart ID Mobile SDK.
    5. If you upgrade from version 5.12 or earlier of Digital Access component, and already use Smart ID Mobile App, you need to migrate these profiles to Smart ID Messaging (see Digital Access component news). Enter a Messaging Service Public URL. Thisis the URL that the existing Smart ID Mobile App profiles will be redirected to at the very first call after the migration. After that, the Smart ID Mobile App profile will memorize the new URL and use it for later calls.
      1. For Smart ID Messaging on-premises, enter the URL as it has been configured in Smart ID Messaging.
        In this example, the default path is shown. If you have changed the path when you installed Smart ID Messaging, enter your configured path here. For more information, see Install Hermod Deploy Smart ID:

        Panel
        titleExample: Messaging Service Public URL for Personal Messaging on-premises

        https://<personalmessaging-public-host>/hermod/rest/ms


      2. For Nexus GO Messaging: 

        Panel
        titleExample: Messaging Service Public URL for Nexus GO Messaging

        https://messagingservice.go.nexusgroup.com/ms 


      Note

      This is supported from Smart ID Mobile App version 3.10.


    6. For help on other input fields, click the ?-sign for more information.


Expand
titleEnable Images

The Smart ID Mobile App must be able to receive images during the authentication process. For this, a public available web resource as well as the Image API must be enabled.

Expand
titleEnable distribution-service web resource

To be able to receive images from the Distribution Service over the Access Point the corresponding web resource must be enabled:

  1. In Digital Access Admin, go to Manage Resource Access.
  2. Select the registered distribution-service web resource.
  3. Click Edit Resource Host.
  4. Check Enable resource.
  5. Click Save.


Expand
titleEnable Image API

The Image API must be enabled:

  1. In Digital Access Admin, go to Manage System > Distribution Services.
  2. Select the registered Distribution Service.
  3. Check Enable Image API.
  4. Click Save.



Expand
titleAdd CA certificate

To make Digital Access component trust Smart ID Messaging, the Smart ID Messaging certificate authority (CA) must be added in Digital Access component:

  1. Locate the CA certificate files:

    1. For on-premises installation of Smart ID Messaging, locate the SSL certificate that was used to set up Smart ID Messaging.

    2. For Nexus GO Messaging, download the following CA certificate file:

      Digicert intermediate CA: Digicert_SHA2_intermediate.cer

  2. Add the CA in Digital Access component by uploading the CA certificate files. See the section Add certificate authority in Add certificates in Digital Access.


This article is valid for Smart ID 20.11 and later.

Related information