Contents x
    Liquit Workspace API
    • 20 Jul 2023
    • 2 Minutes to read
    • Print
    • Dark
      Light
    • PDF
    Contents

    Liquit Workspace API

    • Updated on 20 Jul 2023
    • 2 Minutes to read
    • Print
    • Dark
      Light
    • PDF
    Article Summary

    The Liquit Workspace API allows you to integrate the content of Liquit Workspace within your Portal. The Liquit Workspace API contains JavaScript functions which allow you to communicate with the Liquit Workspace backend.

    Loading the Liquit Workspace API

    To start using the Liquit Workspace API you need to include the Liquit Workspace API javascript file found on api.liquit.com in the head of your HTML file as follows:

    <!DOCTYPE html>
<html lang="en" xmlns="http://www.w3.org/1999/xhtml">
    <head>
        <meta charset="utf-8" />
        <title>Liquit Workspace API</title>
        <script type="text/javascript" src="https://api.liquit.com/workspace/v2/liquit.workspace.js"></script>
    </head>
    <body>
    </body>
</html>

    The script tag is mandatory and the URL it contains represents the location of a JavaScript file that loads all the functions and definitions you need for using the Liquit Workspace API.

    Example

    The easiest way to start learning about the Liquit Workspace API is to see a simple example. The following webpage outputs all available applications in Liquit Workspace in your web console:

    // Initialize Liquit API with the target zone.
Liquit.Initialize('https://workspace.liquit.com', {

});

Liquit.SSO({

    // The username of the user to login.
    // For best user experience, we recommend setting this property to the expected user as it will be used for example as login hint to Azure AD.
    username: null,

    // The Identity Source to use. Liquit will auto-detect it if it is not set.
    identitySource: null //'Azure AD'

}, function(sessionId, fault) {

  // Check if authentication failed.
  if (fault != null) {
      alert('Error ' + fault.code + ': ' + fault.message);
      return;
  }

  // Fetch the applications that are available to the end user in the current context.
  Liquit.Applications.List({
  
      sort: 1

  }, function (fault, result) {

      // Check if the request failed.
      if (fault != null) {
          alert('Error ' + fault.code + ': ' + fault.message);
          return;
      }

      console.log(result);

  });

});

    This documentation section is intended for

    Administrators familiar with JavaScript programming and object-oriented programming concepts. You should also be familiar with Liquit Workspace from a user's point of view.

    What you will find in this documentation section

    This documentation section contains information about:

    • A list with JavaScript functions through which you can run CRUD operations in the Workspace environment
    • A list of all existing Workspace settings and their description

    Note that the content of this documentation is based on the latest available version of Liquit Workspace.


    Copyright 2024 Liquit Software B.V. All rights reserved.

    Microsoft and Windows are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.
    Liquit Workspace is a registered trademark of Liquit Software B.V. in the Netherlands and/or other countries.
    All other trademarks are the property of their respective owners.

    Was this article helpful?
    What's Next