Zebra Workforce Connect: Interworking Gateway Workforce Connect Interworking Gateway Manager REST API Developer Guide for IWG V2 (en)

Workforce Connect

IWG Manager REST API

Developer Guide

for IWG V2

MN-004016-02EN

ZEBRA and the stylized Zebra head are trademarks of Zebra Technologies Corporation, registered in
many jurisdictions worldwide. All other trademarks are the property of their respective owners.
© 2020 Zebra Technologies Corporation and/or its affiliates. All rights reserved.

Information in this document is subject to change without notice. The software described in this document
is furnished under a license agreement or nondisclosure agreement. The software may be used or copied
only in accordance with the terms of those agreements.

For further information regarding legal and proprietary statements, please go to:

SOFTWARE:http://www.zebra.com/linkoslegal
COPYRIGHTS:http://www.zebra.com/copyright
WARRANTY:http://www.zebra.com/warranty
END USER LICENSE AGREEMENT: http://www.zebra.com/eula

Terms of Use

Proprietary Statement

This manual contains proprietary information of Zebra Technologies Corporation and its subsidiaries
(“Zebra Technologies”). It is intended solely for the information and use of parties operating and
maintaining the equipment described herein. Such proprietary information may not be used, reproduced,
or disclosed to any other parties for any other purpose without the express, written permission of Zebra
Technologies.

Product Improvements

Continuous improvement of products is a policy of Zebra Technologies. All specifications and designs are
subject to change without notice.

Liability Disclaimer

Zebra Technologies takes steps to ensure that its published Engineering specifications and manuals are
correct; however, errors do occur. Zebra Technologies reserves the right to correct any such errors and
disclaims liability resulting therefrom.

Limitation of Liability

In no event shall Zebra Technologies or anyone else involved in the creation, production, or delivery of the
accompanying product (including hardware and software) be liable for any damages whatsoever
(including, without limitation, consequential damages including loss of business profits, business
interruption, or loss of business information) arising out of the use of, the results of use of, or inability to
use such product, even if Zebra Technologies has been advised of the possibility of such damages. Some
jurisdictions do not allow the exclusion or limitation of incidental or consequential damages, so the above
limitation or exclusion may not apply to you.

Publication Date

September 17, 2020

2

IWG Manager REST API

The IWG Manager REST APIs can be used to import configuration information, add endpoints, delete
endpoints, and reload endpoints. Use these APIs to develop custom GUIs or scripts to manage the
Interworking Gateway (IWG) V2.

A Swagger page is available for the IWG Manager REST API which contains the details of the API and can
be used to try out each procedure. Contact your IWG administrator for the URL of the Swagger page.

This document contains an overview of each controller (API subset). Refer to the Swagger page for more
details and examples of requests and responses. Refer to the Workforce Connect Interworking Gateway
Administrator Guide for more information about parameters used in the API.

Controllers

The IWG Manager REST API provides the following controllers.

• auth-controller - Requests an X-Auth-Token. The token provides the required authentication when
using the import or endpoints controllers.

• import-controller - Imports an XLS configuration file. The import controller requires an X-Auth-Token.
For information on creating the configuration file, refer to the Workforce Connect Interworking Gateway
V2 Administrator Guide.

• endpoints-controller - Lists, adds, deletes, or reloads endpoints. The endpoints controller requires an
X-Auth-Token.

• communication-controller - Gets a list of all endpoints in the IWG, send announcements, and send
messages. Requires an API Token. Refer to Messenger REST API Developer Guide and Announcer
REST API Developer Guide for more information.

Authentication Controller (auth-controller)

The import and endpoint controllers require an X-Auth-Token to guarantee security of the API. Use the
authentication controller to generate this token.

The authentication controller requires the username and password of a PTT Pro portal user who has
appropriate rights configured in the IWG. An X-Auth-Token is returned in the response header. Copy the
token and insert it into the X-Auth-Token field of the import or endpoint controllers.

Import Controller (import-controller)

Use the import controller to download a template and import a configuration file. These controllers require
a valid X-Auth-Token obtained using the authentication controller.

3

IWG Manager REST API

• Download Template file for import - Downloads an excel template that is used to import endpoint
information using Import endpoints.

• Import Excel file - Uploads an XLS file containing configuration information to the IWG and then loads
the information into the IWG. The spreadsheet contains the same information that may also be added
using the IWG Manager GUI. For information on creating the configuration file, refer to the Workforce
Connect Interworking Gateway V2 Administrator Guide. This procedure has two optional parameters.

•site - An optional list of sites to reset (see following parameter). If no sites are entered, and reset is

set to true, the reset applies to all sites.

• reset - Corresponds to the delete all existing records checkbox when importing an excel

spreadsheet using the IWG Manager GUI. If the reset parameter is set to true, then all endpoints in
the site list are deleted before processing the endpoint information from the excel spreadsheet. If the

reset parameter is set to true, and the site parameter is empty, all endpoints in all sites are deleted.

Endpoints Controller (endpoints-controller)

Use the endpoints controller to add, delete, reload, or get a list of endpoints. These controllers require a
valid X-Auth-Token obtained from the authentication controller.

• Get a list of all endpoints or Get endpoint by name (single endpoint) - Provides information about all
endpoints or a single endpoint, including create date, update date, associated site, and proxy
information. When using Get endpoint by name, either the endpoint name or endpoint ID can be used
to identify the endpoint.

NOTE: Get a list of all endpoints in the endpoints controller and the Get List of all endpoints in the
communication controller are two different procedures that return different information.

• Add an endpoint - Adds an endpoint to the IWG. Required parameters include an endpoint name, site
ID, proxy name, and the target PTT Pro group or user. The mapping and proServer parameters are not
supported at this time.

The proxy name must be made up of letters, numbers, and “.”s, and between 3-25 characters long.

• Delete multiple endpoints or Delete endpoint by name (single endpoint) - Deletes multiple endpoints
or a single endpoint. Either the endpoint name or endpoint ID can be used to identify the endpoint(s).

• Reload multiple endpoints or Reload endpoint by name (single endpoint) - Reloads multiple
endpoints or a single endpoint. Either the endpoint name or endpoint ID can be used to identify the
endpoint(s). This procedure has two optional boolean parameters.

•Pro_data - When set to true, the IWG reloads the endpoint data for the target from PTT Pro.

• Clear_key - When set to true, the IWG clears the public key for the target in PTT Pro. This may be

necessary if an endpoint is showing an authentication error.

If Pro_data and Clear_key are both set to false, only the IWG data is reset and no communication with
PTT Pro occurs.

Communications Controller (communications-controller)

Use the communications controller

• Request a list of all endpoints with their capabilities (i.e. voice vs data).

• Send an Announcement (audio message)

• Send a Message (text message with optional image)

4

IWG Manager REST API

These controllers do not use an X-Auth-token as generated by the authentication controller. They use an
API Token which is obtained from the IWG GUI. For detailed information on these controllers, refer to the
Messenger REST API Developer Guide and Announcer REST API Developer Guide.

5

www.zebra.com