Limitation of API Connections for Integrated Applications

If an integrated application does not properly sign out from MYOB Advanced, this application can use all of the API sessions included in the license (that is, reach the maximum number of API users, which is described in License Restrictions for API Users), thus preventing other integrated applications from signing in. To avoid such situations, you can limit the number of sessions for either each integration application assigned to a user type or an individual integration application.

Before configuring these limits, on the Warnings tab of the License Monitoring Console (SM604000) form, you can review whether any of the integrated application opens more than three sessions at a time (which is a predefined system value for this form). If the number of sessions has not been limited for an integrated application and this application opens more than three sessions at a time, a warning is generated and listed in the table on this tab. This warning can indicate that you should configure a limitation for the particular integration application or review the implementation of signing in and signing out in the application.

Configuration of the Limitations

You limit the number of sessions used by each integration application on the User Types (EP202500) form. Also, if it is necessary to specify a different limit for a particular integration application, you can specify this limit on the Users (SM201010) form. For details about how to limit the number of sessions in both of these ways, see To Limit the Number of API Connections of Integrated Applications and To Limit API Connections of a Particular Application.

Lifecycle of Sign-in Requests

The lifecycle of any type of requests (including sign-in requests) is described in Lifecycle of the Requests. This section describes peculiarities of the lifecycle of sign-in requests.

The limitations for the number of API users and the limit of the number of sessions for a particular application are taken into account when one of the API processing cores takes the sign-in request. The API processing core then processes the sign-in request as follows:

  1. Checks whether the maximum number of API users is exceeded. For details about this limit, see License Restrictions for API Users.
  2. Checks whether the limit of the number of sessions specified for this API user is exceeded.

    If the number of sessions opened by the integrated application reaches the limit specified for this integrated application on either the User Types (EP202500) form or the Users (SM201010) form, the integrated application cannot open any new session (that is, cannot sign in to MYOB Advanced) until it closes one of the existing sessions. The system returns an error in the response to the sign-in request.

    If no limit is specified for the integration application on the User Types form or on the Users form, the integration application can open no more sessions than the maximum number of API users in the license.

The diagram in Lifecycle of the Requests shows how a sign-in request is processed by an API processing core.