Open API

In ASAP, you can use Open API to interact with third-party solutions. Open API works via HTTP and offers a set of request/response methods.

API requests must be sent to the following address:

<URL of the ASAP portal, which is used to interact via Open API>/openapi/<API version>/<request>

How to get the ASAP URL, which is used to interact via the API

To get an ASAP Open API URL:

1. Sign in to the ASAP web platform.
2. In the Dashboard section, click the Import and synchronization button, and then open the Open API tab.
3. The link for contacting ASAP via Open API is at the bottom of the window. Copy and save it in any way convenient for you.

How to enable access via the API and generate a token

To authorize requests, they must be signed by a token created on the ASAP platform. Only the company's administrators can create tokens.

To create a token:

1. Sign in to the ASAP web platform.
2. In the Dashboard section, click the Import and synchronization button, and then open the Open API tab.
3. Click the New token button.

   The Get token window opens.

4. Copy the token and save it in any way convenient for you.

The token is not stored in the ASAP system with public access. After closing the Get token window, it will be unavailable to view. If you closed this window without copying the token, you need to click New token again for the system to generate a new token.

The issued token is valid for 12 months. When this period expires, the token is revoked. The issued token is also revoked if it is not used for 6 months.

Authorization

The token obtained on ASAP needs to be added to the headers of all API requests. The header should look like this:

Authorization: Bearer <token received on the ASAP platform> ContentType 'application/json; charset=utf-8'

Response format

JSON is the default format for responses to API requests.

Example of a CURL call

Below is an API request to https://domain.com/, which uses the "GET openapi/v1/groups" method (get a list of groups). The request authenticates using the token e8c699c05d495566a94bbb6841894153.

curl -X GET "https://domain.com/openapi/v1/groups" -H "accept: application/json" -H "Authorization: Bearer Token:e8c699c05d495566a94bbb6841894153"

ASAP Open API methods used to integrate with learning management systems (LMSs)

Available methods of integrating with learning management systems:

1. /users/info – get a personal link to the user portal.
2. /groups – get a list of groups available for this company.
3. /users – create a user and add him/her to the specified group.
4. /report – generate report data about users who are registered on the portal and are completing training on ASAP applications.
5. /user – make changes to user data. Moving a company employee to a different training group.

Each method supports no more than 10 requests per second (RPS).

In this help section Examples of using Open API "POST /openapi/v1/users/info" method "GET /openapi/v1/groups" method "POST /openapi/v1/users" method "POST /openapi/v1/report" method "PATCH /openapi/v1/user/:userId" method "DELETE /openapi/v1/user/:userId" method

To the top