PEC-WFM/Current/Developers/API Reference - Revision history

WikiSysop at 20:01, September 27, 2022

2022-09-27T20:01:12Z

WikiSysop at 13:15, September 27, 2022

2022-09-27T13:15:57Z

Gopinath.Manickam.IX: Published

2022-09-27T10:45:40Z

Published

WikiSysop at 19:30, May 12, 2022

2022-05-12T19:30:57Z

WikiSysop at 19:16, May 12, 2022

2022-05-12T19:16:05Z

WikiSysop: Created page with "{{Article |Standalone=No |DisplayName=Workforce Management API Reference |TocName=API Reference |Context=Learn how to use the Workforce Management (WFM) Integration API to cus..."

2022-05-12T18:16:04Z

Created page with "{{Article |Standalone=No |DisplayName=Workforce Management API Reference |TocName=API Reference |Context=Learn how to use the Workforce Management (WFM) Integration API to cus..."

New page

{{Article
|Standalone=No
|DisplayName=Workforce Management API Reference
|TocName=API Reference
|Context=Learn how to use the Workforce Management (WFM) Integration API to customize the way your web application integrates with Workforce Management.
|ComingSoon=No
|Platform=GenesysEngage-onpremises
|Role=Developer
|Application=Workforce Management
|Section={{Section
|alignment=Vertical
|structuredtext=The Workforce Management Integration API Reference documentation is available for download from this page.

{{NoteFormat|
* Currently, this feature is supported only for Multicloud CX deployments hosted on Azure.
* This feature requires special provisioning to be performed by Genesys. For information about using this feature in your deployment, contact your Genesys representative.
|}}
|Status=No
}}{{Section
|sectionHeading=Direct downloads
|anchor=downloads
|alignment=Vertical
|structuredtext=Find your release number in the table below and download the file to access the most recent Workforce Management Integration API Reference documentation.<br />

{{{!}} class="wikitable"
{{!}}+Workforce Management Integration API Reference Documentation
!'''Release'''
!'''Direct Download'''
!'''Last Updated'''
!'''File Size'''
{{!}}-
{{!}}WFM 8.5 Integration API Reference Documentation
{{!}}{{Repository|WFM_API_docs_85.zip|| WFM_API_docs_85.zip }}
{{!}}March 31, 2022
{{!}}27.5 MB
{{!}}}

===Viewing the documentation===
After downloading and extracting the zip file, go to the '''docs''' folder and open the '''index.html''' file in your browser.
|Status=No
}}{{Section
|sectionHeading=Using this API
|anchor=usingAPI
|alignment=Vertical
|structuredtext=To use this API, you must first do the following:

*Use GAuth REST API (oAuth2) to authenticate the user and obtain an access token.
*Once the access token is obtained, use the following to obtain WFM user information, including userId, user type, and other details:
*:<code>WFM REST API method GET /wfm/api/v3/system/userinfo</code>
*:{{NoteFormat|The <code>/userinfo</code> call can return a 403 (Forbidden) error code if an authenticated user is not provisioned in WFM. }}

The '''LocateServerLogin''' and '''OpenSessionLogin''' SOAP API methods are not supported for this API. Instead, you must use the corresponding '''LocateServer''' and '''OpenSession''' SOAP API methods. Otherwise, this SOAP API works similar to the API for WFM on-premises except that each request will have the access token attached as a '''Bearer''' token in the '''Authorization''' header.

This example shows an access token being attached to the request:

<source lang="bash">
private static < T > void setAccessToken(T port, String accessToken)
{
BindingProvider bp = (BindingProvider) port;
java.util.Map < String, Object > context = bp.getRequestContext();

Map < String, List < String >> requestHeaders = (Map < String, List < String >> ) context.get(MessageContext.HTTP_REQUEST_HEADERS);

if (requestHeaders == null) {
requestHeaders = new HashMap < String, List < String >> ();
context.put(MessageContext.HTTP_REQUEST_HEADERS, requestHeaders);
}

requestHeaders.put("Authorization", Collections.singletonList("Bearer " + accessToken));
context.put(MessageContext.HTTP_REQUEST_HEADERS, requestHeaders);
}

…
WFMLocatorService800Soap locator = getService800Soap(WFMLocatorService800Soap.class,
"/LocatorService/WFMLocatorService800.wsdl", "WFMLocatorService800", "WFMLocatorService800Soap", "https://<some URL>");

setAccessToken(locator, access_token); // Attach access token to the request

locator.LocateServer(…)
</source>
|Status=No
}}
}}

@@ Line 31: / Line 31: @@
 {{!}}WFM 8.5 Integration API Reference Documentation
 {{!}}{{Repository|WFM_API_docs_85.zip|| WFM_API_docs_85.zip }}
-{{!}}March 31, 2022
+{{!}}September 27, 2022
 {{!}}27.5 MB
 {{!}}}

@@ Line 13: / Line 13: @@
 {{NoteFormat|
-* This feature requires special provisioning to be performed by Genesys.  For information about using this feature in your deployment, contact your Genesys representative.
+This feature requires special provisioning to be performed by Genesys.  For information about using this feature in your deployment, contact your Genesys representative.
 |}}
 |Status=No

@@ Line 4: / Line 4: @@
 |TocName=API Reference
 |Context=Learn how to use the Workforce Management (WFM) Integration API to customize the way your web application integrates with Workforce Management.
-|ComingSoon=Yes
+|ComingSoon=No
 |Platform=GenesysEngage-onpremises
 |Role=Developer