All pages
Powered by GitBook
1 of 1

Loading...

Reader Management System API

The Reader Management System (RMS) API is a REST interface for remotely managing deployed MagTek readers — staging configuration, tag, key, and firmware updates and retrieving device status so fleets can be maintained without handling each device by hand. This reference groups the RMS-V2 endpoints by device family — MagneSafe V5, DynaFlex, DynaPro Go, oDynamo, and iDynamo 5 Gen III — and links each operation to its live request in the RMS-V2 Postman collection. API credentials are issued by MagTek/Magensa support; start with the Introduction and V5 Authorization sections below.

RMS-V2 API

V5

API Section

Description

Updates the MQTT configuration (broker and topic settings) provisioned to a DynaFlex-family device.

Updates a DynaFlex-family device's status record in RMS.

Returns the list of configuration profiles available for DynaFlex-family devices.

Queues a key-load configuration for a DynaFlex device, injecting or updating its cryptographic keys.

Queues the SCDE configuration for a DynaFlex II Go device.

Queues the SCDE configuration for a DynaFlex II Go device, forcing reapplication even if already present.

Endpoints for listing, retrieving, and queuing tag (TLV) updates for DynaFlex-family devices, including file and command delivery.

Retrieves a specific version of a DynaFlex tag set.

Retrieves the latest DynaFlex tag set.

Retrieves a DynaFlex tag set flagged to reapply even if already current.

Queues a specific version of a tag set for a DynaFlex device.

Queues the latest tag set for a DynaFlex device.

Queues a DynaFlex tag-set update and forces reapplication even if already current.

Pushes one or more files to a DynaFlex device through the tag mechanism.

Sends one or more device commands to a DynaFlex device through the tag mechanism.

Endpoints for retrieving and queuing firmware updates across DynaFlex-family models.

Retrieves the firmware update for DynaFlex II Go devices.

Retrieves the firmware update for DynaFlex II PED devices.

Retrieves the firmware update for DynaProx devices.

Retrieves the firmware update for DynaFlex devices.

Queues a firmware update for DynaFlex II Go devices.

Queues a firmware update for DynaFlex II PED devices.

Queues a firmware update for DynaProx devices.

Queues a firmware update for DynaFlex devices.

Queues a DynaFlex firmware update whose response omits the payload, returning metadata only so the payload can be fetched separately.

Queues a CAPK update for a DynaPro Go device, forcing reapplication even if already present.

Queues a CAPK update for an oDynamo device, forcing reapplication even if already present.

Returns the list of configuration profiles available for iDynamo 5 Gen III devices.

Queues a configuration that enables the device's push-button.

Queues a configuration that enables the push-button for a single press.

Queues a configuration that enables the push-button for multiple presses.

Queues a configuration that disables the device's push-button.

Queues a configuration that switches the device into Qwantum mode.

Queues a configuration that returns the device to normal mode.

Queues a configuration that sets the device's USB interface to HID mode.

Queues a configuration that sets the device's USB interface to keyboard-emulation mode.

Queues a configuration that sets the device's interface to iAP, RS-232, or UART.

Queues a configuration that puts the device in one-time automatic mode.

Queues a configuration that sets the device's data variant (output data format).

Queues a configuration that sets the device's PIN variant.

Endpoints for retrieving and queuing firmware updates for iDynamo 5 Gen III devices.

Retrieves a forced iDynamo 5 Gen III firmware update delivered as processed commands (RawCommands = false).

Queues a forced iDynamo 5 Gen III firmware update delivered as processed commands (RawCommands = false)

Retrieves a forced iDynamo 5 Gen III firmware update delivered as raw commands (RawCommands = true).

Queues a forced iDynamo 5 Gen III firmware update delivered as raw commands (RawCommands = true).

Introduction

Overview of the RMS-V2 API — base URL, request/response conventions, and how remote configuration, tag, and firmware updates reach fielded readers.

V5 Authorization

How to authenticate to RMS-V2 and obtain the access token required by the V5 endpoints.

Configurations

Endpoints for listing, retrieving, and queuing configuration-profile updates for MagneSafe V5 readers.

Get Configs/List (V5)

.Returns the list of configuration profiles available for V5 devices.

Get Configs (V5)

Retrieves a specific V5 configuration profile.

Get Configs (V5 Force update)

Retrieves a V5 configuration profile flagged to reapply even if the device already has it.

Post Configs (V5)

Queues a configuration-profile update for a V5 device

Post Configs (V5 Force update)

Queues a V5 configuration update and forces reapplication even if already current.

Tags

Endpoints for listing, retrieving, and queuing tag (TLV data element) updates for V5 readers.

Get Tags/List

Returns the list of tag sets available for V5 devices.

Get Tags (V5 with version)

Retrieves a specific version of a V5 tag set.

