Converse agora com nosso suporte
Chat com o suporte

Identity Manager 9.3 - API Development Guide

Calling the API Server web interface

From the API Server's web interface you can:

  • Open the Web Portal.

  • Open the Password Reset Portal.

  • Open the Operations Support Web Portal.

  • Open the Administration Portal to configure the API Server and the web applications (see One Identity Manager Web Application Configuration Guide)

  • Open all other installed web applications

To call the API Server web interface

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

Encryption

The API Server stores data securely encrypted on the client.

The certificate is configured when the API server is installed on the IIS. For more information on installing the API Servers, see the One Identity Manager Installation Guide.

For more information about configuring encryption, see the One Identity Manager Web Application Configuration Guide.

General notes on programming your own API methods

  • Because the API Server is stateless, save the API methods without a client specific state.
    For example, you cannot, therefore, define global variables or store session object status data. When the API Server processes are restarted, these values are not restored.

  • After enabling routes, you cannot change the definition objects anymore.

  • Use asynchronous code for defining API methods. This supports more efficient usage of server resources and improves performance of the system under load. The methods of the API and the underlying object model convert this asynchronously using the Task-based Asynchronous Pattern (TAP). For more information about TAP, see here.

  • Do not use the HttpContext.Current method when you define API methods. You can query the current HTTP requirements with the QBM.CompositionApi.OwinRequestScopeContext.Context.Current static method.

  • If you define API methods that modify data, do NOT use the GET method.

  • API methods are deployed via ASP.NET Core. You can use route templates to define how an HTTP request is assigned to a corresponding API method. The syntax for route templates is specified by ASP.NET Core. For more information about route templates, see here.

Automatic checking of API route uniqueness

The API Server automatically checks at the start whether API routing is unique. The moment the API Server discovers that non-unique URL patterns were registered, an error message with the ApiServer0037 error code is generated.

To solve the issue, the API routes must be registered in another order by modifying the SortOrder property of the respective API route. The SortOrder property specifies the order in which the URL patterns are applied to the URL of an API request. API patterns with the lowest SortOrder are used first.

Documentos relacionados

The document was helpful.

Selecione a classificação

I easily found the information I needed.

Selecione a classificação