JTL.Registrator 1.5.0-beta.414

JTL Registrator

An interactive CLI tool for managing app registrations for the JTL-Wawi REST API. Simplifies the registration, management, and regeneration of API keys for your applications.

Installation

Install as a global .NET tool:

dotnet tool install --global JTL.Registrator

Or as a local tool:

dotnet new tool-manifest
dotnet tool install --local JTL.Registrator

Quick Start

Simply run:

registrator

The tool will guide you through the registration process interactively.

What You Can Do

• Register new apps - Create new API registrations with custom scopes
• List all apps - View all your registered applications
• View app details - See complete API keys and configuration
• Regenerate API keys - Create new keys for existing apps
• Delete apps - Remove registrations from local storage

Registration Process

1. Start the tool and select "Register New App"

2. Enter server details:

   • Host (default: localhost)
   • Port (default: 5883)
   • HTTPS (Yes/No)
   • Mandant (default: eazybusiness)

3. Configure your app:

   • App ID
   • Display Name
   • Version
   • Description
   • Provider information

4. Select scopes:

   • Choose from existing scopes
   • Add custom scopes as needed
   • At least one scope required

5. Approve in JTL-Wawi:

   • Open JTL-Wawi (new interface)
   • Go to Admin → App Registration
   • Approve your app
   • Done! Your API key is saved automatically

Using Your API Key

After registration, the tool displays the HTTP headers you need for API requests:

Authorization: WAWI {your-api-key}
x-appid: {your-app-id}
x-appversion: {your-version}

View these headers anytime by selecting "Show App Details" from the main menu.

Custom Scopes

The tool includes one default scope:

• system.all - Full access to all system functions

You can add custom scopes during registration (e.g., file.handling, items.read, order.write). These are saved and available for future registrations.

Common scope examples:

• file.handling - File operations
• items.read / items.write - Item management
• order.read / order.write - Order management
• customer.read / customer.write - Customer management

Data Storage

Your registrations are stored securely on your computer at:

%LOCALAPPDATA%\JTL-Software\JTL-Registrator\

• API keys are encrypted using Windows DPAPI
• Only your Windows user account can access them
• Custom scopes are saved in custom-scopes.json

Requirements

• Windows operating system
• .NET 10.0 or higher
• JTL-Wawi with REST API enabled

Support

For questions and support:

• Website: https://www.jtl-software.com
• Company: JTL-Software-GmbH, Rheinstrasse 7, 41836 Hückelhoven, Germany

License

Copyright © 2026 JTL-Software-GmbH. All rights reserved.

This is proprietary software. Use is only permitted within the scope of the license agreement. See LICENSE.txt for complete terms.