2023:API Services (Service)

You can perform Batch processing via REST API web calls by installing API Services.

About

The Grooper REST API (Application Programming Interface) allows for seamless integration between line of business solutions or custom-built software and your existing Grooper repositories and processes. A set of REST API methods allows users to push documents through Grooper Batch Processes and retrieve the results.

For example, using the Grooper REST API you can:

• Get information about a single Batch or all Batches
• Create a new Batch
• Delete a Batch
• Start or resume a Batch Process
• Get metadata for a specified Batch Folder.
• And more!

The first step in using the Grooper REST API is setting up an API endpoint for your 3rd party application to interact with a Grooper Repository. To do this, you will need to install a Grooper service in Grooper Config called API Services.

How To

Install the Grooper API Services

Enable a Grooper API Test Endpoint

When using the Grooper REST API, you may find it helpful to test out certain API calls before you implement them. By turning the Enable Test Endpoint property on, you can expose a Grooper REST API testing interface which you can access by entering the API URL in a browser.

From here, you can view and test the various REST API methods available to process documents in Grooper.

Test Endpoints

Delete Batch

DELETE /api/v1/BatchProcessing/Batches/{BatchID}

Enter the GUID of a Batch and execute. The Batch will be deleted in Grooper.

File:2023 APIServices 02HowTo TestEndpoints 01.png