Introduction; About The Magneflex Powder V2 Api; Nomenclature; Sdk Contents - Magtek SDK MagneFlex Powder Programmer's Manual

1 - Introduction

1 Introduction
This document provides instructions for software developers to create software solutions that include
IPAD, DynaPro, DynaPro Mini, and DynaProx, DynaFlex, DynaFlex II PED, and DynaFlex II Go. This
document is part of a library of documents which includes the following from MagTek:
•
D99875585 DYNAPRO PROGRAMMER'S MANUAL ( COMMANDS )
•
D99875629 DYNAPRO MINI PROGRAMMER'S MANUAL ( COMMANDS )
•
D99875430 IPAD PROGRAMMER'S MANUAL ( COMMANDS )
•
D998200383 DYNAFLEX PRODUCTS PROGRAMMER'S MANUAL ( COMMANDS )
1.1

About the MagneFlex Powder V2 API

The MagneFlex Powder V2 API provides a convenient HTTP command application programming
interface to a device connected to a host. An HTTP client makes JSON calls to the host that are mapped
to the device's low-level command set, as found in the Programmer's Manual (Commands). The
MagneFlex Powder V2 can be launched as either a Windows Service, or a through a standalone
executable.
The SDK also includes a sample SOAPUI project and Java jQuery html file that demonstrates JSON calls
to the MagneFlex Powder V2. In addition, source code for the standalone executable is provided, if the
developer wishes to integrate the MagneFlex Powder V2 directly into their own code.
The MagneFlex Powder V2 API is single-threaded. If the service is busy processing a command to the
device, other calls will be rejected.
1.2

Nomenclature

In this document, the nomenclature below are used as follows:
•
Device refers to the device (e.g. DynaPro, DynaFlex II PED) that receives and responds to
commands.
•
Host refers to the piece of general-purpose electronic computing equipment the device is connected
or paired to. Host sends data to and receive data from the device via the MagneFlex Powder V2 API.
•
V1 at the end of a resource name identifies an extension of the API to be used but not limited for a
DynaFlex device.
For example:
RequestSmartCard is for DynaPro devices.
RequestSmartCardV1 is an extension for DynaFlex devices.
•
User in this document generally refers to the cardholder.
1.3

SDK Contents

Executables:
File
MTUSDK.WEBAPI.Host.exe
MTUSDK.WEBAPI.Host.exe.config
MTUSDK.WEBAPI.HostService.exe
MTUSDK.WEBAPI.HostService.exe.config
SDK - MagneFlex Powder, Middleware| PIN PEDs | Programmer's Manual ( MagneFlex Powder V2 API )
Page 7
Description
MagTek WEBAPI executable
MagTek WEBAPI executable configuration file
MagTek WEBAPI Windows service
MagTek WEBAPI Windows service configuration files