Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
This article describes how to integrate Smart ID Messaging with other Smart ID components (Identity Manager or Digital Access).
Each client (Identity Manager, Digital Access etc) that connects to the messaging service must be added to the configuration file and set up with an api key.
Note |
---|
From Smart ID Messaging component Hermod version 3.5.0, swagger is enabled by default. See heading “If needed, edit Hermod configuration” in Install Hermod for an example. |
Related information
- The Smart ID component (Identity Manager or Digital Access) connects to Smart ID Messaging with the API key for the specific client,and initiates a command.
- The command is then processed by a device and a response is sent back to the
public-url
as configured in Smart ID Messaging. - When the command has been processed by the device or when it has expired, the returned response is validated by Smart ID Messaging and a callback is sent to the configured
callback-url
for the originatingclient-id
.
Prerequisites
Expand | ||
---|---|---|
| ||
|
Step-by-step instruction
Configure clients
Expand | |||||
---|---|---|---|---|---|
| |||||
|
Expand | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
Generate an Identity Manager (IDM) client
Generate a Digital Access (DA) client
|
Expand | ||
---|---|---|
| ||
|
Configure the public base url for the messaging service
Expand | |||||||
---|---|---|---|---|---|---|---|
| |||||||
The public-url setting in hermod-conf.yml is the URL that external apps, such as Smart ID Mobile App and Smart ID Desktop App will connect to. You must be able to reach it from internet and TLS must be used to make sure that the external apps work.
|
Configure TLS
Expand | |||||
---|---|---|---|---|---|
| |||||
When you use TLS for the public-url, you need to either:
OR
|
Initialize the database
Expand | ||
---|---|---|
| ||
The database for Smart ID Messaging must be initialized using files for the specific database engine and version of Smart ID Messaging. For a new installation
For an upgrade
|