Using Learn Web Services

This article demonstrates how to implement Web Services into your Lambda Learn site.

TOPICS


Enabling Web Services

1.  On the Lambda Learn homepage, navigate to Site Administration menu > Advanced Features.

2.  Click on the Enable Web Services checkbox to enable it. 

webservicesenablewebservices

3.  Then, scroll down to the bottom of the page and click Save Changes.

webservicesavechanges

TIP  TIP

We recommend only enabling web services if you intend to use them. As this feature allows external systems to control your site, enabling them without use could leave your site vulnerable. 

settings-Apr-20-2021-10-25-52-32-PM  Web Services Settings

1.  On the Lambda Learn homepage, navigate to Site Administration menu > Plugins.

2.  Using the Plugins sidebar menu, expand the Web Services section to access all applicable settings.

webservicessettingslist

3.  Click on Overview if you would like a walkthrough of all of the necessary steps to set up web services for your site, including enabling access for external systems and setting up users as clients. 

Back to TOPICS


External Services

In either the Built-In Services or Custom Services tables, you can click on a particular service's Function to view all the functions being carried out by that service, or click Edit to customise the functions that web service is carrying out. 

plus-Jan-29-2021-10-02-33-11-PM  Adding an External Service

1.  On the Lambda Learn homepage, navigate to Site Administration menu > Plugins > Web Services > External Services.

webservicesexternalservices

2.  Under the Custom Services table, click the Add link.

webservicescustomservices

3.  Expand the External Services section, and configure the following settings.

Enter a Name and Short Name. 

webservicescustomname

Select whether or not the service is Enabled, and if Authorized Users [can] Only create web tokens.

webservicecustomenabled

Click the Show More link, and select whether or not users Can Download Files and Can Upload Files. 

webservicecustomcandownload

If necessary, select Required Capabilit[ies] that users must meet to access the service.

webservicecustomrequiredcapability

4.  Once you are complete, click Add Service.

 webservicecustomaddservice

5.  On the Add Functions page, click Add Functions.

webserviceaddfunctions

6.  Using the Functions drop-down menu, select the appropriate functions for your web service.

webservicefunctionlist

7.  Once you are complete, click Add Functions.

addfunctions

Back to TOPICS


Managing Protocols

1.  On the Lambda Learn homepage, navigate to Site Administration menu > Plugins > Web Services > Manage Protocols. 

webservicemanageprotocols

2.  To enable or disable any protocols, click on the corresponding Enable/Disable icon. 

webservicemanageprotocolsenable

TIP  TIP

We recommend only enabling protocols if you intend to use them. 

3.  Once you are complete, click Save Changes. 

webservicesavechanges

Back to TOPICS


Managing Tokens

plus-Jan-29-2021-10-02-33-11-PM  Adding a Token

1.  On the Lambda Learn homepage, navigate to Site Administration menu > Plugins > Web Services > Manage Tokens.

webservicemanagetokens

2.  Click the Add link.

webservicesmanagetokensaddlist

3.  Expand the Token section, and configure the following settings.

Select the User that will use the token, and the Service.

webservicetokenuser

Enter any IP Restrictions.

webserviceiprestriction

If necessary, enter and enable a Valid Until date.

webservicevaliduntil

4.  Once you are complete, click Save Changes. 

webservicesavechanges1

The token will be immediately generated, which will need to be copied before the page is closed as it will not be shown again. 

webservicefinaltoken 

Back to TOPICS