Genesys Cloud - Main

 View Only

Discussion Thread View
Expand all | Collapse all

Is it possible to call the WEBAPI from GenesysCloud Architect?

  • 1.  Is it possible to call the WEBAPI from GenesysCloud Architect?

    Posted 10-15-2024 03:11
    Hello everyone.
     
    I am currently investigating whether it is possible to call the WEBAPI from the GenesysCloud Architect.
     
    The client contacted me to ask if there is a way to link GenesysCloud and the WEBAPI, so I am currently investigating.
     
    I apologize for my lack of knowledge, but I personally think that it may be possible to call the WEBAPI in some way by using data actions in the Architect.
     
    If you have any information related to this, please let me know.
     
    Yours sincerely

    #API/Integrations
    #ArchitectureandDesign

    ------------------------------
    Matsumoto Shun
    ------------------------------


  • 2.  RE: Is it possible to call the WEBAPI from GenesysCloud Architect?

    Posted 10-15-2024 04:17

    Not sure what WEBAPI you are talking about, but any REST API is usually possible in Genesys be creating a Data Action with an Integration and then using that Data Action in Architect.  Here are some articles:

    About the Genesys Cloud data actions integration - Genesys Cloud Resource Center (mypurecloud.com)

    Call Data action - Genesys Cloud Resource Center (mypurecloud.com)



    ------------------------------
    Robert Wakefield-Carl
    ttec Digital
    Sr. Director - Innovation Architects
    Robert.WC@ttecdigital.com
    https://www.ttecDigital.com
    https://RobertWC.Blogspot.com
    ------------------------------



  • 3.  RE: Is it possible to call the WEBAPI from GenesysCloud Architect?

    Posted 10-15-2024 20:10

    Thank you for your reply. 

    I will continue to test it using the method you advised.



    ------------------------------
    Matsumoto Shun
    ------------------------------



  • 4.  RE: Is it possible to call the WEBAPI from GenesysCloud Architect?

    Posted 10-16-2024 01:51

    For example, if I want to call the Google Map API, is it correct to understand that I can call it from Architect using the following method that I was taught?

    "REST API is usually possible in Genesys be creating a Data Action with an Integration and then using that Data Action in Architect."



    ------------------------------
    Matsumoto Shun
    ------------------------------



  • 5.  RE: Is it possible to call the WEBAPI from GenesysCloud Architect?

    Posted 10-16-2024 04:17

    Yes, address lookups through Google MAP API is very possible using a data action in Architect.



    ------------------------------
    Robert Wakefield-Carl
    ttec Digital
    Sr. Director - Innovation Architects
    Robert.WC@ttecdigital.com
    https://www.ttecDigital.com
    https://RobertWC.Blogspot.com
    ------------------------------



  • 6.  RE: Is it possible to call the WEBAPI from GenesysCloud Architect?

    Posted 10-16-2024 20:25
    Thank you for your reply.
     
    I'm sorry for going into detail, but the actual setup method is to use the API provided by GenesysCloud to call any WEBAPI.
     
    If you know, please let me know which GenesysCloud API is appropriate.


    ------------------------------
    Matsumoto Shun
    ------------------------------



  • 7.  RE: Is it possible to call the WEBAPI from GenesysCloud Architect?

    Posted 10-17-2024 04:38

    Genesys has a REST-based API that other applications use to access functions of Genesys Cloud. 

    Then there are Data Actions which are used to run web services of other platforms like using a zip code in a call through the Google Maps API to retrieve the city and state.  



    ------------------------------
    Robert Wakefield-Carl
    ttec Digital
    Sr. Director - Innovation Architects
    Robert.WC@ttecdigital.com
    https://www.ttecDigital.com
    https://RobertWC.Blogspot.com
    ------------------------------



  • 8.  RE: Is it possible to call the WEBAPI from GenesysCloud Architect?

    Posted 10-20-2024 20:28
    Thank you for your reply.
     
    "Genesys has a REST-based API that other applications use to access functions of Genesys Cloud. "
    ↑I'm looking for the Genesys API in this article, but I haven't found anything relevant.
    If you know, please let me know which API it is.


    ------------------------------
    Matsumoto Shun
    ------------------------------



  • 9.  RE: Is it possible to call the WEBAPI from GenesysCloud Architect?

    Posted 10-20-2024 20:31

    https://developer.genesys.cloud/platform/integrations/integrations-endpoints



    ------------------------------
    Matsumoto Shun
    ------------------------------



  • 10.  RE: Is it possible to call the WEBAPI from GenesysCloud Architect?

    Posted 10-21-2024 10:05

    Hi Matsumoto, 

    You first need to setup an authentication method on the Google side to setup an integration object in Genesys Cloud.  This will allow your Genesys Cloud org to authenticate with your Google cloud org, for tracking an permissions:  https://cloud.google.com/docs/authentication 

    Once the authentication method is chosen and setup and the integration object is configured on the Genesys Cloud side.  You can begin creating data actions, using the new integration you setup for google.  You will develop these data actions to align with architect variable inputs and outputs. Once you have developed the data action and published them, you should be able to add the data action within Genesys Architect flows. 



    ------------------------------
    Carlos Albor
    Senior Principal PS Consultant
    ------------------------------



  • 11.  RE: Is it possible to call the WEBAPI from GenesysCloud Architect?

    Posted 10-21-2024 20:37
    Hi Jose,
    Thank you for letting me know about the authentication settings required to link Genesys with other applications.
     
    I understand that the above authentication is necessary to execute APIs and data actions that call other applications.
     
    With that in mind, I would like to ask again, I am looking for Genesys APIs and data actions that meet the following requirements.
     
    Does this mean that they are provided by Genesys and can be used without development?
     
    ・Genesys has a REST-based API that other applications use to access functions of Genesys Cloud.
     
    ・there are Data Actions which are used to run web services of other platforms
     
    I apologize if this is an irrelevant question.


    ------------------------------
    Matsumoto Shun
    Unknown
    ------------------------------



  • 12.  RE: Is it possible to call the WEBAPI from GenesysCloud Architect?

    Posted 10-22-2024 04:24

    Hi Matsumoto Shun,

    You use the "Data Actions" component of Genesys Cloud to execute API calls, whether that is calling the Genesys Cloud platform API (REST api), or a third-party service.

    You create a Data Action, then you can use this Data Action inside your Architect flows to execute the call.

    For third-party services, the third-party provides the API itself, you are just using the Data Action to connect to it.



    ------------------------------
    James Dunn
    Telecoms Specialist
    ------------------------------



  • 13.  RE: Is it possible to call the WEBAPI from GenesysCloud Architect?

    Posted 10-22-2024 20:04
    Hi James Dunn
     
    Thanks for your reply.
     
    First of all, I understand that I need to create a data action to execute an API call within the Architect flow.
     
    So, how to create a data action, I understand it as follows at the moment, but please tell me about ① and ②.
     
    ① Create a data action to execute an API call
    ② Execute the call using this data action within the Architect flow of Genesys Cloud
     
    ①: How should I design a data action to execute an API call? Is the integration "Genesys Cloud Data Actions" okay? I don't know how to set it in "Contracts" and "Configuration" of the setup.
     
    ②: Is the "Data Action" component of Genesys Cloud the "Call Data Action" in the toolbox?

    ・Reference article

    https://jp-help.mypurecloud.com/articles/about-custom-actions-for-integrations/



    ------------------------------
    Matsumoto Shun
    Unknown
    ------------------------------



  • 14.  RE: Is it possible to call the WEBAPI from GenesysCloud Architect?

    Posted 10-23-2024 02:11
    Edited by Christoph Domaschke 10-23-2024 02:23

    Hi Matsumoto Shun,

    1) You will have to install "Web Services Data Actions" from the app foundry. After that you have activate it under Admin --> integrations --> integrations. Then you can configure it similar to the Genesys Cloud Data Actions under Admin --> Integrations --> Actions. If you already know how REST-APIs work, than you will have no trouble with the configuration of Data Actions. A Contract is a Set of Variable Definitions. Input-Contract for Variables you want to give to the data action, Output-Contract for the returning values you want to receive from the API-Call. 


    The most tricky part is to create a request body under "configuration", but if you know your target-API good enough, it should be no problem. The response-translation-map is a tricky part, too. You will have to understand the structure of your target-API-response and some basics about translation maps.

    2) Yes, "Call Data Actions" is used to run API-Calls via Data Actions. The Action have to be published to be visble here.



    Best regards
    Christoph



    ------------------------------
    Christoph Domaschke
    Leiter Service Center (Cronbank)
    ------------------------------



  • 15.  RE: Is it possible to call the WEBAPI from GenesysCloud Architect?

    Posted 10-24-2024 03:00
    Hi Christoph Domaschke,
     
    Thank you for your reply.
     
    ① About creating and configuring data actions
    ② Which action should be selected in the Architect flow
     
    I have some understanding of these.
     
    As a verification material, I would like to investigate whether the following API can be called and executed in the Architect flow.
     
    ・WORDSAPI website
    https://www.wordsapi.com/
     
    ・Request URL
    https://wordsapiv1.p.mashape.com/words/{parameters}
     
    Currently, I am struggling with the contract and configuration of data actions.
     
    I would appreciate any advice on the specific settings method.
     
    ↓Current settings
     
    <Contracts>
    ●Input Contract
    word:Type is String
    result:Type is String
     
    ●Output Contract
    word:Type is String
    result:Type is String
     
    <Configuration>
    ●Request
    Request URL Template:https://wordsapiv1.p.mashape.com/words/
     
    ●Response
    {
    "translationMap": {},
    "translationMapDefaults": {},
    "successTemplate": "${rawResult}"
    }
     
    Best regards


    ------------------------------
    Matsumoto Shun
    Unknown
    ------------------------------



  • 16.  RE: Is it possible to call the WEBAPI from GenesysCloud Architect?
    Best Answer

    Posted 10-25-2024 03:29

    Hi Matsumoto Shun,

    without knowing the API you want to use (and I have no time to read the documentation) its just guessing for me, how parameters are given to the API and how the data structure of the answer is. The fact, that input and output variables are named identical makes it hard not to mess both up, too. But maybe this will help to find head into the right direction:

    Best
    Christoph



    ------------------------------
    Christoph Domaschke
    Leiter Service Center (Cronbank)
    ------------------------------



  • 17.  RE: Is it possible to call the WEBAPI from GenesysCloud Architect?

    Posted 10-28-2024 00:05

    Hi Christoph,

    Thank you for your reply.
     
    I will continue to investigate using the method you provided.
    Thank you, Christoph


    ------------------------------
    Matsumoto Shun
    Unknown
    ------------------------------



Need Help finding something?

Check out the Genesys Knowledge Network - your all-in-one access point for Genesys resources