Dashboard

The Dashboard is the control center for your HL Connector integration. Use it to manage API access, explore documentation, and monitor purchase activity — all from a single interface.

Access to the Dashboard is restricted to authenticated vendors.


Authentication

Dashboard access uses your Hall Leonard Vendor credentials.

  • Login — your vendor account identifier
  • Password — your vendor account password

These credentials are issued by Hall Leonard after vendor registration and are used exclusively for Dashboard access.

Once authenticated, you can manage API tokens, explore the API, and monitor orders.


Navigation overview

The Dashboard is organized into three main sections:

  • API — Interactive API documentation
  • Clients — API token management
  • Orders — Orders search and monitoring

Clients (API tokens)

The Clients section is where you manage API access tokens.

Each client represents a set of credentials used to authenticate API requests.

What you can do

  • Create new API clients
  • View existing clients and their configuration
  • Revoke clients that are no longer needed

API documentation

The API section provides a fully rendered OpenAPI Specification for HL Connector.

Key features

  • Always up-to-date with the current API version
  • Interactive request exploration
  • Automatic authentication injection

When you open the API documentation from the Clients section, the selected client’s access token is automatically injected into the documentation interface.

This allows you to:

  • Make authenticated API calls directly from the browser
  • Test endpoints without manual header setup
  • Verify token permissions and environment behavior in real time

This creates a seamless flow from token management to API exploration.


Orders

The Orders section provides visibility into purchase activity.

What you can do

  • Search orders by vendor order ID
  • View detailed order information
  • Monitor order status

This is especially useful for operational monitoring, support workflows, and validating integration behavior during testing or live operation.