1

NICE Recording

Fusion API 1.0

Installation Manual

Version: 1.1
Date: 18 September 2015
 Copyright © 2015 by NICE Systems Ltd.

All rights reserved. No part of this publication may be reproduced or transmitted in any form or
by any means, electronic or mechanical, including photocopy, recording, or any information
storage and retrieval system, without prior written consent of NICE Systems Ltd.

Disclaimer

To the best of our knowledge, the information contained in this document is the most accurate
available at the time of publication. Whilst every care is taken to ensure that the information in
this document is correct, no liability can be accepted by NICE Systems Ltd. for loss, damage or
injury caused by any errors in, or omissions from, the information given.

Trademark Acknowledgements

Microsoft, Windows, Windows Server, and Internet Explorer are trademarks or registered
trademarks of Microsoft Corporation in the United States and/or other countries.

Fusion API Overview 2

 Contents
1 .............................................................................................................. 4
Introduction ............................................................................................ 4
Who should use this manual? .................................................................................. 4
Assumptions.............................................................................................................. 4
Fusion API functions................................................................................................. 4
Documentation and on-line help .............................................................................. 6
Design restrictions .................................................................................................... 6
Deployment ................................................................................................................ 6

2 .............................................................................................................. 7
Install the Fusion API Software ............................................................ 7
Enter the License string ............................................................................................ 9
Change the default https port if required................................................................. 9

3 ............................................................................................................ 10

Configure API User in Fusion ............................................................. 10

4 ............................................................................................................ 11
Demo tool (SOAP UI) ........................................................................... 11
Load the Fusion API project ................................................................................... 12
Define hostname or IP address to access the Fusion API ................................... 12
Define credentials to access the Fusion API ......................................................... 14

Fusion API Overview 3

 1
Introduction
The Fusion API offers a 3rd party integration platform giving application developers access to:
 Exporting Fusion Users and NTR Recording Profiles
 Creating, updating and deleting Fusion Users and NTR Recording profiles
The Fusion API gives access to generic Fusion User properties only. It does not allow you to
define Fusion access rights other than assigning a User Profile to a specific Fusion Role.

Who should use this manual?

This manual is for application developers, and others who want a quick overview of Fusion
API functions.

Assumptions
Developers must have basic knowledge of NICE Trading Recording 6.x and Fusion 2.x and
knowledge of how to develop using a REST API.

Fusion API functions

Fusion API calls all require basic HTTP authorization and return JSON dataset. Functions are:
 get Version
Read the Fusion API version
 get Roles
Request the Roles including details as configured in Fusion
 create Fusion Role
Create a new Role in Fusion. An audit entry is created in Fusion.
After creation, Fusion users can be assigned to this Role
 get Fusion Groups
Request the Groups including details as configured in Fusion

Fusion API Overview 4

  create Fusion Group
Create a new Group in Fusion. An audit entry is created in Fusion.
After creation, Fusion users can be assigned to this Group.
 get Fusion Custom User Attributes
Request the Fusion custom user attributes as defined in Fusion.
 get Fusion User Entities (used for Communication Surveillance)
Read the Fusion User Entities defined
 get OU Structure from Fusion
Read the OU structure from Fusion. For each OU, all levels and the corresponding
GUID are returned.
 get Linked Recorders
Requests the NTR Cluster names as defined in Fusion
 get NTR Retention Groups
Read all NTR (Retention) Groups as defined in the linked NTR Clusters
 get Retention Groups By Cluster Name
Read NTR (Retention) Groups as defined for a specific linked NTR Cluster
 get Users (retrieving user profiles for all Fusion users)
Read all Fusion users with properties and linked NTR Recording profile details
 get User By ID
Read a specific Fusion user with based on its Fusion ID (GUID).
 get Users By Cluster Name (query for specific Fusion User profiles)
Read Fusion users for a specific Cluster with properties and linked NTR Recording
profile details.
 Get User By Fusion Logon Name (query for specific Fusion User profiles)
Read a specific Fusion user with based on its Fusion Logon Name (User Handle).
 delete Fusion User
Delete a specific Fusion User. Audit entry is created in Fusion.
 create a new Fusion User
Create a new Fusion User. An audit entry is created in Fusion
 update Fusion User attributes
Update an existing Fusion User. An audit entry is created in Fusion
 create a new NTR Recording Profile
Create a new NTR Recording profile on a specific cluster.
An audit entry is created in Fusion
 delete NTR Recording profile
Delete a specific NTR Recording profile. An audit entry is created in Fusion. The NTR
Recording profiles stay linked to the same Fusion user and is greyed out in the Fusion
UI to indicate it is no longer an active NTR Recording profile.

Fusion API Overview 5

  update a linked NTR Recording profile for a Fusion user
Update an existing NTR Recording profiler. An audit entry is created in Fusion
 relink NTR Recording profile to another Fusion User
Link an existing NTR Recording profile to another Fusion user. An audit entry is
created in Fusion

Documentation and on-line help

The Fusion API Software Kit includes:
 Reference to SOAP UI and SOAP UI project file for Fusion API.
Download SOAP UI from http://www.SOAP UI.org/
 This Installation Manual
 Via SOAP UI the REST API reference information is exposed
