---
title: "Build and Deploy API Server Plugins"
slug: "s3suite94-build-and-deploy-api-server-plugins"
updated: 2026-10-27T18:41:54Z
published: 2026-10-27T18:41:54Z
canonical: "docs.onespan.com/s3suite94-build-and-deploy-api-server-plugins"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.onespan.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Build and Deploy API Server Plugins

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](/dpoa/docs/s3suite94-reference-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](/dpoa/docs/s3suite94-add-your-custom-api-server-plugin-to-the-admin-console).