Identity Manager 9.1.3 - API Development Guide

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).

After you create an API plugin, you need to compile a corresponding TypeScript API client.

To compile a TypeScript API client

Open a command line interface (for example, Windows Powershell).
In the command line program, go to the One Identity Manager installation directory.
Run the ImxClient's start-update command (see start-update).
Example
```
imxclient start-update
```
Run the ImxClient's compile-api command (see compile-api).
Example
```
imxclient compile-api /copyapi imx-api-ccc.tgz /packagename imx-api-ccc
```
The dialog to select the database connection is opened.
In the dialog, perform one of the following actions:
- to use an existing connection to the One Identity Manager database, select it in the Select a database connection menu.
  
  - OR -
- to create a new connection to the One Identity Manager database, click Add new connection and enter a new connection.
Select the authentication method and, under Authentication method, enter the login data for the database.
Click Log in.
Import the imx-api-ccc npm package into your TypeScript application.

TIP: (Optional) If you want to use another name for the imx-api-ccc packet, extend the remove-local-packages.js by adding a line for the packet in the list. This ensures that your package is not included in package locking and is always updated from the local source.