Skip to main content

Quick start

To call API methods and test requests, you can use the Swagger interface, which is built into Core Server.

To enable access to the interface, do the following:

  1. Open the Core Server configuration file web.config (located in the folder C:\inetpub\wwwroot\am\core).
  2. Set the enableSwagger parameter to true.

The Swagger interface will be available at the link http(s)://<DNS_Axidian_Server>/am/core/swagger/

Request administrator token​

To perform most API requests, certain rights in the Axidian system are required. To successfully perform such requests, you need to authenticate in the API as a user with the required set of rights. After authentication is performed, a session token will be obtained, which is used in API requests.

Obtain a token using authenticate ByWindowsToken​

Method description

This method of obtaining a token is the simplest. To obtain it, you need to call a single method on behalf of the user for whom the token will be issued:

  • if the request is performed via a browser, then the browser must be launched on behalf of the required user;
  • in PowerShell, when making the request you need to use the additional parameter UseDefaultCredentials (example of the postRequestForWin function in PowerShell).

Any application from the Axidian list can be specified as the application identifier.

Important!

The application used will be specified in the authentication events.

Response Body
{
  "ValidPropertiesMask": 5,
  "Token": ""
  "LogonResult": null,
  "UserId": ""
}

Obtain a token using authenticate​

Method description

In this method of obtaining a token, you can use the authentication methods that are available to the user.

As a result of authentication, a similar token will be obtained.