Chatee ahora con Soporte
Chat con el soporte

Identity Manager 9.0 LTS - API Development Guide

Implementing your own APIs

To implement your own APIs, you can create API plugins.

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

To implement your own API

  1. Create an API plugin (see Creating and editing API plugins).

  2. Compile the appropriate TypeScript API client (see Compiling TypeScript API clients).

Detailed information about this topic

Creating and editing API plugins

With the help of API plugins, you can implement and use your customized APIs.

Prerequisites:

  • You use a version management system (for example, Git).

  • You use an Integrated Development Environment (IDE).

To create an API plugin

  1. Start your IDE (such as Visual Studio).

  2. Create a new .NET Framework 4.8 project named CCC.CompositionApi.Server.Plugin.

  3. Add references to the following DLL files from the One Identity Manager installation directory:

    • QBM.CompositionApi.Server.dll

    • VI.Base.dll

    • VI.DB.dll

  4. Create the API code.

  5. Compile the DLL file in your IDE.

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

  7. Restart the API Server and ensure that the CCC.CompositionApi.Server.Plugin.dll file is present.

To edit an existing API plugin

  1. Start your IDE (such as Visual Studio).

  2. Open the existing .NET Framework 4.8 project.

  3. Edit the API code.

  4. Compile the DLL file in your IDE.

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

  6. Restart the API Server and ensure that the CCC.CompositionApi.Server.Plugin.dll file is present.

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

  1. Open a command line prompt.

  2. Run the following command:

    imxclient compile-api -N -W /copyapi imx-api-ccc.tgz /packagename imx-api-ccc

    The dialog to select the database connection is opened.

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

  4. Select the authentication method and, under Authentication method, enter the login data for the database.

  5. Click Log in.

  6. Import the imx-api-ccc npm package into your TypeScript application.

ImxClient command line program

You can use the ImxClient command line tool to run different functions for managing the API Server and files on the command line.

Detailed information about this topic
Documentos relacionados

The document was helpful.

Seleccionar calificación

I easily found the information I needed.

Seleccionar calificación