Chat now with support
Chat with Support

Identity Manager 8.2.1 - API Development Guide

Basic principles of API development Examples and help – Software Development Kit API configuration Implementing your own APIs API Designer Quick start – Creating an API with the API Designer Working with the API Designer
Starting the API Designer Project types User interface Global settings Database objects Labeling changes Find and replace Multilingual captions Managing database queries Managing tabs Managing layouts Displaying the change history (command list) Bookmarks Compiling an API Managing versions (compilation branches) Testing an API Linking C# projects to the API Designer
API projects API methods ImxClient command line program

Basic principles of API development

The main components of an API created using the API Designer are files and projects.

Basics about API files:

  • Use API files to define API methods for sending data to the application or to querying data from the application.

  • An API file can belong to more than one project.

Basics about API projects:

  • API projects combine multiple API files into logical sections. The API project includes the configuration.

For basics about the API Server, see API Server basics.

Detailed information about this topic

API Server basics

In this chapter you will find basic information about the API Servers architecture, which is important for custom programming with your own API methods.

Detailed information about this topic

General information about the API Server

  • The API Server provides the API that you create in the API Designer.

  • The API Server is implemented using the Owin Platform (see

  • URLs are case sensitive.

Calling the API Server web interface

From the API Server's web interface you can:

  • Configure the API Server.

  • Call the swagger documentation for your API.

  • Open the Operations Support Web Portal.

  • Call all installed web applications.

To call the API Server web interface

  • In a web browser, open the webpage (URL) of your API Server.

Self Service Tools
Knowledge Base
Notifications & Alerts
Product Support
Software Downloads
Technical Documentation
User Forums
Video Tutorials
RSS Feed
Contact Us
Licensing Assistance
Technical Support
View All
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating