Rossum Developer Hub

Rossum Data Capture for Developers and Integrators

Welcome to the Rossum developer hub. You'll find comprehensive guides and documentation to help you implement Rossum as quickly as possible, as well as support if you get stuck.

Let's jump right in!

Developer Guides    API Reference    User Help Center

Setting up rossumctl

To have an advanced access to the configuration of your account, you will want to use our command-line configuration tool rossumctl.

Installing rossumctl

Windows

On Windows, rossumctl is simply installed like any other standalone application. Download the latest rossumctl version and go through the installation wizard. You can then launch it either from the Start menu, or from the command prompt.

MacOSX

On Mac, rossumctl is installed as a Python script.

We will be working from a Mac terminal shell window. First, make sure you have Python3 installed. Next, install the tool itself by

pip install rossumctl

and run it simply by typing

rossumctl

in the terminal shell.

Linux

On Linux, rossumctl is installed as a Python script too, in a terminal shell window. Make sure you have at least Python 3.6 installed on your system. The tool itself is installed by either

pip install rossumctl

or

pip3 install rossumctl

depending on your Linux distribution. To run it, simply type

rossumctl

in the terminal shell.

Configuring rossumctl

The rossumctl tool is using standard Rossum APIs and needs to authenticate towards them. To get everything set up, type in the configure command on first run. Go with the default API endpoint if asked, but then type in the same username and password that you use to log into Rossum. The credentials will be saved on your computer for next invocations of the tool.

In the rest of our guide, we will mostly be showing just specific examples of the tool, but you will find extra tips & tricks about on the rossumctl GitHub page.

Updated 2 days ago

Setting up rossumctl


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.