Identity Manager 9.2 - API Development Guide

To implement your own APIs, you can create API plug-ins.

The API Server loads all DLLs matching the *.CompositionApi.Server.PlugIn.dll naming scheme and deploys the API definitions contained in them.

To implement your own APIs, the following options are available:

You can add an API to a One Identity API project (see Adding APIs to One Identity API projects).
You can create your own API project (Creating API projects).
You can add an API to your own existing API projects (see Adding APIs to your own API projects).

With the help of API plug-ins, you can implement and use your own customized APIs and API projects.

Prerequisites:

To implement your own customized APIs and API projects, you can create API plug-ins.

To create an API plug-in

Start your IDE (such as Visual Studio).
Create a new .NET Framework 4.8 project with a name that complies with the format: <project name>.CompositionApi.Server.Plugin.
Add references to the following DLL files from the One Identity Manager installation directory:
- QBM.CompositionApi.Server.dll
- VI.Base.dll
- VI.DB.dll
Create the API code.
Compile the DLL file in your IDE.
Copy the DLL file to the bin subdirectory of your IIS installation.
Import the DLL file into your One Identity Manager database using the Software Loader and assign it to the Business API Server machine role. For more information on importing files using the Software Loader, see the One Identity Manager Operational Guide.
Copy the DLL file to the One Identity Manager install directory.
Import the DLL file into your One Identity Manager database using the Software Loader and assign it to the Development and Testing machine role. For more information on importing files using the Software Loader, see the One Identity Manager Operational Guide.
Restart the API Server and ensure that the <project name>.CompositionApi.Server.Plugin file exists in the bin folder of the API Server install directory.
Compile the appropriate TypeScript API client (see Compiling TypeScript API clients).

You can edit existing API plug-ins.

To edit an existing API plug-in

Start your IDE (such as Visual Studio).
Open an existing .NET Framework 4.8 project.
Edit the API code.
Compile the DLL file in your IDE.
Copy the DLL file to the bin subdirectory of your IIS installation.
Import the DLL file into your One Identity Manager database using the Software Loader. For more information on importing files using the Software Loader, see the One Identity Manager Operational Guide.
Copy the DLL file to the One Identity Manager install directory.
Import the DLL file into your One Identity Manager database using the Software Loader. For more information on importing files using the Software Loader, see the One Identity Manager Operational Guide.
Restart the API Server and ensure that the <project name>.CompositionApi.Server.Plugin file exists in the bin folder of the API Server install directory.
Compile the appropriate TypeScript API client (see Compiling TypeScript API clients).