Qodex.ai

AWS Website Management Integration

Number of APIs: 6

Introduction

A suite of AWS integrations for website management (includes collections for API Gateway, Cognito, and S3).

Prerequisites

This collection requires that you have both a Qodex API key ([learn more about the Qodex API here] and get your Qodex API key here) and AWS access keys (learn more about AWS access keys here).

Forking Collections

In order to use this integration, you will need to fork this collection. You can do this by left clicking on a collection and pressing create a fork. You will also need to fork the environment named AWS Website Management Integration ([learn more about forking collections and environments here]

Monitors

In the integration, a monitor is used to continually check to see if the API schema has been updated (so we can make sure that only the most recent update of the API schema has been uploaded to AWS)

In order to make this monitor, input the desired Monitor Name, select the AWS Website Management Integration collection as the Collection. Select the AWS Website Management environment as the environment and select how often you want it to be run to check if your schema has been updated (we recommend once a day). Then your monitor should be created ([learn more about creating a monitor here]

Mocks

If you would like to see example responses and run and interact with the collection without having to input valid credentials, you will need to create a mock server. You can do this by left clicking on your forked version of this integration and selecting Mock Collection ([learn more about creating a mock server here]

Then you will also nee to fork the [MOCK] AWS Website Management Integration environment. Copy the mock server url and assign it to the environment variable mockUrl. If you run the collection with the mock environment selected, it will show you what a successful request looks so long as you fill out the environment variables with the correct variable type.

  1. AWS API Gateway - Update Schema PUT {{baseUrl}}/restapis/{{awsAPIId}}?mode=overwrite

  2. AWS API Gateway - Post Schema to API Gateway POST {{baseUrl}}/restapis?mode=import

  3. AWS Cognito - Add App Client POST {{baseUrl}}

  4. AWS S3 - Post Blob PUT {{baseUrl}}/{{blobName}}

  5. AWS S3 - Enable Website Hosting PUT {{baseUrl}}

  6. AWS API Gateway - Get Schema GET {{baseUrl}}/apis/{{apiId}}/versions/{{apiVersionId}}/schemas/{{schemaId}}