Laserfiche Cloud API Web Service Connections

Note: Applies to: Laserfiche Cloud.

Follow the steps below to obtain the credentials needed to configure Web Service Connections used by Web Request Rules to access Laserfiche Cloud APIs:

• Laserfiche Repository API v2.
• Laserfiche OData Table API

1. Create a Service Application in the Laserfiche Developer Console

• You’ll need to select an existing Service Principal account, or create a new one, and then generate a Service Principal Key (record the key string, you’ll need it later). Review our dedicated guide on this topic for more details.

Note: The Service Principal account must be granted the roles needed to access resources to be exposed via Laserfiche API. For more information see Repository Security.

• Create a Service App in the Laserfiche Developer Console to represent the integration with Laserfiche Cloud API. Follow instructions here. You must select the long-lasting Authorization Key option when creating the Authorization Key.

Note: The security scopes required to access Laserfiche resources, for example repository.Read repository.Write project/Global table.Read table.Write must be configured in the Service App and included in the credentials. For more information see OAuth 2.0 Scopes for Laserfiche APIs.

2. Create or import a Laserfiche Cloud API Web Service Connection

Laserfiche Repository API Web Service Connection

• Laserfiche API US Cloud - Web Service Connection.dsi
• Laserfiche API Canada Cloud - Web Service Connection.dsi
• Laserfiche API Europe Cloud - Web Service Connection.dsi

Laserfiche OData Table API Web Service Connection

• Laserfiche API OData Table US Cloud - Web Service Connection.dsi
• laserfiche-api-odata-table-canada-cloud-web-service-connection.dsi
• Laserfiche API OData Table Europe Cloud - Web Service Connection.dsi

3. Configure Web Service Connection

1. Authentication step: Replace the Bearer value placeholder text <Enter your Service Application long-lasting authorizationKey from Developer Console> with the long-lasting authorizationKey generated for your Service App.

1. Authentication step: Specify the scopes required to access the underlining resources.

Note: The security scopes required by the Web Request Rules, for example repository.Read repository.Write project/Global table.Read table.Write must be configured both in the Service App and in the Web Service Connection. For more information see OAuth 2.0 Scopes for Laserfiche APIs.

1. Authentication step: Test and Save the Web Service Connection

Note: Laserfiche Cloud API Web Service Connection is now ready to be used. Verify that the appropriate Web Request Rules are configured to use this connection.