Document API

Available in Cloud Business, Cloud Enterprise and Cloud Compliance.

The Document API allows you to interact with your labels, solutions, databases, and other documents, stored in the Loftware Control Center database, without interacting directly with Loftware Control Center.

Use Document API to:

  • Check-in / Check-out files and discard a checkout
  • Create files and folders
  • Copy and delete files
  • Get file information (like file IDs)
  • Get a list of files and workflows

You can use the Document API with your custom front end (UI applications) or back end (various services and integrations). Solutions made in Desktop Designer are not able to parse the JSON responses that come from the API. To parse the JSON responses, you can use the "Execute Script" action and write your own Phyton script.

You can test the Document API on the Developer Portal.

Note: The Developer Portal is where you sign up and test Loftware Cloud APIs. The Developer Portal includes auto-generated code samples in multiple programming languages.

To use Document API in the Developer Portal, you must:

  • Set up your Developer Portal account.
  • Create your free subscription for our Loftware Cloud product.
  • Connect your Developer Portal subscription with Control Center.

To set up your Developer Portal account, create subscription and integrator keys, and connect your Developer Portal to Loftware Control Center​​, follow the steps in Using Loftware Cloud APIs.