Smart ID Messaging includes the Hermod API for easy integration in your application.

Base URL

Base URL for Hermod REST API:

Example: Base URL for Hermod REST API

https://<my-hermod-server>:20400/hermod/

The actual URL can differ depending on your configuration.

Authenticate to Hermod REST API

To authenticate to Hermod, use the API key passed as a http header.

The API key must be pre-configured in Hermod. For more information, see Add API user and callback URL in Hermod.

Header

Value

Description

X-Api-Key

base64(id:key)

The API key is pre-configured in Hermod, with the following parameters:

id = friendly, unique name for the client
key = "password-like" string

Example: "<my-client>:<string of alphanumeric characters>"

Hermod REST API use cases

The table below shows some common use cases with corresponding commands, callbacks, and links to examples.

You can try out the use cases in the Hermod test client.

Hermod REST API callbacks

Hermod sends callbacks to the integrators for command responses and timeouts. The integrator needs to implement a REST API to receive the callbacks from Hermod, according to Hermod API.

One callback URL must be registered for each API user (read X-Api-Key) and callbacks are sent to the API user that initiated the request. For more information, see Add API user and callback URL in Hermod.

Related information

Links

Hermod test client:
https://ext-cod1.test.nexusgroup.com:20488/hermod-testapp/

Use case	Command	Callback	Smart ID Mobile App example	Personal Desktop Client example
Provision profiles and generate keys to tokens and devices	POST /rest/command/provision	POST /rest/callback/provision	Example: Personal Mobile provisioning Example: Personal Mobile Certificate provisioning
Provisioning of certificate to token and device	POST /rest/command/certificate	POST /rest/callback/certificate	Example: Personal Mobile Certificate provisioning
Send authentication request to a device/token	POST /rest/command/authenticate	POST /rest/callback/authenticate	Example: Smart ID Mobile App authentication	Example: Personal Desktop Client authentication
Send signing request to a device/token	POST /rest/command/sign	POST /rest/callback/sign	Example: Smart ID Mobile App signing	Example: Personal Desktop Client signing
Ping to test that endpoint is alive	POST /rest/command/ping	POST /rest/callback/ping
Get status of an issued command	GET /rest/command/poll/{commandId}	-

For details on the respective commands and callbacks, see Hermod API.

Smart ID Messaging API overview