Difference between revisions of "PEC-Developer/HIW"

From Genesys Documentation
Jump to: navigation, search
m (Text replacement - "Genesys Engage Cloud" to "Genesys Engage cloud")
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{TaskSummary
 
{{TaskSummary
−
|DisplayName=How APIs work in Genesys Engage cloud
+
|DisplayName=How APIs work in Genesys Multicloud CX
−
|TocName=
 
 
|Dimension=Journey
 
|Dimension=Journey
−
|Platform=GenesysEngage-onpremises
 
 
|ComingSoon=No
 
|ComingSoon=No
 
|Context=Learn about the APIs you can use to customize your applications and integrate with Genesys.
 
|Context=Learn about the APIs you can use to customize your applications and integrate with Genesys.
−
|overviewtext=APIs in Genesys Engage cloud fall under two categories: Web APIs that your web application accesses through Genesys Engage cloud and JavaScript APIs that you install in a location your web application can access.
+
|overviewtext=APIs in Genesys Multicloud CX fall under two categories: Web APIs that your web application accesses through Genesys Multicloud CX and JavaScript APIs that you install in a location your web application can access.
−
|TSSection=
+
|TSSection={{TSSection
−
==Web APIs==
 
−
Web APIs are documented on the [https://developer.genesyscloud.com/ Genesys Engage cloud Developer Center], where you can find reference information, tutorials and samples. Genesys recommends that you are familiar with [https://tools.ietf.org/html/rfc6749 OAuth 2] - Genesys Engage cloud web APIs implement this standard for secure authentication and support the Authorization Code Grant type. Check out the [https://developer.genesyscloud.com/reference/authentication/ Authentication API] for details.
 
−
 
−
See below for a complete list of web APIs and links to related documentation.
 
−
{{TSSection
 
 
|sectionheading=Authentication API
 
|sectionheading=Authentication API
−
|description=Provides OAuth2 authentication and authorization.
+
|description=Provides OAuth2 authentication and authorization with the Authorization Code Grant and Assertion Grant types.
−
|relatedarticles=*[https://developer.genesyscloud.com/reference/authentication/ API reference]
+
|relatedarticles=*{{Link-AnywhereElse|product=PEC-Developer|version=Current|manual=WebAPIs|topic=Authentication_API|display text=API Reference}}
 
*[https://developer.genesyscloud.com/client-libraries/authentication/ Client libraries]
 
*[https://developer.genesyscloud.com/client-libraries/authentication/ Client libraries]
−
*[https://github.com/GenesysGenesys Engage/authorization-code-grant-sample-app Sample application]
+
*[https://github.com/GenesysPureEngage/authorization-code-grant-sample-app Sample application]
 
}}{{TSSection
 
}}{{TSSection
 
|sectionheading=CX Contact Service API
 
|sectionheading=CX Contact Service API
Line 26: Line 19:
 
|description=Create a session, send and fetch messages, and manage participants.
 
|description=Create a session, send and fetch messages, and manage participants.
 
|relatedarticles=*[https://developer.genesyscloud.com/reference/messaging/ API reference]
 
|relatedarticles=*[https://developer.genesyscloud.com/reference/messaging/ API reference]
−
}}{{TSSection
 
−
|sectionheading=Data Download Service API
 
−
|description=Securely export your contact center data.
 
−
|relatedarticles=*[https://developer.genesyscloud.com/reference/cdds/ API reference]
 
 
}}{{TSSection
 
}}{{TSSection
 
|sectionheading=Engagement API
 
|sectionheading=Engagement API
Line 46: Line 35:
 
*[https://developer.genesyscloud.com/client-libraries/provisioning/ Client libraries]
 
*[https://developer.genesyscloud.com/client-libraries/provisioning/ Client libraries]
 
*[https://developer.genesyscloud.com/tutorials/ Tutorials]
 
*[https://developer.genesyscloud.com/tutorials/ Tutorials]
 +
}}{{TSSection
 +
|sectionheading=Service Client API
 +
|description=Extend the UI integration when Agent Workspace is configured to embed other web client business applications.
 +
|relatedarticles=*{{Link-AnywhereElse|product=PEC-Developer|version=Current|manual=SCAPI|topic=ServiceClientAPI|display text=Get started}}
 +
*{{Link-AnywhereElse|product=PEC-Developer|version=Current|manual=SCAPI|display text=API reference}}
 
}}{{TSSection
 
}}{{TSSection
 
|sectionheading=Statistics API
 
|sectionheading=Statistics API
 
|description=Subscribe to statistics and get notifications when they change.
 
|description=Subscribe to statistics and get notifications when they change.
−
|relatedarticles=*[https://developer.genesyscloud.com/reference/statistics/ API reference]
+
|relatedarticles=*{{Link-AnywhereElse|product=PEC-Developer|version=Current|manual=WebAPIs|topic=Statistics_API|display text=API reference}}
 
*[https://developer.genesyscloud.com/client-libraries/statistics/ Client libraries]
 
*[https://developer.genesyscloud.com/client-libraries/statistics/ Client libraries]
 
*[https://developer.genesyscloud.com/tutorials/ Tutorials]
 
*[https://developer.genesyscloud.com/tutorials/ Tutorials]
Line 55: Line 49:
 
|sectionheading=Task Routing API
 
|sectionheading=Task Routing API
 
|description=Submit workitems to Genesys from third-party applications.
 
|description=Submit workitems to Genesys from third-party applications.
−
|relatedarticles=*[https://developer.genesyscloud.com/reference/gtr/ API reference]
+
|relatedarticles=*{{Link-AnywhereElse|product=PEC-Developer|version=Current|manual=WebAPIs|topic=Task_Routing_API|display text=API Reference}}
 +
}}{{TSSection
 +
|sectionheading=User Data Management API
 +
|description=Securely export your contact center data.
 +
{{NoteFormat|This API used to be called the Cloud Data Download Service API. Any references to Cloud Data Download Service have been deprecated, and replaced by User Data Management.|2}}
 +
|relatedarticles=*{{Link-AnywhereElse|product=PEC-Developer|version=Current|manual=WebAPIs|topic=User_Data_Management_API|display text=API Reference}}
 +
}}{{TSSection
 +
|sectionheading=Widgets
 +
|description=A collection of JavaScript APIs that provide UIs (and their supporting services) you can use in your own web applications. For example, chat and co-browse.
 +
|relatedarticles=*{{Link-AnywhereElse|product=WID|version=Current|manual=Developer|topic=GWCDeployment|display text=Deployment}}
 +
*{{Link-AnywhereElse|product=WID|version=Current|manual=SDK|display text=API reference}}
 
}}{{TSSection
 
}}{{TSSection
 
|sectionheading=Workspace API
 
|sectionheading=Workspace API
Line 62: Line 66:
 
*[https://developer.genesyscloud.com/client-libraries/workspace/ Client libraries]
 
*[https://developer.genesyscloud.com/client-libraries/workspace/ Client libraries]
 
*[https://developer.genesyscloud.com/tutorials/ Tutorials]
 
*[https://developer.genesyscloud.com/tutorials/ Tutorials]
−
}}
 
−
==JavaScript APIs==
 
−
Documentation for our JavaScript libraries is on this site and includes reference information, as well as how to download and get started with the APIs. See the sections below for details.
 
−
{{TSSection
 
−
|sectionheading=Service Client API
 
−
|description=Extend the UI integration when Agent Desktop is configured to embed other web client business applications.
 
−
|relatedarticles=*{{Link-AnywhereElse|product=PEC-Developer|version=Current|manual=SCAPI|topic=ServiceClientAPI|display text=Get started}}
 
−
*{{Link-AnywhereElse|product=PEC-Developer|version=Current|manual=SCAPI|display text=API reference}}
 
−
}}{{TSSection
 
−
|sectionheading=Widgets
 
−
|description=A collection of JavaScript APIs that provide UIs (and their supporting services) you can use in your own web applications. For example, chat and co-browse.
 
−
|relatedarticles=*{{Link-AnywhereElse|product=WID|version=Current|manual=Developer|topic=GWCDeployment|display text=Deployment}}
 
−
*{{Link-AnywhereElse|product=WID|version=Current|manual=SDK|display text=API reference}}
 
 
}}
 
}}
 
}}
 
}}
−
 
 
{{#css: .dropdown {display:none;} }}
 
{{#css: .dropdown {display:none;} }}

Latest revision as of 02:31, November 27, 2023

Learn about the APIs you can use to customize your applications and integrate with Genesys.

APIs in Genesys Multicloud CX fall under two categories: Web APIs that your web application accesses through Genesys Multicloud CX and JavaScript APIs that you install in a location your web application can access.

Authentication API

Provides OAuth2 authentication and authorization with the Authorization Code Grant and Assertion Grant types.

CX Contact Service API

Create and manage outbound campaigns, import and work with contact lists, and enable compliance rules.

Consumer Messaging API

Create a session, send and fetch messages, and manage participants.

Engagement API

Manage callbacks, query availability, estimated wait times, and create call-in requests.

Intelligent Workload Distribution API

Create, update, delete or find workitems that come from third-party applications.

Provisioning API

Configure your Genesys environment, create users, and retrieve configuration data.

Service Client API

Extend the UI integration when Agent Workspace is configured to embed other web client business applications.

Statistics API

Subscribe to statistics and get notifications when they change.

Task Routing API

Submit workitems to Genesys from third-party applications.

User Data Management API

Securely export your contact center data.

Tip
This API used to be called the Cloud Data Download Service API. Any references to Cloud Data Download Service have been deprecated, and replaced by User Data Management.

Widgets

A collection of JavaScript APIs that provide UIs (and their supporting services) you can use in your own web applications. For example, chat and co-browse.

Workspace API

Manage agent state, access to voice and chat channels, and supervisor monitoring.


Retrieved from "https://all.docs.genesys.com/PEC-Developer/HIW (2025-07-15 01:17:06)"
Comments or questions about this documentation? Contact us for support!