Evolis SDK FAQ
Evolis SDK FAQ
1
Table of contents
API MODE : EVOLIS SERVICES PROVIDER FAQ .................................................................. 3
What is the API Mode ? ..................................................................................................................... 3
What is the Evolis Services Provider Framework (ESPF) ? ...................................... 3
How to relaunch the ESPF Server ? .......................................................................................... 3
API MODE Prerequisites .................................................................................................................. 4
What are the system requirements for using the API MODE : Evolis
Services Provider? ................................................................................................................................ 4
Can the Evolis legacy printers benefit from the API MODE : Evolis
Services Provider (Quantum2, Tattoo RW2)? .................................................................. 4
Can I design an application for Mac OS, Linux, Android, or iOS using the
API MODE : Evolis Services Provider ?.................................................................................... 4
DIRECT COMMUNICATION MODE FAQ .................................................................................... 5
Is Zenius, Primacy, Elypso compliant with direct communication mode
development method? ..................................................................................................................... 5
Requirements .......................................................................................................................................... 5
Scope .............................................................................................................................................................. 5
Disable printer’s supervision.......................................................................................................... 5
Most current use-cases developing in direct communication mode with
Iomem.dll library ....................................................................................................................................6
Matrix differences for Evolis Premium Suite release inferior to 7 versus
above 7 (Primacy2) ...............................................................................................................................7
API MODE (Evolis Services Provider) : demo tool :........................................................9
Recommended resolutions for optimal designs ..........................................................10
Disclaimer .....................................................................................................................................................10
2
API MODE : EVOLIS
SERVICES PROVIDER FAQ
What is the API Mode ?
The Evolis API MODE leverages a client/server architecture where the server, part
of the Evolis Premium Suite (or Edikio Printer Suite, Badgy Premium Suite, or Evolis
Premium Suite 2) , interprets requests and distributes them to interconnected
services (IPC) provisioned by the Evolis Suite. Users of the API mode must deploy:
• A client agent (see here for documentation, samples, and available source code)
• A flow of requests, according to their needs (see here)
The ESPF is the server-side part offered by the Evolis Premium Suite (or the Edikio
Printer Suite, Badgy Premium Suite) which handles communications based on
textual JSON requests. This server is enabled using the Evolis Services Provider
service.
Note : for Evolis Primacy 2, Evolis Services Provider 2 must be used instead.
Use "Evolis Services Provider 2" for Evolis Premium Suite 2 instead of "Evolis
Services Provider"
3
API MODE Prerequisites
Evolis Suite = Evolis Premium Suite, Evolis Premium Suite 2, Badgy Premium Suite,
Edikio Printer Suite.
What are the system requirements for using the API MODE :
Evolis Services Provider?
The target printer must be supported by the Evolis Premium Suite, the Edikio
Printer Suite, or Badgy Premium Suite in Supervision and Standard.
Can the Evolis legacy printers benefit from the API MODE :
Evolis Services Provider (Quantum2, Tattoo RW2)?
No, Evolis legacy printers are not supported by any Evolis Suite, only direct
communication mode development methods are available (e.g., iomem.dll,
spooler, …).
4
DIRECT COMMUNICATION
MODE FAQ
Is Zenius, Primacy, Elypso compliant with direct communication
mode development method?
Requirements
Scope
This section states the mandatory prerequisites to develop application software
using direct communication method instead of API MODE.
In other words, to avoid any communication conflict that could lead to an issue
between application software and Evolis printer, it is mandatory to disable the
printer supervision.
5
Most current use-cases developing in direct communication
mode with Iomem.dll library
Developing for a printer that has an Evolis Suite driver (e.g., Evolis Premium
Suite, Edikio Printer Suite, Badgy Premium Suite) :
6
Matrix differences for Evolis Premium Suite release inferior to 7 versus above 7 (Primacy2)
Item Espf with Setup inferior to 7 Espf with setup superior to 7
Additional information Adiitional information
7
Pipe Default Pipe Server name : EspfServer00 (configurable setting) Default Pipe Server name : Espf2Server00 (Configurable setting)
configuration
TCP Default TCP port : 18000 (configurable) Default TCP port : 18200
New abstraction DRV, DRVP, REG, REG2, DEV are directly addressable via
layer DRIVER CONNECTOR
8
API MODE (Evolis Services Provider) : demo tool :
To test the requests set, possibly use the demo toolselect your communication mode
in the first section / tab, then copy/paste requests one by one sequentially (the
expected results(Answer) shows up in the lower pane of the demo application).
Test
communication
first (onetime is
enough) thanks to
the Echo section.
Copy/paste requests
and send them
sequentially (request 1,
2,3…). Pay attention
than proper base64
data must be added
for the graphics (see
here).
Disclaimer
While Evolis makes every effort to deliver high quality products, we do not guarantee that our products
are free from defects. Our SDK, samples and demo software, any content or documentation delivered in
this package (Evolis SDK) is provided "as is". The use of it is at your own risk.
Evolis makes no warranties as to performance, merchantability, fitness for a particular purpose, or any
other warranties whether expressed or implied.
No oral or written communication from or information provided by Evolis shall create a warranty.
Under no circumstances shall Evolis be liable for direct, indirect, special, incidental, or consequential
damages resulting from the use, misuse, or inability to use this Software Development Kit (named Evolis
SDK), even if Evolis has been advised of the possibility of such damages.