Skip to main content

Quick start

To call API methods and test requests, 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 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 you complete the authentication, you get a session token that is used in API requests.

Get a token using authenticate ByWindowsToken​

Method description

This is the simplest method of getting a token. To get a token, call a single method on behalf of the user for whom the token will be issued:

  • If you perform the request via a browser, then you must start the browser 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 is specified in the authentication events.

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

Get a token using authenticate​

Method description

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

As a result of authentication, a similar token is obtained.