立即与支持人员聊天
与支持团队交流

Identity Manager 8.1.4 - API Designer User and Development Guide

API Designer Basic principles of API development Examples and help – Software Development Kit Quick start – Creating an API 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 files API Server ImxClient command line program

Authentication

User authentication is carried out on the API Server for each API project.

Running an API method requires prior authentication on an API project. If the API method is marked as AllowUnauthenticated, authentication is not required (you can find an example in the SDK)

Authentication has two steps:

  1. Required primary authentication: Default authentication through an authentication module

  2. Optional secondary authentication: Multi-factor authentication (for example, using Starling 2FA)

Related topics

Authentication (primary)

You can use the imx/login/<API project name> API method for primary authentication on the API project.

To do this, use the POST HTTP method to send the following query:

{ "Module": "RoleBasedPerson", "User": "<user name>", "Password": "<password>" }

TIP: See our SDK for examples.

Related topics

Authentication with Starling 2FA (secondary)

Secondary authentication on the API project using Starling 2FA uses the following methods:

  • Login/authentication using push notifications: starling/send/push
  • Login/authentication using SMS messages: starling/send/sms
  • Login/authentication using phone calls: starling/send/call
Related topics

Logging out

You can use the imx/logout/<API project name> API method to log out of the API project.

Related topics
相关文档

The document was helpful.

选择评级

I easily found the information I needed.

选择评级