[DEVEVANG-148] Configure Amazon API Gateway to Invoke Genesys Cloud APIs

[ralphjohnquiaoit]

No description provided.

[carnellj-genesys]

Hi RJ,

I had ChatGPT look for your file for some general grammar and make suggestions.

Grammar and Style Corrections:

Introduction:

Original: "Hoping that everybody had a good first month of 2025."
Correction: "I hope everyone had a good first month of 2025."
Why use an API Gateway?

Original: "An API Gateway (not just the Amazon API Gateway) is a software component that acts as a single entry point for all API requests, sitting between clients and backend services, receiving requests, routing them to the appropriate service, and then aggregating the responses to send back to the client."
Correction: "An API Gateway is a software component that acts as a single entry point for all API requests. It sits between clients and backend services, receiving requests, routing them to the appropriate service, and aggregating the responses to send back to the client."
Benefits of Using an API Gateway:

Original: "You can abstract the complexity of interacting with various backend systems, making it easier for other developers to build and maintain integrations."
Correction: "It abstracts the complexity of interacting with various backend systems, making it easier for developers to build and maintain integrations."
Requirements:

Original: "A minimum of basic knowledge to both Amazon API Gateway and Genesys Cloud API."
Correction: "A basic understanding of both Amazon API Gateway and Genesys Cloud API."
Configuring the Amazon API Gateway:

Original: "To start, there are lots of ways for you to setup and configure the Amazon API Gateway."
Correction: "To start, there are several ways to set up and configure the Amazon API Gateway."
HTTP API Configuration:

Original: "HTTP API is the easiest configuration that you can do because it forwards the entire request directly to Genesys Cloud API."
Correction: "The HTTP API configuration is straightforward as it forwards the entire request directly to the Genesys Cloud API."
REST API: Proxy Integration:

Original: "REST API has more features compared to HTTP API like the use of API Keys, ability to use certificates for backend authentication, caching, etc., which makes it a bit more costly than HTTP API."
Correction: "The REST API offers more features compared to the HTTP API, such as the use of API keys, the ability to use certificates for backend authentication, and caching. However, it is slightly more costly than the HTTP API."
REST API: Non-Proxy Integration:

Original: "Non-Proxy integration is a much more complicated configuration if you need greater control over the information being passed down from the client to the services and vice versa."
Correction: "Non-Proxy integration is more complex and is suitable when you need greater control over the information being passed between the client and services."
Invoking APIs through the Amazon API Gateway using Genesys Cloud CLI/CX as Code/SDKs via Gateway Configuration:

Original: "Once you properly setup your API Gateway, it is easy for you to configure Genesys Cloud CLI, CX as Code, and Platform SDKs to go through the API Gateway for Genesys APIs."
Correction: "Once you have properly set up your API Gateway, it is easy to configure Genesys Cloud CLI, CX as Code, and Platform SDKs to route through the API Gateway for Genesys APIs."
Technical Corrections:

HTTP API Configuration:

Original: "For this demonstration, I used the domain api.mypurecloud.com."
Correction: "For this demonstration, I used the domain api.usw2.pure.cloud."
Note: Ensure that the domain matches the region of your Genesys Cloud organization. For example, api.usw2.pure.cloud is used for the US West (Oregon) region.
REST API: Proxy Integration:

Original: "In this demonstration, we put https://api.mypurecloud.com/{proxy}."
Correction: "In this demonstration, we used https://api.usw2.pure.cloud/{proxy}."
Note: Again, ensure the domain corresponds to your Genesys Cloud region.
Suggestions for Improvement:

Clarify API Gateway Types:

Security Considerations:

Emphasize the importance of securing the API Gateway, such as implementing authorization mechanisms and validating incoming requests to prevent unauthorized access.
Error Handling:

Include a section on error handling, detailing how to manage errors returned from the Genesys Cloud API when routed through the API Gateway.

You might want to link to in the developer center how to turn on logging in the SDK to observe behavior. Link to the doc as I like having something in here to debug

Testing:

Suggest tools and methods for testing the API Gateway configuration, such as using Postman or curl commands, and provide examples.

You could probably have Amazon Q look at your code and endpoints and generate a CURL command to use in the blog post