https://<fusionserver>:8081/provisionapi/docs/$metadata (this requires authentication)
 The on-line help file is included as a separate XML file with the API kit

Design restrictions
Fusion API services are only available as an add-on for:
 NICE Trading Recording 6.5 (or higher) and NICE Fusion 2.2PL1 (or higher)
 For Multiple Domain Authentication a domain prefix required in the logon user name.
Domain prefix in Fusion API logon is supported from Fusion 2.3PL1 (or higher)
 To gain access to the Fusion API, a Fusion User account is required to authenticate.
This Fusion User needs the following rights:
o Fusion Standard Application Right: Application Access Granted
o Fusion Advanced Application Right: Use Administration, User Import Right
 Authentication has a 15 minutes Server Side timeout window
 REST API accessible default via HTTPS on port 8081, this port is configurable
 API functions to get user profiles will return empty Linked Recorder Profiles for
unreachable NTR clusters. Empty Linked Recorder Profile has NTR fields ‘null’ and
NTR channel 0.
 API function to get users by Cluster Name will return empty JSON when the NTR
cluster, for which users are retrieved, is unreachable.
 API function to get a single user profile is less optimized than getting all profiles.
Therefore when multiple user profiles need to be retrieved, advice is to retrieve all user
profiles and filter out the specific user profiles required, in the application. Time to
retrieve all profiles is about 4 times slower than retrieving a single user profile.

Deployment
The Fusion API is installed on the Fusion Servers.

Fusion API Overview 6

 2
Install the Fusion API Software
You install the Fusion API on the Fusion Server as follows:
1. Start the installer

2. Follow the instructions in the wizard and provide the HTTPS certificate to use.

Fusion API Overview 7

 3. When done the Fusion API is installed and ready for use.

Fusion API Overview 8

Enter the License string
A license string is provided to activate the Fusion API for this Fusion Server. If no license
is found, the APU returns only version information and the license status. The License is
based on a Soft lock key and License string as provided for all NTR-related licenses.
You enter the license string as follows:
1. Open the web.config file. Default location is
<install drive>\Program Files (x86)\FusionAPI\web.config.
2. Fill in the following details:

SoftLockCode=
LicenseString=
LicenseChecksum=

Make sure you include quotes with the License string "AABBCCDD EEFF etc…. "
License Checksum is 2 characters.

3. Save the web.config file.

After saving the license information in the web.config file, it is automatically activated,
no IIS restart is required.

Change the default https port if required

If the default port 8081 for the API causes routing issues, change the default ports in IIS by
updating the Site bindings for the Fusion.Api.Provisioning site on the Fusion Server.

You can change Port (8081) to another value if required.

Fusion API Overview 9

 3

Configure API User in Fusion

To access the REST API, a Fusion user must exist with the correct credentials. The user can
have system or domain authentication.
Set the following rights for the Fusion API user:

Application Access must be granted (could be inherited from Role).

Advanced Application access right User import must be granted (could be inherited from
Role).

Fusion API Overview 10

 4

Demo tool (SOAP UI)

After you install the Fusion API, you can use SOAP UI to run API functions and see the
results. Get SOAP UI from http://www.SOAP UI.org/

Be aware that the result set of a Fusion API call may be JSON format. See the Get Roles
example above. To view the result, select the JSON tab. When selecting XML result set, you
see a message 'The content you are trying to view cannot be viewed as XML '

Fusion API Overview 11

Load the Fusion API project
A SOAP UI project file is available with the Fusion API kit. Load this project file in SOAP UI
application (File > Import project).

Define hostname or IP address to access the Fusion API

After loading the SOAP UI project, you see a list of functions.
Double click the line starting with https. This shows the Service endpoints (tab).
Define the correct IP address or hostname:

Fusion API Overview 12

 To call a function (functions have in SOAP UI) double click the function and define the
Endpoint from the list. Endpoints can also be added or changed here:

Fusion API Overview 13

Define credentials to access the Fusion API
Each API call requires basic HTTP authentication. You set this as follows:

1. In SOAP UI click the Auth tab .

2. Set Authorization to Basic and provide a username and password.
3. See Configure API User in Fusion for details of how to create an API user profile.
4. Set authentication to pre-emptively.

You must do this once for each API call defined in SOAP UI.
When not Authorized, the JSON result of an API call is:
{“Message”: “Authorization has been denied for this request.”}

You can specify a specific Domain to authenticate the user.

You do this as domain prefix in the Username field, by entering a domain pre-fix like
‘Domain\Username’. For a Domain prefix to be supported, you require Fusion 2.3PL1 or
higher.

Fusion API Overview 14

Version history

Date Version Remark

22-05-2015 1.0. Draft

11-06-2015 1.0. Added detail Fusion user right required for API
Added initial license information
Added method to change the default port used for the API

01-07-2015 1.0. Added detail what documentation is provided

Added license information
Added complete list of API functions
Added details on SOAP UI Endpoint definition and Authorization
Checked language.

18-09-2015 1.1. Added API Function for ‘User Handle’ based User Query
Added Multiple Domain support as from Fusion 2.3PL1.
Checked language.
Added details on user get functions at unreachable NTR clusters.
Added design advice on single user or all user profile retrieval.

Fusion API Overview 15