DYMO Label Web Service

Working with DYMO Label Web Service

What is the DYMO Label Web Service?

In the past, developers had to provide a browser-specific plug-in for each major web browser. Nowadays,
most browsers have phased out native plug-in support. Google, for example, stopped supporting Chrome
their NPAPI browser extension in September 2015. In response, we released the DYMO Web Service as a
new cross-browser solution allowing third-party developer applications the ability to interface with the DLS
SDK in a seamless, browser-agnostic fashion. It handles all printer-related requests from the JavaScript
Library that the DYMO Label Framework browser plug-ins used to perform.

How do I install the DYMO Label Web Service?

First, download the appropriate installer for your OS. You can find them at the following URL:
http://www.dymo.com/en-US/online-support/dymo-user-guides

Windows

Double-click on the installer and follow the directions provided by the install wizard.

Mac

Double-click on the DMG file to mount it. Select the newly mounted volume and double-click on the PKG
file found within it. Then follow the directions provided by the install wizard.

How can I tell if DYMO Label Web Service is installed?

The DYMO Label Web Service should be installed as long as you have installed DYMO Label Software 8.5.3
or newer using the express “Express” mode. (add express mode screenshot?).

If you choose to install DYMO Label Software in “Custom” mode, be sure to select the DYMO Label Web
Service component as follows:

dymo-label-web-service-faq-for-winmac-1

Figure 1Custom select components to install.

If installed, there will be an executable file named DYMO.DLS.Printing.Host.exe within the DLS working
folder (normally found within the C:\Program Files (x86)\DYMO\DYMO Label Software folder on Windows
and the /Library/Frameworks/DYMO/SDK folder on Mac).

dymo-label-web-service-faq-for-winmac2

Figure 2 Executable location (Windows)

How can I tell if the DYMO Label Web Service is running?

You should see the DLS application icon within the system tray. Right-click this icon to display a context
menu. The menu displays the web service’s status (i.e., “Started on port 41951” or “Stopped”).
The following shows what it looks like on Windows.

dymo-label-web-service-faq-for-winmac3

Figure 3 DLS icon and context menu (Windows)

On Mac, the DLS application icon and context menu will appear within the system tray like this:

dymo-label-web-service-faq-for-winmac4

Figure 4 DLS icon and context menu (Mac)

I do not see it in the system tray. How can I start it?

Windows

You can start the web service again by navigating to the DLS working folder and running the executable
named DYMO.DLS.Printing.Host.exe.

Mac

Open a Finder window, navigate to the /Library/Frameworks/DYMO/SDK/ folder, and click on the
DYMO.DLS.Printing.Host.app icon.
Open a terminal prompt and enter the following command:

launchctl start com.dymo.dls.webservice

How can I start or stop the DYMO Label Web Service?

You can start or stop the web service at any time by clicking on the Start service and Stop service menu
items, respectively. Although the service icon will remain in the system tray after stopping it, no API
functions will be executed.

How can I configure the DYMO Label Web Service?

Clicking the Configure menu item will cause a configuration window to appear. This allows you to change
the language and listening port. The web service will normally try to use the first available port within the
41951-41960 range. You can override this behavior by checking the Use single port checkbox, which
makes the service only try using the specified port only. You cannot specify a port number that does not fall
within the specified range. The service will not try using any other port if an error occurs while using this
option.

dymo-label-web-service-faq-for-winmac5

Figure 5 Web Service configuration dialog (Windows)

dymo-label-web-service-faq-for-winmac6

Figure 6 Web Service configuration dialog (Mac)

How can I tell if the DYMO Label Web Service is functioning properly?

Click the Diagnose menu item within the context menu while the service is running. If the self-test
succeeds, a dialog box will appear asking you to open a test page in your browser to see if SSL certificate is
working.

dymo-label-web-service-faq-for-winmac7

Figure 7 Diagnose successful (Windows)

dymo-label-web-service-faq-for-winmac8

Figure 8 Diagnose successful (Mac)

Click the Yes button to open your default web browser. The browser should display a page indicating the
web service is running correctly. The page address should be something to the following effect:

https://localhost:41951/DYMO/DLS/Printing/Check

The port number may vary from machine to machine.

dymo-label-web-service-faq-for-winmac9

Figure 9 Web Service is up and running confirmation.