Get Tags (V5 without version)

Retrieves the latest V5 tag set.

Get Tags (V5 Force update)

Retrieves a V5 tag set flagged to reapply even if already current.

Post Tags (V5 with version)

Queues a specific version of a tag set for a V5 device.

Post Tags (V5 without version)

Queues the latest tag set for a V5 device.

Post Tags (V5 Force update)

Queues a V5 tag-set update and forces reapplication even if already current.

Firmwares

Endpoints for listing, retrieving, and queuing firmware updates for V5 readers.

Get Firmware (V5 with version)

Retrieves a specific firmware version for V5 devices.

Get Firmware (V5 without version)

Retrieves the latest firmware for V5 devices.

Get Firmware (V5 Force update)

Retrieves a V5 firmware update flagged to reinstall even if already current.

Post Firmware (V5 with version)

Queues a specific firmware version for a V5 device.

Post Firmware (V5 without version)

Queues the latest firmware for a V5 device.

Post Firmware (V5 Force update)

Queues a V5 firmware update and forces reinstallation even if already current.

Post Firmware (V5 DownloadPayload = false)

Queues a V5 firmware update whose response omits the firmware payload, returning metadata only so the payload can be fetched separately.

API Section

Description

Configurations

Endpoints for listing and queuing configuration updates for DynaFlex-family devices, plus QwantiFi cloud-management calls.

QwantiFiCloudManagement

Endpoints for managing a DynaFlex-family device's QwantiFi (MQTT) cloud connectivity and status.

API Section

Description

DynaProGo

RMS-V2 endpoints for remotely managing DynaPro Go PIN devices.

Tags

Endpoints for queuing tag (TLV) updates for DynaPro Go devices.

Post Tags (DynaProGo CAPK)

API Section

Description

oDynamo

RMS-V2 endpoints for remotely managing oDynamo OEM readers.

Tags

Endpoints for queuing tag (TLV) updates for oDynamo devices.

Post Tags (oDynamo CAPK)

API Section

Description

iDynamo5 Gen III

RMS-V2 endpoints for remotely managing iDynamo 5 Gen III readers.

Configurations

Endpoints for listing and queuing configuration updates that set interface, mode, and data options on iDynamo 5 Gen III devices.

DynaFlex

DynaPro Go

oDynamo

iDynamo 5 Gen III

​Need More Help

Need Help?

For additional support, please contact MagTek Support:

Technical Support:

  • 📧 Email: support@magtek.com

  • 📞 Phone: 1-562-546-6800 (US)

  • 🕐 Hours: Monday-Friday, 5:30 AM - 5:00 PM PST

Online Resources:

  • 🌐 Support Portal: developer.magtek.com

Documentation Feedback:

Help us improve this documentation!

Queues an EMV Certificate Authority Public Key (CAPK) update for a DynaPro Go device.

Queues an EMV Certificate Authority Public Key (CAPK) update for an oDynamo device.

feedback@magtek.com
Post Update Device MQTT Configurations
Post Update Device Status
Get Configs/List (DynaFlex)
Post Configs Key Load (DynaFlex)
Post Configs SCDE (DynaFlex II Go)
Post Configs SCDE (DynaFlex II Go Force update)
Tags
Get Tags (DynaFlex with version)
Get Tags (DynaFlex without version)
Get Tags (DynaFlex Force update)
Post Tags (DynaFlex with version)
Post Tags (DynaFlex without version)
Post Tags (DynaFlex Force update)
Post Tags (DynaFlex Send files)
Post Tags (DynaFlex Send commands)
Firmwares
Get Firmware (DYNAFLEX II GO)
Get Firmware (DYNAFLEX II PED)
Get Firmware (DYNAPROX)
Get Firmware (DYNAFLEX)
Post Firmware (DYNAFLEX II GO)
Post Firmware (DYNAFLEX II PED)
Post Firmware (DYNAPROX)
Post Firmware (DYNAFLEX)
Post Firmware (DynaFlex DownloadPayload = false)
Post Tags (DynaProGo CAPK Force update)
Post Tags (oDynamo CAPK Force update)
Get Configs/List
Post Configs (Enable push-button)
Post Configs (Enable push-button for one press)
Post Configs (Enable push-button for multiple presses)
Post Configs (Disable push-button)
Post Configs (Enable Qwantum Mode)
Post Configs (Enable Normal Mode)
Post Configs (Set USB HID)
Post Configs (Set USB Keyboard Emulation)
Post Configs (Set iAP / RS-232 / UART)
Post Configs (Set One-Time Automatic)
Post Configs DataVariant
Post Configs PINVariant
Firmwares
Get Firmware (Force update RawCommands=False)
Post Firmware (Force update RawCommands=False)
Get Firmware (Force update RawCommands=True)
Post Firmware (Force update RawCommands=True)