How to authorize with an API key in the LMS365 (Learn365) API and Postman

Introduction

To use the LMS365 (Learn365) API, users need to authorize with a relevant API key. An API key is also used to authorize in Postman.

This article provides guidance on where to get an API key and how to authorize with it in the LMS365 (Learn365) API and in Postman.

 

Get an LMS365 (Learn365) API key for authorization

Required role: LMS admin or Microsoft 365 global admin

LMS365 (Learn365) enables global admins to generate multiple LMS365 (Learn365) API keys with two permission levels - Read only and Full control

To get the API key with the relevant permission level:

1. Navigate to the LMS365 (Learn365) Admin Center > Global Settings API key management.

2. Select the API key and copy it using the Copy API key option.

The API key will be used for authorization in the LMS365 (Learn365) API.

 

copy_key_.png

 

Authorize in the LMS365 (Learn365) API

After obtaining the relevant API key, you can use it to authorize access to the LMS365 (Learn365) API.

1. Go to https://api.365.systems and navigate to LMS365 Cloud API.

2. Select either Authorize or the lock icon of the API endpoint you'll use. The Available authorizations page will open.

 

the_authotization_process_.png

 

3. On the opened Available authorizations page, under Basic authorization:

  • In the Username field, enter api.
  • In the Password field, paste the API key.

4. Select Authorize to proceed with the authorization. To cancel the action, select Close.

 

_authorize_.png

 

To log out of the LMS365 (Learn365) API after authorization:

1. Select either Authorize or the lock icon of the relevant API endpoint. The Available authorizations page will open.

 

log_out_.png

 

2. On the opened Available authorizations page, select Logout.

 

_log_out_.png

 

Authorize in Postman

To authorize in Postman:

1. Navigate to the Authorization tab.

2. From the Type drop-down menu, select Basic Auth.

3. Complete the Username and Password fields:

  • In the Username field, enter api.
  • In the Password field, paste the API key.

 

postman_authorization_.png

 

4. Select Send.

The authorization data is automatically included in the request and is used each time you send a request.

 

Was this article helpful?
0 out of 0 found this helpful

Comments

Article is closed for comments.