Digipass S3 is now DigipassONE. This section is currently being updated to reflect our new name.

Build and Deploy API Server Plugins

  • Updated on Mar 16, 2026
  • Published on Nov 25, 2025
  • 1 minute(s) read
Prev Next

To build a custom API Server plugin, use the Nok Nok API Server SDK BOM. The BOM contains the following directories:

  • docs - contains Java docs for all interfaces and classes which can be implemented and used by a custom plugin.

  • licenses - contains license notices for the libraries used by the SDK.

  • pluginsdk - contains definitions and implementations of the SDK interfaces and classes (needed to compile a custom plugin).

  • src - contains an Eclipse project with a sample of a custom session plugin TutorialProcessor.java which implements the ISessionManager interface. The Eclipse project build generates a JAR file.

After building your custom plugin, deploy it by copying its JAR file into nnlgateway/WEB-INF/lib directory under Tomcat webapps. Restart Tomcat.

To configure and activate your plugin, see API Server Configuration. Although you can use the CLI to configure and activate your plugin, these tasks are much easier if you first add your API Server plugin to the Admin Console.