Jump to: navigation, search
(Created page with "= About Web Services and Applications = Web Services and Applications is a set of web APIs and user interfaces that provide a web-based client interface to access Genesys ser...")
 
m (Text replacement - "Genesys Engage Cloud" to "Genesys Engage cloud")
 
(23 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
= About Web Services and Applications =
 
= About Web Services and Applications =
 +
Web Services and Applications is a set of user interfaces and APIs that provide a web-based client interface to access Genesys services. The Web Services and Applications package for On-Premises contains a variety of microservices that you can implement in your contact center.
  
−
Web Services and Applications is a set of web APIs and user interfaces that provide a web-based client interface to access Genesys services. The following UIs are currently offered:
+
==User interfaces==
−
*Workspace Web Edition
+
Web Services and Applications includes the following UIs:
−
*Gplus Adapter for Salesforce
+
*[[#WWE|Workspace Web Edition]]
 +
*[[#GSF|Gplus Adapter for Salesforce]]
 +
*[[#Auth|Authentication]]
  
−
To work with the APIs and these applications, you must first follow the steps in this Deployment Guide to install and configure the Web Services API server component of the product. After that, you can work directly with the APIs or provide specific configuration for the applications you plan to use.  
+
{{AnchorDiv|WWE}}
 +
===Workspace Web Edition===
 +
Workspace Web Edition is an HTML 5 thin-client application that provides agents and knowledge workers with non-intrusive access to the information, processes, and applications that they need to perform their jobs more efficiently and to ensure increased customer satisfaction.
 +
 +
*Related documentation: [[Documentation:HTCC:IWWDep:Welcome|Web Services and Applications Configuration Guide]]
 +
 
 +
{{AnchorDiv|GSF}}
 +
===Gplus Adapter for Salesforce===
 +
Gplus Adapter for Salesforce is an integrated solution that enables users to handle contact center interactions seamlessly within Salesforce.
 +
 
 +
*Related documentation: [[DeployGplusSalesforce|Gplus Adapter for Salesforce section in this guide]], [[Documentation:HTCC:IWWDep:Welcome|Web Services and Applications Configuration Guide]], and [[Documentation:PSAAS:Agent:GPASFL:Public|Gplus Adapter User Guide/Help]]
  
−
===Web Services API===
+
{{AnchorDiv|Auth}}
−
Web Services are the web APIs that can be used by developers to create custom agent applications that integrate with Genesys. These applications can include features such as state management, call control, supervisor monitoring, and call recording.
+
===Authentication===
 +
Genesys makes logging in across the Genesys Engage applications easy. Once you have logged in to one of the applications, you will be automatically logged in to all your other applications without entering your credentials.
  
−
Web Services includes the following APIs:
+
If you close all the browser tabs without logging out of the applications, you will remain logged in for five minutes. If a second window or browser is opened after five minutes, to either the same application or any other Genesys Engage application, you will once again be prompted for your credentials.
−
* Authentication API
+
 
−
* Provisioning API
+
Authenticating is a two-step process in most applications. After launching the application in a browser, the Authentication (login) panel is displayed.
 +
 
 +
First, enter your username. If your contact center does not use email address formatted usernames, click '''Tenant''' to reveal the '''Tenant''' field. You will be informed by your administrator what to enter in the '''Tenant''' field. Leave this field blank unless instructed otherwise by your administrator. Click '''Next'''.
 +
 
 +
Second, enter your password. Click '''Sign in''' to authenticate.
 +
 
 +
Some applications have additional steps. For example, in Workspace Web Edition Agent Desktop, you might have an additional step to enter your Place.
 +
 
 +
[[File:GAPI_900_General_Authentication.png|500px]]
 +
 
 +
==APIs==
 +
Web Services and Applications includes both web APIs and JavaScript APIs.
 +
===Web APIs===
 +
Use the Web Services APIs to create your own custom applications that integrate with Genesys. For documentation, see the {{#Widget:ExtLink|link=https://developer.genesyscloud.com|displaytext=Genesys Engage cloud Developer Center}}.
 +
 
 +
This 9.0 release includes the following web APIs:
 
* Workspace API
 
* Workspace API
 
* Statistics API
 
* Statistics API
  
−
You can find all reference documentation for the Web Services API on the {{#Widget:ExtLink|link=https://developer.genesyscloud.com|displaytext=PureEngage Cloud Developer Center}} for 9.0. This developer site provides reference documentation, articles and tutorials for the cloud version of the Web Services API, called the PureEngage Cloud APIs. While the focus of this site is the cloud APIs, the reference information it contains is also applicable to the Web Services APIs.
+
===JavaScript APIs===
−
 
+
Use the Workspace JavaScript APIs to extend the desktop functionality or build a custom desktop with web components. For documentation, see the [[Documentation:HTCC:Dev:Welcome|Workspace Web Edition Developer's Guide and API Reference]].
−
===Workspace Web Edition===
 
−
Workspace Web Edition is an HTML 5 thin-client application that provides agents and knowledge workers with non-intrusive access to the information, processes, and applications that they need to perform their jobs more efficiently and to ensure increased customer satisfaction.  
 
−
 
−
{{Editgrn_open}}*Related documentation: [[Documentation:HTCC:IWWDep:Welcome|Web Services and Applications Configuration Guide]], [[Documentation:GC:Agent:Welcome|Workspace Web Edition Help]], and [[Documentation:HTCC:Dev:Welcome|Workspace Web Edition Developer's Guide and API Reference]].{{Editgrn_close}}
 
−
 
 
−
===Gplus Adapter for Salesforce===
 
−
Gplus Adapter for Salesforce is an integrated solution that enables Salesforce users to handle contact center interactions seamlessly within Salesforce.
 
  
−
{{Editgrn_open}}*Related documentation: [[DeployGplusSalesforce|Gplus Adapter for Salesforce section in this guide]], [[Documentation:HTCC:IWWDep:Welcome|Web Services and Applications Configuration Guide]], and [[Documentation:HTCC:GPA:Welcome|Gplus Adapters User Guide]]{{Editgrn_close}}
+
This 9.0 release includes the following JavaScript APIs:
 +
* Service Client API
 +
* Workspace Toolkit
  
 
[[Category:V:HTCC:9.0.0DRAFT]]
 
[[Category:V:HTCC:9.0.0DRAFT]]

Latest revision as of 13:48, September 18, 2020

About Web Services and Applications

Web Services and Applications is a set of user interfaces and APIs that provide a web-based client interface to access Genesys services. The Web Services and Applications package for On-Premises contains a variety of microservices that you can implement in your contact center.

User interfaces

Web Services and Applications includes the following UIs:

Workspace Web Edition

Workspace Web Edition is an HTML 5 thin-client application that provides agents and knowledge workers with non-intrusive access to the information, processes, and applications that they need to perform their jobs more efficiently and to ensure increased customer satisfaction.

Gplus Adapter for Salesforce

Gplus Adapter for Salesforce is an integrated solution that enables users to handle contact center interactions seamlessly within Salesforce.

Authentication

Genesys makes logging in across the Genesys Engage applications easy. Once you have logged in to one of the applications, you will be automatically logged in to all your other applications without entering your credentials.

If you close all the browser tabs without logging out of the applications, you will remain logged in for five minutes. If a second window or browser is opened after five minutes, to either the same application or any other Genesys Engage application, you will once again be prompted for your credentials.

Authenticating is a two-step process in most applications. After launching the application in a browser, the Authentication (login) panel is displayed.

First, enter your username. If your contact center does not use email address formatted usernames, click Tenant to reveal the Tenant field. You will be informed by your administrator what to enter in the Tenant field. Leave this field blank unless instructed otherwise by your administrator. Click Next.

Second, enter your password. Click Sign in to authenticate.

Some applications have additional steps. For example, in Workspace Web Edition Agent Desktop, you might have an additional step to enter your Place.

GAPI 900 General Authentication.png

APIs

Web Services and Applications includes both web APIs and JavaScript APIs.

Web APIs

Use the Web Services APIs to create your own custom applications that integrate with Genesys. For documentation, see the Genesys Engage cloud Developer Center.

This 9.0 release includes the following web APIs:

  • Workspace API
  • Statistics API

JavaScript APIs

Use the Workspace JavaScript APIs to extend the desktop functionality or build a custom desktop with web components. For documentation, see the Workspace Web Edition Developer's Guide and API Reference.

This 9.0 release includes the following JavaScript APIs:

  • Service Client API
  • Workspace Toolkit
This page was last edited on September 18, 2020, at 13:48.
Comments or questions about this documentation? Contact us for support!